Skip to main content

Update a call

POST 
/Accounts/:AccountSid/Calls/:Sid

Allows you to modify an active call.

Permissions​

The API token must include the following scopes: Voice.

Request​

Path Parameters

    AccountSid uuidrequired

    The Project ID that uniquely identifies the Account to retrieve.

    Sid uuidrequired

    The Call Sid that uniquely identifies the call to retrieve.

Body

required

    Urlstring

    The URL to handle the call. This parameter allows you to specify a webhook or different route in your code containing XML instructions for how to handle the call. This is required if ApplicationSid is not used.

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

    Whether the request to FallbackUrl is a GET or a POST. Default is POST. If ApplicationSid is present, this parameter is ignored.

    Possible values: [GET, POST]

    Example: GET
    FallbackUrlstring

    The URL SignalWire will request if errors occur when fetching the Url. If ApplicationSid is present, this parameter is ignored.

    Example: https://your-api-endpoint.com/path
    Methodstring

    Whether the request to Url is a GET or a POST. Default is POST. Ignored if ApplicationSid is present.

    Possible values: [GET, POST]

    Statusstring

    The status of the call.

    Possible values: [queued, ringing, in-progress, canceled, completed, busy, failed]

    Example: queued
    StatusCallbackstring

    The URL SignalWire will send webhooks to on every requested StatusCallbackEvent event. See here for the list of parameters passed back to your endpoint.

    Example: https://your-api-endpoint.com/path
    StatusCallbackMethodstring

    Whether the request to StatusCallback URL is a GET or a POST. Default is POST. Ignored if ApplicationSid is present.

    Possible values: [GET, POST]

    Example: GET

Responses​

OK

Schema

    account_siduuid

    The unique identifier for the account that created this call.

    annotationstring

    The annotation for the call.

    answered_bystring

    Who/what the call was answered by. Possible values are human or machine.

    Possible values: [human, machine]

    Example: machine
    api_version

    The version of the SignalWire API.

    Example: 2010-04-01T00:00:00.000Z
    date_createdstring

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

    Example: Wed, 19 Sept 2018 20:00:00 +0000
    date_updatedstring

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

    Example: Wed, 19 Sept 2018 21:00:00 +0000
    directionstring

    The direction of the call. Possible values are inbound or outbound.

    Possible values: [inbound, outbound]

    Example: inbound
    durationnumber

    The duration, in seconds, of the call.

    Example: 20
    end_timestring

    The time, in RFC 2822 GMT format, on which the call was terminated.

    Example: Fri, 21 Sept 2018 10:00:00 +0000
    forwarded_fromstring

    The number this call was forwarded from.

    Example: +13102259067
    fromstring

    The address that initiated the call. Can be either a E.164 formatted number (+xxxxxxxxxxx), or a SIP endpoint (sip:xxx@yyy.zzz).

    Example: +13103384645
    formatted_fromstring

    The formatted number that initiated the call.

    Example: +13102259067
    parent_call_siduuid

    The unique identifier for the call that created this call.

    phone_number_siduuid

    Outbound call: the unique identifier for OutgoingCallerId. Inbound call: the unique identifier for IncomingPhoneNumber.

    pricenumber

    The charge for the call.

    Example: 0.003
    price_unitstring

    The currency, in ISO 4127 format, for the price of the call.

    Example: USD
    siduuid

    The unique identifier for the call.

    start_timestring

    The time, in RFC 2822 GMT format, on which the call began.

    Example: Wed, 19 Sept 2018 20:00:01 +0000
    statusstring

    The status of the call.

    Possible values: [queued, ringing, in-progress, canceled, completed, busy, failed]

    Example: queued

    subresource_uris

    object

    A Map of available sub-resources.

    notificationsstring

    The URI for notifications

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa/Notifications.json
    recordingsstring

    The URI for recordings

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa/Recordings.json
    tostring

    The address that received the call. Can be either a E.164 formatted number (+xxxxxxxxxxx), or a SIP endpoint (sip:xxx@yyy.zzz).

    Example: +13105678901
    formatted_tostring

    The formatted number that received the call.

    Example: (310) 567-8901
    uristring

    The URI for the call.

    Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa.json
Last updated on