GET /v2/list-phone-numbers

Changed on

List phone numbers with pagination

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of items to return.

sort_order'ascending' | 'descending'

Sort order for results.

pagination_keystring

Pagination key for fetching the next page.

Response

Successfully retrieved phone numbers.

pagination_keystring

Pagination key for the next page.

has_moreboolean required

Whether more results are available.

Example response

{
  "items": [
    {
      "phone_number": "+14157774444",
      "phone_number_type": "retell-twilio",
      "phone_number_pretty": "+1 (415) 777-4444",
      "allowed_inbound_country_list": [
        "US",
        "CA",
        "GB"
      ],
      "allowed_outbound_country_list": [
        "US",
        "CA"
      ],
      "area_code": 415,
      "inbound_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "agent_version": "latest_published",
          "weight": 0.5
        }
      ],
      "outbound_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "agent_version": "latest_published",
          "weight": 0.5
        }
      ],
      "inbound_sms_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "agent_version": "latest_published",
          "weight": 0.5
        }
      ],
      "outbound_sms_agents": [
        {
          "agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
          "agent_version": "latest_published",
          "weight": 0.5
        }
      ],
      "nickname": "Frontdesk Number",
      "inbound_webhook_url": "https://example.com/inbound-webhook",
      "inbound_sms_webhook_url": "https://example.com/inbound-sms-webhook",
      "last_modification_timestamp": 1703413636133,
      "sip_outbound_trunk_config": {
        "termination_uri": "someuri.pstn.twilio.com",
        "auth_username": "username",
        "transport": "TCP",
        "codecs": [
          "PCMU",
          "PCMA",
          "G.722"
        ]
      },
      "fallback_number": "+14155551234"
    }
  ]
}

Changes

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status