Initiates a call redirect

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

A Call is an object that represents a connection between a telephone and Twilio.

Initiates a call redirect or terminates a call

Path parameters

  • AccountSid string Required

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

  • Sid string Required

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

Body

  • FallbackMethod string(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.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • FallbackUrl string(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.

  • Method string(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.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • Status string

    The new status of the resource. Can be: canceled or completed. Specifying canceled will attempt to hang up calls that are queued or ringing; however, it will not affect calls already in progress. Specifying completed will attempt to hang up a call even if it's already in progress.

    Values are canceled or completed.

  • StatusCallback string(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 string(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.

    Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

  • TimeLimit integer

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

  • Twiml string

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

  • Url string(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.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created this resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • answered_by string | null

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

    • api_version string | null

      The API Version used to create the call

    • caller_name string | null

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

    • date_created string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that this resource was created

    • date_updated string(date-time-rfc-2822) | null

      The RFC 2822 date and time in GMT that this resource was last updated

    • direction string | null

      A string describing the direction of the call. inbound for inbound calls, outbound-api for calls initiated via the REST API or outbound-dial for calls initiated by a Dial verb.

    • duration string | null

      The length of the call in seconds.

    • end_time string(date-time-rfc-2822) | null

      The end time of the call. Null if the call did not complete successfully.

    • forwarded_from string | null

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

    • from string | null

      The phone number, SIP address or Client identifier 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.

    • from_formatted string | null

      The calling phone number, SIP address, or Client identifier formatted for display.

    • group_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GP[0-9a-fA-F]{32}$.

    • parent_call_sid string | null

      The SID that identifies the call that created this leg.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • phone_number_sid string | null

      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.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^PN[0-9a-fA-F]{32}$.

    • price string | null

      The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.

    • price_unit string(currency) | null

      The currency in which Price is measured.

    • queue_time string | null

      The wait time in milliseconds before the call is placed.

    • sid string | null

      The unique string that identifies this resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CA[0-9a-fA-F]{32}$.

    • start_time string(date-time-rfc-2822) | null

      The start time of the call. Null if the call has not yet been dialed.

    • status string | null

      The status of this call.

      Values are queued, ringing, in-progress, completed, busy, failed, no-answer, or canceled.

    • subresource_uris object(uri-map) | null

      A list of related subresources identified by their relative URIs

    • to string | null

      The phone number, SIP address or Client identifier 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.

    • to_formatted string | null

      The phone number, SIP address or Client identifier that received this call. Formatted for display.

    • trunk_sid string | null

      The (optional) unique identifier of the trunk resource that was used for this call.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TK[0-9a-fA-F]{32}$.

    • uri string(uri) | null

      The URI of this resource, relative to https://api.twilio.com
POST /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json 
curl \
 -X POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'FallbackMethod=HEAD&FallbackUrl=https%3A%2F%2Fexample.com&Method=HEAD&Status=canceled&StatusCallback=https%3A%2F%2Fexample.com&StatusCallbackMethod=HEAD&TimeLimit=42&Twiml=string&Url=https%3A%2F%2Fexample.com'
Request example 
{
  "FallbackMethod": "HEAD",
  "FallbackUrl": "https://example.com",
  "Method": "HEAD",
  "Status": "canceled",
  "StatusCallback": "https://example.com",
  "StatusCallbackMethod": "HEAD",
  "TimeLimit": 42,
  "Twiml": "string",
  "Url": "https://example.com"
}
Request examples 
{
  "FallbackMethod": "HEAD",
  "FallbackUrl": "https://example.com",
  "Method": "HEAD",
  "Status": "canceled",
  "StatusCallback": "https://example.com",
  "StatusCallbackMethod": "HEAD",
  "TimeLimit": 42,
  "Twiml": "string",
  "Url": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "answered_by": "string",
  "api_version": "string",
  "caller_name": "string",
  "date_created": "string",
  "date_updated": "string",
  "direction": "string",
  "duration": "string",
  "end_time": "string",
  "forwarded_from": "string",
  "from": "string",
  "from_formatted": "string",
  "group_sid": "string",
  "parent_call_sid": "string",
  "phone_number_sid": "string",
  "price": "string",
  "price_unit": "string",
  "queue_time": "string",
  "sid": "string",
  "start_time": "string",
  "status": "queued",
  "subresource_uris": {},
  "to": "string",
  "to_formatted": "string",
  "trunk_sid": "string",
  "uri": "https://example.com"
}
Response examples (200) 
{
  "account_sid": "string",
  "answered_by": "string",
  "api_version": "string",
  "caller_name": "string",
  "date_created": "string",
  "date_updated": "string",
  "direction": "string",
  "duration": "string",
  "end_time": "string",
  "forwarded_from": "string",
  "from": "string",
  "from_formatted": "string",
  "group_sid": "string",
  "parent_call_sid": "string",
  "phone_number_sid": "string",
  "price": "string",
  "price_unit": "string",
  "queue_time": "string",
  "sid": "string",
  "start_time": "string",
  "status": "queued",
  "subresource_uris": {},
  "to": "string",
  "to_formatted": "string",
  "trunk_sid": "string",
  "uri": "https://example.com"
}