Twilio · JSON Structure

Twilio Call Structure

Structure documentation for the Twilio Call resource returned by the Voice API

Type: object Properties: 0
AuthenticationCommunicationsContact CenterEmailIoTMessagingPhoneSMST1VerificationVideoVoice

TwilioCall is a JSON Structure definition published by Twilio.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "TwilioCall",
  "description": "Structure documentation for the Twilio Call resource returned by the Voice API",
  "type": "object",
  "fields": [
    {"name": "sid", "type": "string", "required": true, "description": "Unique call identifier with CA prefix"},
    {"name": "account_sid", "type": "string", "required": true, "description": "Account SID that owns this call"},
    {"name": "to", "type": "string", "required": true, "description": "Phone number that received the call"},
    {"name": "to_formatted", "type": "string", "required": false, "description": "Formatted version of the to phone number"},
    {"name": "from", "type": "string", "required": true, "description": "Phone number that initiated the call"},
    {"name": "from_formatted", "type": "string", "required": false, "description": "Formatted version of the from phone number"},
    {"name": "phone_number_sid", "type": "string", "required": false, "description": "SID of the Twilio phone number used"},
    {"name": "status", "type": "string", "required": true, "description": "Current call status: queued, ringing, in-progress, completed, busy, failed, no-answer, canceled"},
    {"name": "start_time", "type": "string|null (datetime)", "required": false, "description": "RFC 2822 timestamp when the call began"},
    {"name": "end_time", "type": "string|null (datetime)", "required": false, "description": "RFC 2822 timestamp when the call ended"},
    {"name": "duration", "type": "string|null", "required": false, "description": "Call duration in seconds"},
    {"name": "price", "type": "string|null", "required": false, "description": "Cost of the call"},
    {"name": "price_unit", "type": "string", "required": false, "description": "ISO 4217 currency code"},
    {"name": "direction", "type": "string", "required": false, "description": "inbound or outbound-api"},
    {"name": "answered_by", "type": "string|null", "required": false, "description": "Whether call was answered by human or machine"},
    {"name": "forwarded_from", "type": "string|null", "required": false, "description": "Number the call was forwarded from"},
    {"name": "caller_name", "type": "string|null", "required": false, "description": "Caller name from CNAM lookup"},
    {"name": "api_version", "type": "string", "required": false, "description": "Twilio API version used"},
    {"name": "uri", "type": "string", "required": false, "description": "Relative URI for this resource"}
  ],
  "example": {
    "sid": "CAe1644a7eed5088b159577c5802d8be38",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "to": "+14155551212",
    "from": "+15017122661",
    "status": "completed",
    "direction": "outbound-api",
    "duration": "120",
    "start_time": "Mon, 30 Aug 2010 20:36:28 +0000",
    "end_time": "Mon, 30 Aug 2010 20:38:28 +0000"
  }
}