Profiles

List phone numbers associated with a messaging profile

Changed on

Returns the phone numbers currently associated with the specified messaging profile.

get/messaging_profiles/{id}/phone_numbers

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/messaging_profiles/{id}/phone_numbers
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The id of the messaging profile to retrieve

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

Response

Successful response with a list of messaging profile phone numbers.

Example response

{
  "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": "tollfree",
      "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status