Twilio (v1)

sid
STRING

A 34 character string that uniquely identifies this resource.

auth_token
STRING

The authorization token for this account. This token should be kept a secret, so no sharing.

date_created
DATE-TIME

The date that this account was created, in GMT in RFC 2822 format

date_updated
DATE-TIME

The date that this account was last updated, in GMT in RFC 2822 format.

friendly_name
STRING

A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.

owner_account_sid
STRING

The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it’s own sid.

status
STRING

The status of this account. Usually active, but can be suspended or closed.

subresource_uris
ARRAY

Various subresources available for the given Account Instance

type
STRING

The type of this account. Either Trial or Full if it’s been upgraded

uri
STRING

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

account_sid
STRING

A 34 character string that uniquely identifies the account

balance
NUMBER

Remaining account balance

currency
STRING

Currency type

sid
STRING

The unique string that that we created to identify the Address resource.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that is responsible for the Address resource

city
STRING

The city in which the address is located.

customer_name
STRING

The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

emergency_enabled
BOOLEAN

Whether emergency calling has been enabled on this number.

friendly_name
STRING

The string that you assigned to describe the resource.

iso_country
STRING

The ISO country code of the address.

postal_code
STRING

The postal code of the address.

region
STRING

The state or region of the address.

street
STRING

The number and street address of the address.

uri
STRING

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

validated
BOOLEAN

Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been validated. false indicate the country doesn’t require validation or the Address is not valid.

verified
BOOLEAN

Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. true indicates the Address has been verified. false indicate the country doesn’t require verified or the Address is not valid.

sid
STRING

The unique string that we created to identify the Alert resource.

date_updated
DATE-TIME

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

account_sid
STRING

The SID of the Account that created the Alert resource.

alert_text
STRING

The text of the alert.

api_version
STRING

The API version used when the alert was generated. Can be empty for events that don’t have a specific API version.

date_created
DATE-TIME

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_generated
DATE-TIME

The date and time in GMT when the alert was generated specified in ISO 8601 format. Due to buffering, this can be different than date_created.

error_code
STRING

The error code for the condition that generated the alert. See the Error Dictionary for possible causes and solutions to the error.

log_level
STRING

The log level. Can be: error, warning, notice, or debug.

more_info
STRING

The URL of the page in our Error Dictionary with more information about the error condition.

request_method
STRING

The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used.

request_url
STRING

The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested.

resource_sid
STRING

The SID of the resource for which the alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this value would be the SID of the server. This value is empty if the alert was not generated for a particular resource.

service_sid
STRING

The SID of the service or resource that generated the alert. Can be null.

url
STRING

The absolute URL of the Alert resource.

sid
STRING

The unique string that that we created to identify the Application resource.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that created the Application resources to read.

api_version
STRING

The API version used to start a new TwiML session.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

friendly_name
STRING

The string that you assigned to describe the resource.

message_status_callback
STRING

The URL we call using a POST method to send message status information to your application.

sms_fallback_method
STRING

The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

sms_fallback_url
STRING

The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.

sms_method
STRING

The HTTP method we use to call sms_url. Can be: GET or POST.

sms_status_callback
STRING

The URL we call using a POST method to send status information to your application about SMS messages that refer to the application.

sms_url
STRING

The URL we call when the phone number receives an incoming SMS message.

status_callback
STRING

The URL we call using the status_callback_method to send status information to your application.

status_callback_method
STRING

The HTTP method we use to call status_callback. Can be: GET or POST.

uri
STRING

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

voice_callback_id_lookup
BOOLEAN

Whether we look up the caller’s caller-ID name from the CNAM database (additional charges apply). Can be: true or false.

voice_fallback_method
STRING

The HTTP method we use to call voice_fallback_url. Can be: GET or POST

voice_fallback_url
STRING

The URL that we call when an error occurs retrieving or executing the TwiML requested by url.

voice_method
STRING

The HTTP method we use to call voice_url. Can be: GET or POST.

voice_url
STRING

The URL we call when the phone number assigned to this application receives a call.

iso_country
STRING

The ISO country code of this phone number.

phone_number
STRING

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

address_requirements
STRING

The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

beta
BOOLEAN

Whether the phone number is new to the Twilio platform. Can be: true or false.

capabilities
OBJECT

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

friendly_name
STRING

A formatted version of the phone number.

lata
STRING

The LATA of this phone number. Available for only phone numbers from the US and Canada.

latitude
STRING

The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.

locality
STRING

The locality or city of this phone number’s location.

longitude
STRING

The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.

postal_code
STRING

The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada.

rate_center
STRING

The rate center of this phone number. Available for only phone numbers from the US and Canada.

region
STRING

The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada.

iso_country
STRING

The ISO country code of this phone number.

phone_number
STRING

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

address_requirements
STRING

The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

beta
BOOLEAN

Whether the phone number is new to the Twilio platform. Can be: true or false.

capabilities
OBJECT

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

friendly_name
STRING

A formatted version of the phone number.

lata
STRING

The LATA of this phone number. Available for only phone numbers from the US and Canada.

latitude
STRING

The latitude of this phone number’s location. Available for only phone numbers from the US and Canada.

locality
STRING

The locality or city of this phone number’s location.

longitude
STRING

The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.

postal_code
STRING

The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada.

rate_center
STRING

The rate center of this phone number. Available for only phone numbers from the US and Canada.

region
STRING

The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada.

iso_country
STRING

The ISO country code of this phone number.

phone_number
STRING

The phone number in E.164 format, which consists of a + followed by the country code and subscriber number.

address_requirements
STRING

The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

beta
BOOLEAN

Whether the phone number is new to the Twilio platform. Can be: true or false.

capabilities
OBJECT

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

friendly_name
STRING

A formatted version of the phone number.

lata
STRING

The LATA of this phone number. Available for only phone numbers from the US and Canada.

latitude
STRING

The latitude of this phone number’s location. Available for only phone numbers from the US and Canada.

locality
STRING

The locality or city of this phone number’s location.

longitude
STRING

The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.

postal_code
STRING

The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada.

rate_center
STRING

The rate center of this phone number. Available for only phone numbers from the US and Canada.

region
STRING

The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada.

country_code
STRING

The ISO-3166-1 country code of the country.

beta
BOOLEAN

Whether all phone numbers available in the country are new to the Twilio platform. true if they are and false if all numbers are not in the Twilio Phone Number Beta program.

country
STRING

The name of the country.

subresource_uris
ARRAY

A list of related AvailablePhoneNumber resources identified by their URIs relative to https://api.twilio.com

uri
STRING

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

sid
STRING

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

date_updated
DATE-TIME

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

account_sid
STRING

The SID of the Account that created this Call resource.

annotation
STRING

answered_by
STRING

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

api_version
STRING

The API version used to create the call.

caller_name
STRING

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

date_created
DATE-TIME

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

direction
STRING

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 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
INTEGER

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

end_time
DATE-TIME

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

forwarded_from
STRING

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

from
STRING

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
STRING

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
STRING

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

parent_call_sid
STRING

The SID that identifies the call that created this leg.

phone_number_sid
STRING

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
NUMBER

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

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

queue_time
INTEGER

The wait time in milliseconds before the call is placed.

start_time
DATE-TIME

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

status
STRING

The status of this call. Can be: queued, ringing, in-progress, canceled, completed, failed, busy or no-answer

subresource_uris
ARRAY

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

to
STRING

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
STRING

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
STRING

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
STRING

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

sid
STRING

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

date_updated
DATE-TIME

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

account_sid
STRING

The SID of the Account that created this Conference resource.

api_version
STRING

The API version used to create this conference.

call_sid_ending_conference
STRING

The call SID that caused the conference to end.

date_created
DATE-TIME

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

friendly_name
STRING

A string that you assigned to describe this conference room. Maxiumum length is 128 characters.

reason_conference_ended
STRING

The reason why a conference ended. When a conference is in progress, will be null. When conference is completed, can be: conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left.

region
STRING

A string that represents the Twilio Region where the conference audio was mixed. May be us1, ie1, de1, sg1, br1, au1, and jp1. Basic conference audio will always be mixed in us1. Global Conference audio will be mixed nearest to the majority of participants.

status
STRING

The status of this conference. Can be: init, in-progress, or completed.

subresource_uris
ARRAY

A list of related resources identified by their URIs relative to https://api.twilio.com.

uri
STRING

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

uri
STRING

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

account_sid
STRING

The SID of the Account that created the Participant resource.

call_sid
STRING

The SID of the Call the Participant resource is associated with.

call_sid_to_coach
STRING

The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.

coaching
BOOLEAN

Whether the participant is coaching another call. Can be: true or false. If not present, defaults to false unless call_sid_to_coach is defined. If true, call_sid_to_coach must be defined.

conference_sid
STRING

The SID of the conference the participant is in.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

end_conference_on_exit
BOOLEAN

Whether the conference ends when the participant leaves. Can be: true or false and the default is false. If true, the conference ends and all other participants drop out when the participant leaves.

hold
BOOLEAN

Whether the participant is on hold. Can be true or false.

label
STRING

The user-specified label of this participant, if one was given when the participant was created. This may be used to fetch, update or delete the participant.

muted
BOOLEAN

Whether the participant is muted. Can be true or false.

start_conference_on_enter
BOOLEAN

Whether the conference starts when the participant joins the conference, if it has not already started. Can be: true or false and the default is true. If false and the conference has not started, the participant is muted and hears background music until another participant starts the conference.

status
STRING

The status of the participant’s call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.

sid
STRING

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

account_sid
STRING

The SID of the Account that is responsible for the Address resource.

address_requirements
STRING

The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

api_version
STRING

The API version used to create this conference.

capabilities
OBJECT

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

emergency_address_sid
STRING

The SID of the emergency address configuration that we use for emergency calling from this phone number.

emergency_status
STRING

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

friendly_name
STRING

A string that identifies the IncomingPhoneNumber resources to read.

phone_number
STRING

The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

sms_application_sid
STRING

The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.

sms_fallback_method
STRING

The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

sms_fallback_url
STRING

The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.

sms_method
STRING

The HTTP method we use to call sms_url. Can be: GET or POST.

sms_url
STRING

The URL we call when the phone number receives an incoming SMS message.

status_callback
STRING

The URL we call using the status_callback_method to send status information to your application.

status_callback_method
STRING

The HTTP method we use to call status_callback. Can be: GET or POST.

trunk_sid
STRING

The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

uri
STRING

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

voice_application_sid
STRING

The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

voice_caller_id_lookup
BOOLEAN

Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

voice_fallback_method
STRING

The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

voice_fallback_url
STRING

The URL that we call when an error occurs retrieving or executing the TwiML requested by url.

voice_method
STRING

The HTTP method we use to call voice_url. Can be: GET or POST.

voice_url
STRING

The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

sid
STRING

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

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that created the IncomingPhoneNumber resources to read.

address_requirements
STRING

The type of Address resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

address_sid
STRING

The SID of the Address resource associated with the phone number.

api_version
STRING

The API version used to start a new TwiML session.

beta
BOOLEAN

Whether to include phone numbers new to the Twilio platform. Can be: true or false and the default is true.

bundle_sid
STRING

The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.

capabilities
OBJECT

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, MMS, and fax and each capability can be: true or false.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

emergency_address_sid
STRING

The SID of the emergency address configuration that we use for emergency calling from this phone number.

emergency_address_status
STRING

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

emergency_status
STRING

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

friendly_name
STRING

A string that identifies the IncomingPhoneNumber resources to read.

identity_sid
STRING

The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.

origin
STRING

Whether to include phone numbers based on their origin. Can be: twilio or hosted. By default, phone numbers of all origin are included.

phone_number
STRING

The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use ‘*’ as a wildcard for any digit.

sms_application_sid
STRING

The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all sms_*_url values and use those of the application.

sms_fallback_method
STRING

The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

sms_fallback_url
STRING

The URL that we call when an error occurs while retrieving or executing the TwiML from sms_url.

sms_method
STRING

The HTTP method we use to call sms_url. Can be: GET or POST.

sms_url
STRING

The URL we call when the phone number receives an incoming SMS message.

status
STRING

Status of phone number

status_callback
STRING

The URL we call using the status_callback_method to send status information to your application.

status_callback_method
STRING

The HTTP method we use to call status_callback. Can be: GET or POST.

trunk_sid
STRING

The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

uri
STRING

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

voice_application_sid
STRING

The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

voice_caller_id_lookup
BOOLEAN

Whether we look up the caller’s caller-ID name from the CNAM database ($0.01 per look up). Can be: true or false.

voice_fallback_method
STRING

The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

voice_fallback_url
STRING

The URL that we call when an error occurs retrieving or executing the TwiML requested by url.

voice_method
STRING

The HTTP method we use to call voice_url. Can be: GET or POST.

voice_receive_mode
STRING

voice_url
STRING

The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

sid
STRING

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

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that created the Key resources to update.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

friendly_name
STRING

A descriptive string that you create to describe the resource. It can be up to 64 characters long.

sid
STRING

The unique string that that we created to identify the Message resource.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that sent the message that created the resource.

api_version
STRING

The API version used to process the message.

body
STRING

The message text. Can be up to 1,600 characters long.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_sent
DATE-TIME

The date and time in GMT that the resource was sent specified in RFC 2822 format. For outgoing messages, this is when we sent the message. For incoming messages, this is when we made the HTTP request to your application.

direction
STRING

The direction of the message. Can be: inbound for incoming messages, outbound-api for messages initiated by a REST API, outbound-call for messages initiated during a call, or outbound-reply for messages initiated in response to an incoming message.

error_code
STRING

The error code returned if your message status is failed or undelivered. The error_code provides more information about the failure. If the message was successful, this value is null.

error_message
STRING

The description of the error_code if your message status is failed or undelivered. If the message was successful, this value is null.

from
STRING

The phone number (in E.164 format), alphanumeric sender ID, or Wireless SIM that initiated the message. For incoming messages, this will be the number of the sending phone. For outgoing messages, this value will be one of your Twilio phone numbers or the alphanumeric sender ID used.

messaging_service_sid
STRING

The SID of the Messaging Service used with the message. The value is null if a Messaging Service was not used.

num_media
INTEGER

The number of media files associated with the message. A message can send up to 10 media files.

num_segments
INTEGER

The number of segments that make up the complete message. A message body that is too large to be sent in a single SMS message is segmented and charged as multiple messages. Inbound messages over 160 characters are reassembled when the message is received. Note: When using a Messaging Service to send messages, num_segments will always be 0 in Twilio’s response to your API request.

price
NUMBER

The amount billed for the message, in the currency specified by price_unit. Note that your account is charged for each segment we send to the handset. Populated after the message has been sent. May not be immediately available.

price_unit
NUMBER

The currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy).

status
STRING

The status of the message. Can be: accepted, scheduled, canceled, queued, sending, sent, failed, delivered, undelivered, receiving, received, or read (WhatsApp only).

subresource_uris
ARRAY

to
STRING

The phone number in E.164 format that received the message. For incoming messages, this will be one of your Twilio phone numbers. For outgoing messages, this will be the sending phone.

uri
STRING

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

sid
STRING

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

account_sid
STRING

The SID of the Account that created this Media resource.

content_type
STRING

The default mime-type of the media, for example image/jpeg, image/png, or image/gif

date_created
DATE-TIME

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

date_updated
DATE-TIME

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

parent_sid
STRING

The SID of the resource that created the media.

uri
STRING

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

sid
STRING

A 34 character string that uniquely identifies this resource.

date_updated
DATE-TIME

The date that this resource was last updated, given in RFC 2822 format.

account_sid
STRING

The unique ID of the Account responsible for this Caller Id.

date_created
DATE-TIME

The date that this resource was created, given in RFC 2822 format.

friendly_name
STRING

A human readable descriptive text for this resource, up to 64 characters long. By default, the FriendlyName is a nicely formatted version of the phone number.

phone_number
STRING

The incoming phone number. Formatted with a ‘+’ and country code e.g., +16175551212 (E.164 format).

uri
STRING

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

sid
STRING

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

date_updated
DATE-TIME

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

account_sid
STRING

The SID of the Account that created this Queue resource.

average_wait_time
INTEGER

The average wait time in seconds of the members in this queue. This is calculated at the time of the request.

current_size
INTEGER

The number of calls currently in the queue.

date_created
DATE-TIME

friendly_name
STRING

A string that you assigned to describe this resource.

max_size
INTEGER

The maximum number of calls that can be in the queue. The default is 1000 and the maximum is 5000.

subresource_uris
ARRAY

A list of related resources identified by their URIs relative to https://api.twilio.com.

uri
STRING

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

sid
STRING

The unique string that that we created to identify the Recording resource.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that created the Recording resource.

api_version
STRING

The API version used during the recording.

call_sid
STRING

The SID of the Call the Recording resource is associated with. This will always refer to the parent leg of a two-leg call.

channels
INTEGER

The number of channels in the final recording file. Can be: 1 or 2. You can split a call with two legs into two separate recording channels if you record using TwiML Dial or the Outbound Rest API.

conference_sid
STRING

The Conference SID that identifies the conference associated with the recording, if a conference recording.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

duration
INTEGER

The length of the recording in seconds.

encryption_details
OBJECT

How to decrypt the recording if it was encrypted using Call Recording Encryption feature.

error_code
STRING

The error code that describes why the recording is absent. The error code is described in our Error Dictionary. This value is null if the recording status is not absent.

price
NUMBER

The one-time cost of creating the recording in the price_unit currency.

price_unit
STRING

The currency used in the price property. Example: USD.

source
STRING

How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, and StartConferenceRecordingAPI.

start_time
DATE-TIME

The start time of the recording in GMT and in RFC 2822 format.

status
STRING

he status of the recording. Can be: processing, completed, absent or deleted.

subresource_uris
ARRAY

A list of related resources identified by their relative URIs.

uri
STRING

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

sid
STRING

The unique string that that we created to identify the Transcription resource.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that created the Transcription resource.

api_version
STRING

The API version used to create the transcription.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

duration
INTEGER

The duration of the transcribed audio in seconds.

price
NUMBER

The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately.

price_unit
STRING

The currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy).

recording_sid
STRING

The SID of the Recording from which the transcription was created.

status
STRING

The status of the transcription. Can be: in-progress, completed, failed

transcription_text
STRING

The text content of the transcription.

type
STRING

The transcription type. Can only be: fast.

uri
STRING

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

account_sid
STRING

The SID of the Account that accrued the usage.

category
STRING

The category of usage.

start_date
DATE-TIME

The first date for which usage is included in this UsageRecord. The date is specified in GMT and formatted as YYYY-MM-DD.

api_version
STRING

The API version used to create the resource.

as_of
DATE-TIME

Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00. All timestamps are in GMT

count
STRING, INTEGER

The number of usage events, such as the number of calls.

count_unit
STRING

The units in which count is measured, such as calls for calls or messages for SMS.

description
STRING

A plain-language description of the usage category.

end_date
DATE-TIME

The last date for which usage is included in the UsageRecord. The date is specified in GMT and formatted as YYYY-MM-DD.

price
NUMBER

The total price of the usage in the currency specified in price_unit and associated with the account.

price_unit
STRING

The currency in which price is measured, in ISO 4127 format, such as usd, eur, and jpy.

subresource_uris
ARRAY

A list of related resources identified by their URIs.

uri
STRING

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

usage
NUMBER, STRING

The amount used to bill usage and measured in units described in usage_unit.

usage_unit
STRING

The units in which usage is measured, such as minutes for calls or messages for SMS.

sid
STRING

The unique string that that we created to identify the UsageTrigger resource.

date_updated
DATE-TIME

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

account_sid
STRING

The SID of the Account that the trigger monitors.

api_version
STRING

The API version used to create the resource.

callback_method
STRING

The HTTP method we use to call callback_url. Can be: GET or POST.

callback_url
STRING

The URL we call using the callback_method when the trigger fires.

current_value
NUMBER

The current value of the field the trigger is watching.

date_created
DATE-TIME

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_fired
DATE-TIME

The date and time in GMT that the trigger was last fired specified in RFC 2822 format.

friendly_name
STRING

The string that you assigned to describe the trigger.

recurring
STRING

The frequency of a recurring UsageTrigger. Can be: daily, monthly, or yearly for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.

trigger_by
STRING

The field in the UsageRecord resource that fires the trigger. Can be: count, usage, or price.

trigger_value
NUMBER

The value at which the trigger will fire. Must be a positive, numeric value.

uri
STRING

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

usage_category
STRING

The usage category the trigger watches.

usage_record_uri
STRING

The URI of the UsageRecord resource this trigger watches, relative to https://api.twilio.com.