Api20100401Call

Initiates a call redirect or terminates a call

Changed on

Initiates a call redirect or terminates a call

post/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that created the Call resource(s) to update.

Sidstring required

The Twilio-provided string that uniquely identifies the Call resource to update

Request body application/x-www-form-urlencoded

Urlstring uri

The absolute URL that returns the TwiML instructions for the call. We will call this URL using the method when the call connects. For more information, see the Url Parameter section in Making Calls.

Method'GET' | 'POST' http-method

The HTTP method we should use when calling the url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

Status'canceled' | 'completed'
FallbackUrlstring uri

The URL that we call using the fallback_method if an error occurs when requesting or executing the TwiML at url. If an application_sid parameter is present, this parameter is ignored.

FallbackMethod'GET' | 'POST' http-method

The HTTP method that we should use to request the fallback_url. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

StatusCallbackstring uri

The URL we should call using the status_callback_method to send status information to your application. If no status_callback_event is specified, we will send the completed status. If an application_sid parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).

StatusCallbackMethod'GET' | 'POST' http-method

The HTTP method we should use when requesting the status_callback URL. Can be: GET or POST and the default is POST. If an application_sid parameter is present, this parameter is ignored.

Twimlstring twiml

TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive

TimeLimitinteger

The maximum duration of the call in seconds. Constraints depend on account and configuration.

Response

OK

sidstring nullable

The unique string that we created to identify this Call resource.

date_createdstring date-time-rfc-2822 nullable

The date and time in UTC that this resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in UTC that this resource was last updated, specified in RFC 2822 format.

parent_call_sidstring nullable

The SID that identifies the call that created this leg.

account_sidstring nullable

The SID of the Account that created this Call resource.

tostring nullable

The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. SIM SIDs are formatted as sim:sid.

to_formattedstring nullable

The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in E.164 format (e.g., +442071838750).

fromstring nullable

The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. SIM SIDs are formatted as sim:sid.

from_formattedstring nullable

The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in E.164 format (e.g., +442071838750).

phone_number_sidstring nullable

If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed.

status'queued' | 'ringing' | 'in-progress' | 'completed' | 'busy' | 'failed' | 'no-answer' | 'canceled'

The status of this call. Can be: queued, ringing, in-progress, canceled, completed, failed, busy or no-answer. See Call Status Values below for more information.

start_timestring date-time-rfc-2822 nullable

The start time of the call, given as UTC in RFC 2822 format. Empty if the call has not yet been dialed.

end_timestring date-time-rfc-2822 nullable

The time the call ended, given as UTC in RFC 2822 format. Empty if the call did not complete successfully.

durationstring nullable

The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls.

pricestring nullable

The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available. The price associated with a call only reflects the charge for connectivity. Charges for other call-related features such as Answering Machine Detection, Text-To-Speech, and SIP REFER are not included in this value.

price_unitstring currency nullable

The currency in which Price is measured, in ISO 4127 format (e.g., USD, EUR, JPY). Always capitalized for calls.

directionstring nullable

A string describing the direction of the call. Can be: inbound for inbound calls, outbound-api for calls initiated via the REST API or outbound-dial for calls initiated by a <Dial> verb. Using Elastic SIP Trunking, the values can be trunking-terminating for outgoing calls from your communications infrastructure to the PSTN or trunking-originating for incoming calls to your communications infrastructure from the PSTN.

answered_bystring nullable

Either human or machine if this call was initiated with answering machine detection. Empty otherwise.

api_versionstring nullable

The API version used to create the call.

forwarded_fromstring nullable

The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.

group_sidstring nullable

The Group SID associated with this call. If no Group is associated with the call, the field is empty.

caller_namestring nullable

The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.

queue_timestring nullable

The wait time in milliseconds before the call is placed.

trunk_sidstring nullable

The unique identifier of the trunk resource that was used for this call. The field is empty if the call was not made using a SIP trunk or if the call is not terminated.

uristring nullable

The URI of this resource, relative to https://api.twilio.com.

subresource_urisobject nullable

A list of subresources available to this call, identified by their URIs relative to https://api.twilio.com.

Changes

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      removed the enum value PUT of the request property