Twilio.Schemas.Call (twilio v0.2.0)

Copy Markdown

Fields

  • account_sid - The SID of the Account that created this Call resource.
  • answered_by - Either human or machine if this call was initiated with answering machine detection. Empty otherwise.
  • api_version - The API version used to create the call.
  • caller_name - The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty.
  • date_created - The date and time in UTC that this resource was created specified in RFC 2822 format.
  • date_updated - The date and time in UTC that this resource was last updated, specified in RFC 2822 format.
  • direction - 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.
  • duration - The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls.
  • end_time - The time the call ended, given as UTC in RFC 2822 format. Empty if the call did not complete successfully.
  • forwarded_from - The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty.
  • from - 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_formatted - 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).
  • group_sid - The Group SID associated with this call. If no Group is associated with the call, the field is empty.
  • parent_call_sid - The SID that identifies the call that created this leg.
  • phone_number_sid - 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.
  • price - 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_unit - The currency in which Price is measured, in ISO 4127 format (e.g., USD, EUR, JPY). Always capitalized for calls.
  • queue_time - The wait time in milliseconds before the call is placed.
  • sid - The unique string that we created to identify this Call resource.
  • start_time - The start time of the call, given as UTC in RFC 2822 format. Empty if the call has not yet been dialed.
  • status
  • stir_verstat - The STIR/SHAKEN verification status of the call, for example TN-Validation-Passed-A. Empty if the incoming call had no STIR/SHAKEN information.
  • subresource_uris - A list of subresources available to this call, identified by their URIs relative to https://api.twilio.com.
  • to - 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_formatted - 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).
  • trunk_sid - 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.
  • uri - The URI of this resource, relative to https://api.twilio.com.

Summary

Types

t()

Functions

decode(json)

Decodes parsed JSON into this struct.

Types

t()

@type t() :: %Twilio.Schemas.Call{
  __extra__: %{optional(String.t()) => term()},
  __present__: [atom()],
  account_sid: String.t() | nil,
  answered_by: String.t() | nil,
  api_version: String.t() | nil,
  caller_name: String.t() | nil,
  date_created: String.t() | nil,
  date_updated: String.t() | nil,
  direction: String.t() | nil,
  duration: String.t() | nil,
  end_time: String.t() | nil,
  forwarded_from: String.t() | nil,
  from: String.t() | nil,
  from_formatted: String.t() | nil,
  group_sid: String.t() | nil,
  parent_call_sid: String.t() | nil,
  phone_number_sid: String.t() | nil,
  price: String.t() | nil,
  price_unit: String.t() | nil,
  queue_time: String.t() | nil,
  sid: String.t() | nil,
  start_time: String.t() | nil,
  status: Twilio.Schemas.CallEnumStatus.t() | nil,
  stir_verstat: String.t() | nil,
  subresource_uris: map() | nil,
  to: String.t() | nil,
  to_formatted: String.t() | nil,
  trunk_sid: String.t() | nil,
  uri: String.t() | nil
}

Functions

decode(json)

@spec decode(term()) :: t() | term()

Decodes parsed JSON into this struct.