Sign in
Calls

Create a Call

Create a call.

Permissions

The API token must include the following scopes: Voice.

post/Accounts/{AccountSid}/Calls

Response

OK

account_sidstring uuid

The unique identifier for the account that created this call.

annotationstring

The annotation for the call.

answered_by'human' | 'machine'

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

api_versionstring

The version of the SignalWire API.

date_createdstring

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

date_updatedstring

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

direction'inbound' | 'outbound'

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

durationnumber

The duration, in seconds, of the call.

end_timestring

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

forwarded_fromstring

The number this call was forwarded from.

fromstring

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

formatted_fromstring

The formatted number that initiated the call.

parent_call_sidstring uuid

The unique identifier for the call that created this call.

phone_number_sidstring uuid

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

pricenumber

The charge for the call.

price_unitstring

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

sidstring uuid

The unique identifier for the call.

start_timestring

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

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

The status of the call.

tostring

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

formatted_tostring

The formatted number that received the call.

uristring

The URI for the call.

Example response

{
  "answered_by": "machine",
  "api_version": "2010-04-01T00:00:00.000Z",
  "date_created": "Wed, 19 Sept 2018 20:00:00 +0000",
  "date_updated": "Wed, 19 Sept 2018 21:00:00 +0000",
  "direction": "inbound",
  "duration": 20,
  "end_time": "Fri, 21 Sept 2018 10:00:00 +0000",
  "forwarded_from": "+13102259067",
  "from": "+13103384645",
  "formatted_from": "+13102259067",
  "price": 0.003,
  "price_unit": "USD",
  "start_time": "Wed, 19 Sept 2018 20:00:01 +0000",
  "status": "queued",
  "subresource_uris": {
    "notifications": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa/Notifications.json",
    "recordings": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa/Recordings.json"
  },
  "to": "+13105678901",
  "formatted_to": "(310) 567-8901",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472pa.json"
}

Changes