Skip to main content
GET
/
messaging_profiles
/
{id}
/
phone_numbers
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.messagingProfiles.listPhoneNumbers('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);
{
  "data": [
    {
      "record_type": "messaging_settings",
      "id": "1293384261075731499",
      "phone_number": "+18005550001",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z",
      "country_code": "US",
      "type": "toll-free",
      "health": {
        "message_count": 122,
        "inbound_outbound_ratio": 0.43,
        "success_ratio": 0.94,
        "spam_ratio": 0.06
      },
      "eligible_messaging_products": [
        "A2P"
      ],
      "traffic_type": "A2P",
      "messaging_product": "A2P",
      "features": {
        "sms": {
          "domestic_two_way": true,
          "international_inbound": true,
          "international_outbound": true
        },
        "mms": null
      }
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The id of the messaging profile to retrieve

Query Parameters

page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response with a list of messaging profile phone numbers.

data
object[]
meta
object