Path parameters

• AccountSid string Required

  The SID of the Account that created the resources to read.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

Query parameters

• Beta boolean

  Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.

• FriendlyName string

  A string that identifies the resources to read.

• PhoneNumber string(phone-number)

  The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.

• Origin string

  Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • incoming_phone_numbers array[object]
    Hide incoming_phone_numbers attributes Show incoming_phone_numbers attributes object

    • account_sid string | null

      The SID of the Account that created the resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • address_sid string | null

      The SID of the Address resource associated with the phone number.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AD[0-9a-fA-F]{32}$.

    • address_requirements string

      Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

      Values are none, any, local, or foreign.

    • api_version string | null

      The API version used to start a new TwiML session.

    • beta boolean | null

      Whether the phone number is new to the Twilio platform. Can be: true or false.

    • capabilities object(phone-number-capabilities) | null

      The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

      Hide capabilities attributes Show capabilities attributes object(phone-number-capabilities) | null

      • mms boolean
      • sms boolean
      • voice boolean
      • fax boolean
    • date_created string(date-time-rfc-2822) | null

      The date and time in GMT that the resource was created specified in RFC 2822 format.

    • date_updated string(date-time-rfc-2822) | null

      The date and time in GMT that the resource was last updated specified in RFC 2822 format.

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • identity_sid string | null

      The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RI[0-9a-fA-F]{32}$.

    • phone_number string(phone-number) | null

      The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

    • origin string | null

      The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.

    • sid string | null

      The unique string that that we created to identify the resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

    • sms_application_sid string | null

      The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AP[0-9a-fA-F]{32}$.

    • sms_fallback_method string(http-method) | null

      The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

      Values are GET or POST.

    • sms_fallback_url string(uri) | null

      The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.

    • sms_method string(http-method) | null

      The HTTP method we use to call sms_url. Can be: GET or POST.

      Values are GET or POST.

    • sms_url string(uri) | null

      The URL we call when the phone number receives an incoming SMS message.

    • status_callback string(uri) | null

      The URL we call using the status_callback_method to send status information to your application.

    • status_callback_method string(http-method) | null

      The HTTP method we use to call status_callback. Can be: GET or POST.

      Values are GET or POST.

    • trunk_sid string | null

      The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TK[0-9a-fA-F]{32}$.

    • uri string | null

      The URI of the resource, relative to https://api.twilio.com.

    • voice_receive_mode string

      Values are voice or fax.

    • voice_application_sid string | null

      The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AP[0-9a-fA-F]{32}$.

    • voice_caller_id_lookup boolean | null

      Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

    • voice_fallback_method string(http-method) | null

      The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

      Values are GET or POST.

    • voice_fallback_url string(uri) | null

      The URL that we call when an error occurs retrieving or executing the TwiML requested by url.

    • voice_method string(http-method) | null

      The HTTP method we use to call voice_url. Can be: GET or POST.

      Values are GET or POST.

    • voice_url string(uri) | null

      The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

    • emergency_status string

      The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

      Values are Active or Inactive.

    • emergency_address_sid string | null

      The SID of the emergency address configuration that we use for emergency calling from this phone number.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AD[0-9a-fA-F]{32}$.

    • emergency_address_status string

      The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

      Values are registered, unregistered, pending-registration, registration-failure, pending-unregistration, or unregistration-failure.

    • bundle_sid string | null

      The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

    • status string | null
  • end integer
  • first_page_uri string(uri)
  • next_page_uri string(uri) | null
  • page integer
  • page_size integer
  • previous_page_uri string(uri) | null
  • start integer
  • uri string(uri)