Profiles

List short codes associated with a messaging profile

Changed on

Returns the short codes currently associated with the specified messaging profile.

get/messaging_profiles/{id}/short_codes

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/messaging_profiles/{id}/short_codes
  • 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 short codes.

Example response

{
  "data": [
    {
      "record_type": "short_code",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "short_code": "12345",
      "country_code": "US",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tags": [
        "test_customer"
      ],
      "created_at": "2019-01-23T18:10:02.574Z",
      "updated_at": "2019-01-23T18:10:02.574Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • a72569d69430Revision changes
    • warning

      deleted the query request parameter page[number]

    • warning

      deleted the query request parameter page[size]

    • info

      added the new optional query request parameter page