Sign in
TrunkingV1PhoneNumber

post/v1/Trunks/{TrunkSid}/PhoneNumbers

Path parameters

TrunkSidstring required

The SID of the Trunk to associate the phone number with.

Response

Created

account_sidstring nullable

The SID of the Account that created the PhoneNumber resource.

address_requirements'none' | 'any' | 'local' | 'foreign'

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

api_versionstring nullable

The API version used to start a new TwiML session.

betaboolean nullable

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

friendly_namestring nullable

The string that you assigned to describe the resource.

linksobject nullable

The URLs of related resources.

phone_numberstring phone-number nullable

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

sidstring nullable

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

sms_application_sidstring nullable

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.

sms_fallback_method'GET' | 'POST' http-method nullable

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

sms_fallback_urlstring uri nullable

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

sms_method'GET' | 'POST' http-method nullable

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

sms_urlstring uri nullable

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

status_callbackstring uri nullable

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

status_callback_method'GET' | 'POST' http-method nullable

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

trunk_sidstring nullable

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.

urlstring uri nullable

The absolute URL of the resource.

voice_application_sidstring nullable

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.

voice_caller_id_lookupboolean nullable

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'GET' | 'POST' http-method nullable

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

voice_fallback_urlstring uri nullable

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

voice_method'GET' | 'POST' http-method nullable

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

voice_urlstring uri nullable

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

Changes

Changed in 3 of the 50 revisions of this API.125

  • v1f7ad1707adef14See the full diff
    • ▲

      the capabilities response's property type/format changed from object/string-map to object/phone-number-capabilities for status 201

      response-property-type-changed

    • ○

      added the optional property capabilities/fax to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property capabilities/mms to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property capabilities/sms to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property capabilities/voice to the response with the 201 status

      response-optional-property-added

  • v1f9ff8ccf746c20See the full diff
    • ○

      removed the DELETE enum value from the sms_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the DELETE enum value from the sms_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the DELETE enum value from the status_callback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the DELETE enum value from the voice_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the DELETE enum value from the voice_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the sms_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the sms_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the status_callback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the voice_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the HEAD enum value from the voice_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the sms_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the sms_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the status_callback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the voice_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PATCH enum value from the voice_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the sms_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the sms_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the status_callback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the voice_fallback_method response property for the response status 201

      response-property-enum-value-removed

    • ○

      removed the PUT enum value from the voice_method response property for the response status 201

      response-property-enum-value-removed

  • v1b6539555f79c1See the full diff
    • ○

      api tag TrunkingV1PhoneNumber added

      api-tag-added