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

    Url string

    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.

    FallbackMethod string

    Possible values: [GET, POST]

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

    FallbackUrl string

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

    Method string

    Possible values: [GET, POST]

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

    Status string

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

    The status of the call.

    StatusCallback string

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

    StatusCallbackMethod string

    Possible values: [GET, POST]

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

Responses​

OK

Schema

    account_sid uuid

    The unique identifier for the account that created this call.

    annotation string

    The annotation for the call.

    answered_by string

    Possible values: [human, machine]

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

    api_version

    The version of the SignalWire API.

    caller_name string

    The name of the caller. Only available if Caller ID lookup is enabled.

    date_created string

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

    date_updated string

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

    direction string

    Possible values: [inbound, outbound]

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

    duration number

    The duration, in seconds, of the call.

    end_time string

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

    forwarded_from string

    The number this call was forwarded from.

    from string

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

    formatted_from string

    The formatted number that initiated the call.

    parent_call_sid uuid

    The unique identifier for the call that created this call.

    phone_number_sid uuid

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

    price number

    The charge for the call.

    price_unit string

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

    sid uuid

    The unique identifier for the call.

    start_time string

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

    status string

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

    The status of the call.

    subresource_uris

    object

    A Map of available sub-resources.

    notifications string

    The URI for notifications

    recordings string

    The URI for recordings

    to string

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

    formatted_to string

    The formatted number that received the call.

    uri string

    The URI for the call.

Loading...