Skip to main content

Create an Incoming Phone Number

POST 

/Accounts/:AccountSid/IncomingPhoneNumbers

Create an Incoming Phone Number.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

    AccountSid uuidrequired

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

Body

    AreaCode stringrequired

    The area code of your new number. A new number within this area code will be generated for you. Area code is necessary if phone number is not present.

    PhoneNumber stringrequired

    The incoming number in E.164 format.

    Example: +13103386745
    AddressSid string

    The unique identifier for the address associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472ad
    FriendlyName string

    A formatted version of the number.

    Example: 310-338-6745
    IdentitySid string

    The unique identifier for the identity associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472ri
    SmsApplicationSid string

    The unique identifier for the application associated with SMS handling on this phone number. If SmsApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.

    Example: null
    SmsFallbackMethod string

    Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    SmsFallbackUrl string

    The URL to request if errors occur when fetching SmsUrl.

    Example:
    SmsMethod string

    Whether the request to SmsUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    SmsUrl string

    The URL to request when an incoming SMS is received.

    Example:
    StatusCallback string

    The URL to request to pass status updates to.

    Example: example.com
    StatusCallbackMethod string

    Whether the request to StatusCallback is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    TrunkSid string

    The unique identifier for the Trunk associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472tr
    VoiceApplicationSid string

    The unique identifier for the application associated with call handling on this phone number. If VoiceApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.

    Example: null
    VoiceCallerIdLookup boolean

    Whether or not to look up a caller's name in the database.

    VoiceFallbackMethod string

    Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    VoiceFallbackUrl string

    The URL to request if errors occur when fetching Url.

    Example: example.com
    VoiceMethod string

    Whether the request to Url is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    VoiceReceiveMode string

    Whether this number can receive calls or fax. Possible values are voice or fax. Default is voice.

    Possible values: [voice, fax]

    Example: voice
    VoiceUrl string

    The URL to request when an incoming call is received.

    Example: http://your-application.com/docs/voice.xml

Responses

OK

Schema

    account_sid uuid

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

    Example: b3877c40-da60-4998-90ad-b792e98472ac
    address_requirements string

    Whether or not a registered address with SignalWire is required.

    Possible values: [none, any, local, foreign]

    Example: none
    address_sid string

    The unique identifier for the address associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472ad
    api_version string

    The version of the SignalWire API.

    Example: 2010-04-01
    beta boolean

    New numbers on SignalWire are marked as beta.

    capabilities

    object

    Whether or not a number can receive calls and messages.

    Voice boolean
    SMS boolean
    MMS boolean
    Fax boolean
    date_created string

    The date, in RFC 2822 format, this phone number was created.

    Example: Tue, 25 Sept 2018 23:00:00 +0000
    date_updated string

    The date, in RFC 2822 format, this phone number was updated.

    Example: Wed, 26 Sept 2018 22:00:00 +0000
    emergency_address_sid string

    The unique identifier of the address associated with E911 for this phone number.

    Example: null
    emergency_status string

    Whether the phone route has an active E911 address associated.

    Possible values: [active, inactive]

    Example: active
    friendly_name string

    A formatted version of the number.

    Example: 310-338-6745
    identity_sid string

    The unique identifier for the identity associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472ri
    origin string

    The origin of the phone number. SignalWire numbers are denoted as signalwire while hosted numbers are denoted as hosted.

    Possible values: [signalwire, hosted]

    Example: origin
    phone_number string

    The incoming number in E.164 format.

    Example: +13103386745
    sid string

    The unique identifier for this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472pn
    sms_application_sid string

    The unique identifier for the application associated with SMS handling on this phone number. If SmsApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.

    Example: null
    sms_fallback_method string

    Whether the request to SmsFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    sms_fallback_url string

    The URL to request if errors occur when fetching SmsUrl.

    Example:
    sms_method string

    Whether the request to SmsUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    sms_url string

    The URL to request when an incoming SMS is received.

    Example:
    status_callback string

    The URL to request to pass status updates to.

    Example: example.com
    status_callback_method string

    Whether the request to StatusCallback is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    trunk_sid string

    The unique identifier for the Trunk associated with this phone number.

    Example: b3877c40-da60-4998-90ad-b792e98472tr
    uri string

    The URI for this number.

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json
    voice_application_sid string

    The unique identifier for the application associated with call handling on this phone number. If VoiceApplicationSid is present, the URLs on the application will be used and all other URLs will be ignored.

    Example: null
    voice_caller_id_lookup boolean

    Whether or not to look up a caller's name in the database.

    voice_fallback_method string

    Whether the request to VoiceFallbackUrl is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: POST
    voice_fallback_url string

    The URL to request if errors occur when fetching Url.

    Example: example.com
    voice_method string

    Whether the request to Url is a GET or a POST. Default is POST.

    Possible values: [GET, POST]

    Example: GET
    voice_url string

    The URL to request when an incoming call is received.

    Example: http://your-application.com/docs/voice.xml