Retrieve a phone number

Return the details of a phone number associated with the given external connection.

GET /external_connections/{id}/phone_numbers/{phone_number_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const phoneNumber = await client.externalConnections.phoneNumbers.retrieve('1234567889', {
  id: '1293384261075731499',
});

console.log(phoneNumber.data);

200

{
  "data": {
    "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
    "telephone_number": "<string>",
    "number_id": "<string>",
    "civic_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "displayed_country_code": "<string>",
    "acquired_capabilities": [
      "FirstPartyAppAssignment"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Identifies the resource.

Example:

"1293384261075731499"

phone_number_id · string · required

A phone number's ID via the Telnyx API

Example:

"1234567889"

Response

200

application/json

Successful response

data · Phone number details with relation to an external connection · object

Show child attributes