Sign in
Incoming Phone Numbers

List all Incoming Phone Numbers

List all incoming phone numbers.

Permissions

The API token must include the following scopes: Numbers.

get/Accounts/{AccountSid}/IncomingPhoneNumbers

Path parameters

AccountSidstring uuid required

The unique identifier for the account that is associated with this phone number.

Query parameters

Pageinteger

The page index to retrieve. Zero-indexed.

PageSizeinteger

The number of results per page. Default is 50, maximum is 1000.

PageTokenstring

Token for cursor-based pagination. Required when Page > 0.

PhoneNumberstring

Only show numbers that match this pattern.

FriendlyNamestring

Only show numbers with this friendly name.

Betaboolean

Only show numbers that are marked as beta.

Originstring

Only show numbers that match this origin.

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page, or null if there are no more pages.

previous_page_uristring nullable required

The URI of the previous page, or null if this is the first page.

pageinteger required

The current page number.

page_sizeinteger required

The number of items per page.

Example response

{
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=0&PageSize=50",
  "first_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=0&PageSize=50",
  "next_page_uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=1&PageSize=50&PageToken=PAb3877c40da604998",
  "page_size": 50,
  "incoming_phone_numbers": [
    {
      "account_id": "b3877c40-da60-4998-90ad-b792e98472ac",
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "api_version": "2010-04-01",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true,
        "fax": true
      },
      "country_code": "US",
      "date_created": "Tue, 25 Sept 2018 23:00:00 +0000",
      "date_updated": "Wed, 26 Sept 2018 22:00:00 +0000",
      "emergency_status": "Inactive",
      "friendly_name": "(310) 338-6745",
      "phone_number": "+13103386745",
      "sid": "b3877c40-da60-4998-90ad-b792e98472pn",
      "sms_fallback_method": "POST",
      "sms_method": "POST",
      "status_callback_method": "POST",
      "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json",
      "verification_status": "Unverified",
      "voice_fallback_method": "POST",
      "voice_method": "POST"
    }
  ]
}

Changes