Skip to main content

Create an Application

POST 
/Accounts/:AccountSid/Applications

Create an Application.

Permissions​

The API token must include one of the following scopes: Voice or Messaging or Fax.

Request​

Path Parameters

    AccountSid uuidrequired

    The Account ID that has the Application.

Body

required

    FriendlyName stringrequired

    A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

    MessageStatusCallback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    SmsFallbackMethod string

    Possible values: [GET, POST]

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

    SmsFallbackUrl string

    The URL SignalWire will request if errors occur when fetching the SmsUrl.

    SmsMethod string

    Possible values: [GET, POST]

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

    SmsStatusCallback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    SmsUrl string

    The URL to request when an SMS is received.

    StatusCallback string

    The URL to pass status updates to the Application.

    StatusCallbackMethod string

    Possible values: [GET, POST]

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

    VoiceCallerIdLookup boolean

    Whether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.

    VoiceFallbackMethod string

    Possible values: [GET, POST]

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

    VoiceFallbackUrl string

    The URL SignalWire will request if errors occur when fetching the Url.

    VoiceMethod string

    Possible values: [GET, POST]

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

    VoiceUrl string

    The URL to request when a phone number receives a call or fax.

Responses​

OK

Schema

    account_sid uuid

    The unique identifier for the Account that created this Application.

    api_version string

    The version of the SignalWire API.

    date_created string

    The date, in RFC 2822 GMT format, this Account was created.

    date_updated string

    The date, in RFC 2822 GMT format, this Account was updated.

    sid uuid

    The unique identifier for the Account.

    friendly_name string

    A named unique identifier for the resource. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

    message_status_callback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    sms_fallback_method string

    Possible values: [GET, POST]

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

    sms_fallback_url string

    The URL SignalWire will request if errors occur when fetching the SmsUrl.

    sms_method string

    Possible values: [GET, POST]

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

    sms_status_callback string

    If a message's ApplicationSid is set to this Application's Sid, when a message receives a status change, SignalWire will send a POST request to this URL with the message's details.

    sms_url string

    The URL to request when an SMS is received.

    status_callback string

    The URL to pass status updates to the Application.

    staus_callback_method string

    Possible values: [GET, POST]

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

    uri string

    The URI for this Application.

    voice_caller_id_lookup boolean

    Whether or not to look up a caller's ID from the database. Possible values are true or false. Default is false.

    voice_fallback_method string

    Possible values: [GET, POST]

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

    voice_fallback_url string

    The URL SignalWire will request if errors occur when fetching the Url.

    voice_method string

    Possible values: [GET, POST]

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

    voice_url string

    The URL to request when a phone number receives a call or fax.

Loading...