Responses

• 201

  Created

  Hide response attributes Show response attributes object

  • auth_token string | null

    The authorization token for this account

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

    The date this account was created

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

    The date this account was last updated

  • friendly_name string | null

    A human readable description of this account

  • owner_account_sid string | null

    The unique 34 character id representing the parent of this account

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

  • sid string | null

    A 34 character string that uniquely identifies this resource.

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

  • status string | null

    The status of this account

    Values are active, suspended, or closed.

  • subresource_uris object(uri-map) | null

    Account Instance Subresources

  • type string | null

    The type of this account

    Values are Trial or Full.

  • uri string(uri) | null

    The URI for this resource, relative to https://api.twilio.com

Path parameters

• AccountSid string Required

  The SID of the Account that is responsible for the Address resource to read.

Query parameters

• CustomerName string

  The customer_name of the Address resources to read.

• FriendlyName string

  The string that identifies the Address resources to read.

• IsoCountry string(iso-country-code)

  The ISO country code of the Address resources to read.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • account_sid string | null

      The SID of the Account that is responsible for the resource

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

    • city string | null

      The city in which the address is located

    • customer_name string | null

      The name associated with the address

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

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

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

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

    • emergency_enabled boolean | null

      Whether emergency calling has been enabled on this number

    • friendly_name string | null

      The string that you assigned to describe the resource

    • iso_country string(iso-country-code) | null

      The ISO country code of the address

    • postal_code string | null

      The postal code of the address

    • region string | null

      The state or region of the address

    • sid string | null

      The unique string that identifies the resource

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

    • street string | null

      The number and street address of the address

    • uri string(uri) | null

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

    • validated boolean | null

      Whether the address has been validated to comply with local regulation

    • verified boolean | null

      Whether the address has been verified to comply with regulation

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

Path parameters

• AccountSid string Required

  The SID of the Account that will be responsible for the new Address resource.

Responses

• 201

  Created

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that is responsible for the resource

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

  • city string | null

    The city in which the address is located

  • customer_name string | null

    The name associated with the address

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

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

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

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

  • emergency_enabled boolean | null

    Whether emergency calling has been enabled on this number

  • friendly_name string | null

    The string that you assigned to describe the resource

  • iso_country string(iso-country-code) | null

    The ISO country code of the address

  • postal_code string | null

    The postal code of the address

  • region string | null

    The state or region of the address

  • sid string | null

    The unique string that identifies the resource

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

  • street string | null

    The number and street address of the address

  • uri string(uri) | null

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

  • validated boolean | null

    Whether the address has been validated to comply with local regulation

  • verified boolean | null

    Whether the address has been verified to comply with regulation

Path parameters

• AccountSid string Required

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

• AddressSid string Required

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

Query parameters

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • dependent_phone_numbers array[object]
    Hide dependent_phone_numbers attributes Show dependent_phone_numbers attributes array[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_requirements string | null

      Whether the phone number requires an Address registered with Twilio

      Values are none, any, local, or foreign.

    • api_version string | null

      The API version used to start a new TwiML session

    • capabilities

      Indicate if a phone can receive calls or messages

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

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

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

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

    • emergency_address_sid string | null

      The emergency address configuration to use for emergency calling

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

    • emergency_status string | null

      Whether the phone number is enabled for emergency calling

      Values are Active or Inactive.

    • friendly_name string(phone-number) | null

      The string that you assigned to describe the resource

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • sid string | null

      The unique string that identifies 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

      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 used with sms_fallback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • sms_fallback_url string(uri) | null

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

    • sms_method string(http-method) | null

      The HTTP method to use with sms_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • 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 to send status information to your application

    • status_callback_method string(http-method) | null

      The HTTP method we use to call status_callback

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • trunk_sid string | null

      The SID of the Trunk that handles calls to the phone number

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

    • uri string(uri) | null

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

    • voice_application_sid string | null

      The SID of the application that handles calls to the phone number

      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 to lookup the caller's name

    • voice_fallback_method string(http-method) | null

      The HTTP method used with voice_fallback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_fallback_url string(uri) | null

      The URL we call when an error occurs in TwiML

    • voice_method null | string(http-method)

      The HTTP method used with the voice_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_url string(uri) | null

      The URL we call when the phone number receives a call

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

Path parameters

• AccountSid string Required

  The SID of the Account that is responsible for the Address resource to fetch.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Address resource to fetch.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that is responsible for the resource

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

  • city string | null

    The city in which the address is located

  • customer_name string | null

    The name associated with the address

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

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

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

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

  • emergency_enabled boolean | null

    Whether emergency calling has been enabled on this number

  • friendly_name string | null

    The string that you assigned to describe the resource

  • iso_country string(iso-country-code) | null

    The ISO country code of the address

  • postal_code string | null

    The postal code of the address

  • region string | null

    The state or region of the address

  • sid string | null

    The unique string that identifies the resource

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

  • street string | null

    The number and street address of the address

  • uri string(uri) | null

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

  • validated boolean | null

    Whether the address has been validated to comply with local regulation

  • verified boolean | null

    Whether the address has been verified to comply with regulation

Path parameters

• AccountSid string Required

  The SID of the Account that is responsible for the Address resource to update.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Address resource to update.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that is responsible for the resource

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

  • city string | null

    The city in which the address is located

  • customer_name string | null

    The name associated with the address

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

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

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

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

  • emergency_enabled boolean | null

    Whether emergency calling has been enabled on this number

  • friendly_name string | null

    The string that you assigned to describe the resource

  • iso_country string(iso-country-code) | null

    The ISO country code of the address

  • postal_code string | null

    The postal code of the address

  • region null | string

    The state or region of the address

  • sid string | null

    The unique string that identifies the resource

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

  • street string | null

    The number and street address of the address

  • uri string(uri) | null

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

  • validated boolean | null

    Whether the address has been validated to comply with local regulation

  • verified boolean | null

    Whether the address has been verified to comply with regulation

Path parameters

• AccountSid string Required

  The SID of the Account that is responsible for the Address resource to delete.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Address resource to delete.

Responses

• 204

  The resource was deleted successfully.

Path parameters

• AccountSid string Required

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

Query parameters

• FriendlyName string

  The string that identifies the Application resources to read.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • applications array[object]
    Hide applications attributes Show applications attributes array[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}$.

    • api_version string | null

      The API version used to start a new TwiML session

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

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

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

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

    • friendly_name string | null

      The string that you assigned to describe the resource

    • message_status_callback string(uri) | null

      The URL to send message status information to your application

    • sid string | null

      The unique string that identifies the resource

      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 used with sms_fallback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • sms_fallback_url string(uri) | null

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

    • sms_method string(http-method) | null

      The HTTP method to use with sms_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • sms_status_callback string(uri) | null

      The URL to send status information to your application

    • 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 to send status information to your application

    • status_callback_method string(http-method) | null

      The HTTP method we use to call status_callback

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • uri string(uri) | null

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

    • voice_caller_id_lookup boolean | null

      Whether to lookup the caller's name

    • voice_fallback_method string(http-method) | null

      The HTTP method used with voice_fallback_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_fallback_url string(uri) | null

      The URL we call when a TwiML error occurs

    • voice_method string(http-method) | null

      The HTTP method used with the voice_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • voice_url string(uri) | null

      The URL we call when the phone number receives a call

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

Path parameters

• AccountSid string Required

  The SID of the Account that will create the resource.

Responses

• 201

  Created

  Hide response attributes Show response 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}$.

  • api_version string | null

    The API version used to start a new TwiML session

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

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

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

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

  • friendly_name string | null

    The string that you assigned to describe the resource

  • message_status_callback string(uri) | null

    The URL to send message status information to your application

  • sid string | null

    The unique string that identifies the resource

    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 used with sms_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_fallback_url string(uri) | null

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

  • sms_method string(http-method) | null

    The HTTP method to use with sms_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_status_callback string(uri) | null

    The URL to send status information to your application

  • 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 to send status information to your application

  • status_callback_method string(http-method) | null

    The HTTP method we use to call status_callback

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • uri string(uri) | null

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

  • voice_caller_id_lookup boolean | null

    Whether to lookup the caller's name

  • voice_fallback_method string(http-method) | null

    The HTTP method used with voice_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_fallback_url string(uri) | null

    The URL we call when a TwiML error occurs

  • voice_method string(http-method) | null

    The HTTP method used with the voice_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_url string(uri) | null

    The URL we call when the phone number receives a call

Path parameters

• AccountSid string Required

  The SID of the Account that created the Application resource to fetch.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Application resource to fetch.

Responses

• 200

  OK

  Hide response attributes Show response 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}$.

  • api_version string | null

    The API version used to start a new TwiML session

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

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

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

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

  • friendly_name string | null

    The string that you assigned to describe the resource

  • message_status_callback string(uri) | null

    The URL to send message status information to your application

  • sid string | null

    The unique string that identifies the resource

    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 used with sms_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_fallback_url string(uri) | null

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

  • sms_method string(http-method) | null

    The HTTP method to use with sms_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_status_callback string(uri) | null

    The URL to send status information to your application

  • 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 to send status information to your application

  • status_callback_method string(http-method) | null

    The HTTP method we use to call status_callback

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • uri string(uri) | null

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

  • voice_caller_id_lookup boolean | null

    Whether to lookup the caller's name

  • voice_fallback_method string(http-method) | null

    The HTTP method used with voice_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_fallback_url string(uri) | null

    The URL we call when a TwiML error occurs

  • voice_method string(http-method) | null

    The HTTP method used with the voice_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_url string(uri) | null

    The URL we call when the phone number receives a call

Path parameters

• AccountSid string Required

  The SID of the Account that created the Application resources to update.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Application resource to update.

Responses

• 200

  OK

  Hide response attributes Show response 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}$.

  • api_version string | null

    The API version used to start a new TwiML session

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

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

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

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

  • friendly_name string | null

    The string that you assigned to describe the resource

  • message_status_callback string(uri) | null

    The URL to send message status information to your application

  • sid string | null

    The unique string that identifies the resource

    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 used with sms_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_fallback_url string(uri) | null

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

  • sms_method string(http-method) | null

    The HTTP method to use with sms_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • sms_status_callback string(uri) | null

    The URL to send status information to your application

  • 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 to send status information to your application

  • status_callback_method string(http-method) | null

    The HTTP method we use to call status_callback

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • uri string(uri) | null

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

  • voice_caller_id_lookup boolean | null

    Whether to lookup the caller's name

  • voice_fallback_method string(http-method) | null

    The HTTP method used with voice_fallback_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_fallback_url string(uri) | null

    The URL we call when a TwiML error occurs

  • voice_method string(http-method) | null

    The HTTP method used with the voice_url

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • voice_url string(uri) | null

    The URL we call when the phone number receives a call

Path parameters

• AccountSid string Required

  The SID of the Account that created the Application resources to delete.

• Sid string Required

  The Twilio-provided string that uniquely identifies the Application resource to delete.

Responses

• 204

  The resource was deleted successfully.

Path parameters

• AccountSid string Required

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

Query parameters

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • authorized_connect_apps array[object]
    Hide authorized_connect_apps attributes Show authorized_connect_apps attributes array[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}$.

    • connect_app_company_name string | null

      The company name set for the Connect App

    • connect_app_description string | null

      A detailed description of the app

    • connect_app_friendly_name string | null

      The name of the Connect App

    • connect_app_homepage_url string(uri) | null

      The public URL for the Connect App

    • connect_app_sid string | null

      The SID that we assigned to the Connect App

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

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

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

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

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

    • permissions array[string] | null

      Permissions authorized to the app

      Values are get-all or post-all.

    • uri string(uri) | null

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

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

Path parameters

• AccountSid string Required

  The SID of the Account that created the AuthorizedConnectApp resource to fetch.

• ConnectAppSid string Required

  The SID of the Connect App to fetch.

Responses

• 200

  OK

  Hide response attributes Show response 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}$.

  • connect_app_company_name string | null

    The company name set for the Connect App

  • connect_app_description string | null

    A detailed description of the app

  • connect_app_friendly_name string | null

    The name of the Connect App

  • connect_app_homepage_url string(uri) | null

    The public URL for the Connect App

  • connect_app_sid string | null

    The SID that we assigned to the Connect App

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

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

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

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

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

  • permissions array[string] | null

    Permissions authorized to the app

    Values are get-all or post-all.

  • uri string(uri) | null

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the available phone number Country resources.

Query parameters

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • beta boolean | null

      Whether all phone numbers available in the country are new to the Twilio platform.

    • country string | null

      The name of the country

    • country_code string(iso-country-code) | null

      The ISO-3166-1 country code of the country.

    • subresource_uris object(uri-map) | null

      A list of related resources identified by their relative URIs

    • uri string(uri) | null

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

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the available phone number Country resource.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country to fetch available phone number information about.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • beta boolean | null

    Whether all phone numbers available in the country are new to the Twilio platform.

  • country string | null

    The name of the country

  • country_code string(iso-country-code) | null

    The ISO-3166-1 country code of the country.

  • subresource_uris object(uri-map) | null

    A list of related resources identified by their relative URIs

  • uri string(uri) | null

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • end integer
  • available_phone_numbers array[object]
    Hide available_phone_numbers attributes Show available_phone_numbers attributes array[object]

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

  • first_page_uri string(uri)
  • next_page_uri string(uri)
  • page integer
  • page_size integer
  • previous_page_uri string(uri)
  • start integer
  • uri string(uri)

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • address_requirements string | null

      The type of Address resource the phone number requires

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Query parameters

• FriendlyName string

  Only return the Account resources with friendly names that exactly match this name.

• Status string

  Only return Account resources with the given status. Can be closed, suspended or active.

  Values are active, suspended, or closed.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • auth_token string | null

      The authorization token for this account

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

      The date this account was created

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

      The date this account was last updated

    • friendly_name string | null

      A human readable description of this account

    • owner_account_sid string | null

      The unique 34 character id representing the parent of this account

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

    • sid string | null

      A 34 character string that uniquely identifies this resource.

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

    • status string | null

      The status of this account

      Values are active, suspended, or closed.

    • subresource_uris object(uri-map) | null

      Account Instance Subresources

    • type string | null

      The type of this account

      Values are Trial or Full.

    • uri string(uri) | null

      The URI for this resource, relative to https://api.twilio.com

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

Path parameters

• AccountSid string Required

  The SID of the Account that created the UsageTrigger resources to delete.

• Sid string Required

  The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete.

Responses

• 204

  The resource was deleted successfully.

Path parameters

• Sid string Required

  The Account Sid that uniquely identifies the account to fetch

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • auth_token string | null

    The authorization token for this account

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

    The date this account was created

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

    The date this account was last updated

  • friendly_name string | null

    A human readable description of this account

  • owner_account_sid string | null

    The unique 34 character id representing the parent of this account

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

  • sid string | null

    A 34 character string that uniquely identifies this resource.

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

  • status string | null

    The status of this account

    Values are active, suspended, or closed.

  • subresource_uris object(uri-map) | null

    Account Instance Subresources

  • type string | null

    The type of this account

    Values are Trial or Full.

  • uri string(uri) | null

    The URI for this resource, relative to https://api.twilio.com

Path parameters

• Sid string Required

  The Account Sid that uniquely identifies the account to update

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • auth_token string | null

    The authorization token for this account

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

    The date this account was created

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

    The date this account was last updated

  • friendly_name string | null

    A human readable description of this account

  • owner_account_sid string | null

    The unique 34 character id representing the parent of this account

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

  • sid string | null

    A 34 character string that uniquely identifies this resource.

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

  • status string | null

    The status of this account

    Values are active, suspended, or closed.

  • subresource_uris object(uri-map) | null

    Account Instance Subresources

  • type string | null

    The type of this account

    Values are Trial or Full.

  • uri string(uri) | null

    The URI for this resource, relative to https://api.twilio.com

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name null | string(phone-number)

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality null | string

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Path parameters

• AccountSid string Required

  The SID of the Account requesting the AvailablePhoneNumber resources.

• CountryCode string(iso-country-code) Required

  The ISO-3166-1 country code of the country from which to read phone numbers.

Query parameters

• AreaCode integer

  The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.

• VoiceEnabled boolean

  Whether the phone numbers can receive calls. Can be: true or false.

• Contains string

  The pattern on which to match phone numbers. Valid characters are *, 0-9, a-z, and A-Z. The * character matches any single digit. For examples, see Example 2 and Example 3. If specified, this value must have at least two characters.

• SmsEnabled boolean

  Whether the phone numbers can receive text messages. Can be: true or false.

• MmsEnabled boolean

  Whether the phone numbers can receive MMS messages. Can be: true or false.

• ExcludeAllAddressRequired boolean

  Whether to exclude phone numbers that require an Address. Can be: true or false and the default is false.

• ExcludeLocalAddressRequired boolean

  Whether to exclude phone numbers that require a local Address. Can be: true or false and the default is false.

• ExcludeForeignAddressRequired boolean

  Whether to exclude phone numbers that require a foreign Address. Can be: true or false and the default is false.

• Beta boolean

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

• NearNumber string(phone-number)

  Given a phone number, find a geographically close number within distance miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.

• NearLatLong string

  Given a latitude/longitude pair lat,long find geographically close numbers within distance miles. Applies to only phone numbers in the US and Canada.

• Distance integer

  The search radius, in miles, for a near_ query. Can be up to 500 and the default is 25. Applies to only phone numbers in the US and Canada.

• InPostalCode string

  Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.

• InRegion string

  Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.

• InRateCenter string

  Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires in_lata to be set as well. Applies to only phone numbers in the US and Canada.

• InLata string

  Limit results to a specific local access and transport area (LATA). Given a phone number, search within the same LATA as that number. Applies to only phone numbers in the US and Canada.

• InLocality string

  Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.

• FaxEnabled boolean

  Whether the phone numbers can receive faxes. Can be: true or false.

• PageSize integer

  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.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

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

    • address_requirements string | null

      The type of Address resource the phone number requires

    • beta boolean | null

      Whether the phone number is new to the Twilio platform

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

      Whether a phone number can receive calls or messages

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

      • fax boolean
      • mms boolean
      • sms boolean
      • voice boolean
    • friendly_name string(phone-number) | null

      A formatted version of the phone number

    • iso_country string(iso-country-code) | null

      The ISO country code of this phone number

    • lata string | null

      The LATA of this phone number

    • latitude string | null

      The latitude of this phone number's location

    • locality string | null

      The locality or city of this phone number's location

    • longitude string | null

      The longitude of this phone number's location

    • phone_number string(phone-number) | null

      The phone number in E.164 format

    • postal_code string | null

      The postal or ZIP code of this phone number's location

    • rate_center string | null

      The rate center of this phone number

    • region string | null

      The two-letter state or province abbreviation of this phone number's location

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

Path parameters

• AccountSid string Required

  The unique SID identifier of the Account.

Responses

• 200

  OK

  Hide response attributes Show response attributes object

  • account_sid string | null

    Account Sid.

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

  • balance string | null

    Account balance

  • currency string | null

    Currency units

Path parameters

• AccountSid string Required

  The SID of the Account that created the Call resource(s) to read.

Query parameters

• To string(phone-number)

  Only show calls made to this phone number, SIP address, Client identifier or SIM SID.

• From string(phone-number)

  Only include calls from this phone number, SIP address, Client identifier or SIM SID.

• ParentCallSid string

  Only include calls spawned by calls with this SID.

• Status string

  The status of the calls to include. Can be: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer.

  Values are queued, ringing, in-progress, completed, busy, failed, no-answer, or canceled.

• StartTime string(date-time)

  Only include calls that started on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that started on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read calls that started on or before midnight of this date, and StartTime>=YYYY-MM-DD to read calls that started on or after midnight of this date.

• StartTime< string(date-time)

  Only include calls that started on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that started on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read calls that started on or before midnight of this date, and StartTime>=YYYY-MM-DD to read calls that started on or after midnight of this date.

• StartTime> string(date-time)

  Only include calls that started on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that started on this date. You can also specify an inequality, such as StartTime<=YYYY-MM-DD, to read calls that started on or before midnight of this date, and StartTime>=YYYY-MM-DD to read calls that started on or after midnight of this date.

• EndTime string(date-time)

  Only include calls that ended on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that ended on this date. You can also specify an inequality, such as EndTime<=YYYY-MM-DD, to read calls that ended on or before midnight of this date, and EndTime>=YYYY-MM-DD to read calls that ended on or after midnight of this date.

• EndTime< string(date-time)

  Only include calls that ended on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that ended on this date. You can also specify an inequality, such as EndTime<=YYYY-MM-DD, to read calls that ended on or before midnight of this date, and EndTime>=YYYY-MM-DD to read calls that ended on or after midnight of this date.

• EndTime> string(date-time)

  Only include calls that ended on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read only calls that ended on this date. You can also specify an inequality, such as EndTime<=YYYY-MM-DD, to read calls that ended on or before midnight of this date, and EndTime>=YYYY-MM-DD to read calls that ended on or after midnight of this date.

• PageSize integer

  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.