Twilio Connector Objects
Name | Description |
---|---|
Accounts | Create, update, and query Twilio Accounts belonging to the authenticated Account. |
Applications | Create, update, delete, and query the available Applications in Twilio. |
AvailablePhoneNumbers | Query the local, mobile, and toll-free phone numbers available in Twilio. |
CallEvents | The call events resource provides programmatic access to call progress and SDK events for a provided call SID. |
CallMetrics | The call metrics resource provides an overview of metadata and quality metrics for a provided call. |
Calls | Delete and query connections between phones and Twilio. |
CallSummary | This resource provides an overview of metadata and quality metrics for a single call. |
ConversationMessages | ConversationMessage includes metadata of the Messages sent over a conversation. |
ConversationParticipants | Each participant in a Conversation represents one real (probably human) participant in a Conversation. it joins Participants with the conversation, and the connected person will receive all subsequent messages. |
Conversations | Conversation includes a list of current Participants and the Messages that they have sent amongst each other. |
Feedback | Create and query Feedback on a Call in Twilio. |
FeedbackSummary | Create, delete, and query Feedback Summaries in Twilio. |
IncomingPhoneNumbers | Create, update, delete, and query phone numbers purchased from Twilio. |
IncomingPhoneNumbersCategory | Query Twilio Incoming Phone Numbers and filter by Category. |
Media | Delete and query Media in Twilio. |
Messages | Create, update, delete, and query SMS and MMS Messages in Twilio. |
OutgoingCallerIds | Insert, update, and query the verified numbers that may be used as a caller Id when making outgoing calls in Twilio. |
Recordings | Delete and query the available Recordings in Twilio. |
ServiceLists | Create, update, delete, and query the available Lists for a specific Service in Twilio Sync. |
Services | A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists. |
Transcriptions | Query the available Transcriptions in Twilio. |
Triggers | Create, update, delete, and query usage Triggers in Twilio. |
UsageRecords | Query Usage Records in Twilio. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the account. | |
DateCreated | Datetime | True | No | The creation date of the account. | |
DateUpdated | Datetime | True | No | The modification date of the account. | |
Name | String | False | No | The friendly name of the account. | |
OwnerAccountSid | String | True | No | The master account of the account. | |
AuthToken | String | True | No | The authentication token of the account. | |
Status | String | False | No | The status of the account. Allowed values are closed, suspended, and active. | |
Type | String | True | No | The type of the account. Either Trial or Full. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the application. | |
DateCreated | Datetime | True | No | The creation date of the application. | |
DateUpdated | Datetime | True | No | The modification date of the application. | |
AccountSid | String | True | No | The account Id of the application. | |
Name | String | False | No | The friendly name of the application. | |
ApiVersion | String | True | No | The API version of the application. | |
VoiceUrl | String | False | No | The URL Twilio will request when a phone number assigned to the application receives a call. | |
VoiceFallbackUrl | String | False | No | The URL Twilio will request when an error occurs requesting the voice URL of the application. | |
VoiceFallbackMethod | String | False | No | The HTTP method to use to request the fallback voice URL of the application. | |
StatusCallback | String | False | No | The URL where Twilio will pass status parameters about calls received by phone numbers assigned to the application. | |
StatusCallbackMethod | String | False | No | The HTTP method that Twilio will use to make requests to the status callback URL of the application. | |
VoiceCallerIdLookup | String | False | No | Whether to look up the voice caller Id from the CNAM database for phone numbers assigned to this application. | |
VoiceMethod | String | False | No | The HTTP method Twilio will use to request the voice URL. | |
SmsUrl | String | False | No | The URL Twilio will request when a phone number assigned to the application receives an SMS message. | |
SmsMethod | String | False | No | The HTTP method Twilio will use to request the SMS URL of the application. | |
SmsFallbackUrl | String | False | No | The URL Twilio will request if an error occurs requesting the SMS URL. | |
SmsFallbackMethod | String | False | No | The HTTP method Twilio will use to request the fallback SMS URL of the application. | |
SmsStatusCallback | String | False | No | The URL where Twilio will POST to when an outgoing SMS request uses the Sid of the application. | |
MessageStatusCallback | String | False | No | The URL where status parameters are sent when you insert to the Messages table and specify the Sid of the application. | |
Uri | String | True | No | The URI of the application. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PhoneNumber [KEY] | String | False | No | The phone number available to purchase. It may be used as a pattern to match phone numbers on. Valid characters are '' and [0-9a-zA-Z]. The '' character will match any single digit. | |
Name | String | False | No | The friendly name of the available phone number. | |
Lata | String | False | No | The LATA of the available phone number. | |
RateCenter | String | False | No | The rate center of the available phone number. | |
Latitude | Double | False | No | The latitude of the available phone number. | |
Longitude | Double | False | No | The longitude of the available phone number. | |
Region | String | False | No | The region of the available phone number. | |
PostalCode | String | False | No | The postal code of the available phone number. | |
IsoCountry | String | False | No | The ISO country code in ISO 3166-1 alpha-2 format ('US' for United States, 'CA' for Canada, 'GB' for United Kingdom). | |
AddressRequirements | String | False | No | The address requirements of the available phone number. Eligible values are: none, any, local, or foreign. | |
Beta | Boolean | False | No | Whether the phone number is a beta number new to the Twilio platform. | |
CapabilitiesVoice | Boolean | False | No | Whether the phone number has voice capabilities. | |
CapabilitiesSms | Boolean | False | No | Whether the phone number has SMS capabilities. | |
CapabilitiesMms | Boolean | False | No | Whether the phone number has MMS capabilities. | |
ExcludeAllAddressRequired | Boolean | False | Yes | Indicates whether the response includes phone numbers which require any Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with an Address required. | |
ExcludeLocalAddressRequired | Boolean | False | Yes | Indicates whether the response includes phone numbers which require a local Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a local Address required. | |
ExcludeForeignAddressRequired | Boolean | False | Yes | Indicates whether the response includes phone numbers which require a foreign Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a foreign Address required. | |
AreaCode | String | False | Yes | The area code of the available phone number. | |
Category | String | False | Yes | The category of the available phone number. Possible values are: Local,Mobile,Tollfree. | |
NearNumber | String | False | Yes | Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles. | |
NearLatLong | String | False | Yes | Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles. | |
Distance | String | False | Yes | The search radius for available phone numbers. Default is 25 miles. Max is 500 miles. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CallSid | String | True | Calls.Sid | No | Call SID for the call the events are associated with |
AccountSid | String | True | No | The account SID this call belongs to | |
CarrierEdge | String | True | No | Represents the connection between Twilio and our immediate carrier partners. | |
ClientEdgeMetadataEdgeLocation | String | True | No | Represents the edge location value for Twilio media gateway for Client calls. | |
ClientEdgeMetadataRegion | String | True | No | Represents the edge location value for Twilio media gateway for Client calls. | |
Edge | String | True | No | The edge reporting the event | |
Group | String | True | No | Event group | |
Level | String | True | No | Detail level | |
Name | String | True | No | Event name | |
SdkEdgeMetadataClientName | String | True | No | The Voice SDK client name running locally in the browser or in the application. | |
SdkEdgeMetadataCountryCode | String | True | No | The Voice SDK country_code running locally in the browser or in the application. | |
SdkEdgeMetadataIpAddress | String | True | No | The Voice SDK ip_address running locally in the browser or in the application. | |
SdkEdgeMetadataLocationLat | Double | True | No | The Voice SDK lattitude of location running locally in the browser or in the application. | |
SdkEdgeMetadataLocationLon | Double | True | No | The Voice SDK longitude value of location client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceArch | String | True | No | The Voice SDK device arch of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceModel | String | True | No | The Voice SDK device model of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceType | String | True | No | The Voice SDK device type of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceVendor | String | True | No | The Voice SDK device vendor of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkEdgeLocation | String | True | No | The Voice SDK edge_location running locally in the browser or in the application. | |
SdkEdgeMetadataSdkOSName | String | True | No | The Voice SDK OS name running locally in the browser or in the application. | |
SdkEdgeMetadataSdkOSVersion | String | True | No | The Voice SDK OS version running locally in the browser or in the application. | |
SdkEdgeMetadataSdkPlatform | String | True | No | The Voice SDK platform of the application. | |
SdkEdgeMetadataSdkSelectedRegion | String | True | No | The Voice SDK selected_region of client in the application. | |
SdkEdgeMetadataSdkType | String | True | No | The Voice SDK of the application. | |
SdkEdgeMetadataSdkVersion | String | True | No | The Voice SDK version of the application. | |
SipEdge | String | True | No | Represents the Twilio media gateway for SIP interface and SIP trunking calls. | |
Timestamp | Datetime | True | No | Event time |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CallSid | String | True | Calls.Sid | No | SID for the call |
AccountSid | String | True | No | The account SID this call belongs to | |
CarrierEdgecodec | Integer | True | No | Contains Carrier edge codec value for the Twilio media gateway of a PSTN call | |
CarrierEdgecodec_name | String | True | No | Contains Carrier edge codec_name value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativeJitterAvg | Double | True | No | Contains Carrier edge jitter average value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativeJitterMax | Double | True | No | Contains Carrier edge jitter max value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD300 | Integer | True | No | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD50 | Integer | True | No | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD70 | Integer | True | No | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketsLost | Integer | True | No | Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketsReceived | Integer | True | No | Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsLossPercentage | Integer | True | No | Contains Carrier edge packets_loss_percentage value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsLost | Integer | True | No | Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsReceived | Integer | True | No | Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call | |
CarrierEdgemetadataEdgeLocation | String | True | No | Contains Carrier edge location info for the Twilio media gateway of a PSTN call | |
CarrierEdgemetadataRegion | String | True | No | Contains Carrier edge region info for the Twilio media gateway of a PSTN call | |
ClientEdge | String | True | No | Contains metrics and properties for the Twilio media gateway of a Client call | |
Direction | String | True | No | Defines media stream direction from the perspective of the Twilio Media edge. | |
Edge | String | True | No | Represents the Twilio Media Edge the metric was captured on | |
SdkEdge | String | True | No | Contains metrics and properties for the SDK sensor library for Client calls | |
SipEdge | String | True | No | Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call | |
Timestamp | Datetime | True | No | Timestamp of metric sample. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the call. | |
DateCreated | Datetime | True | No | The creation date of the call. | |
DateUpdated | Datetime | True | No | The modification date of the call. | |
ParentCallSid | String | True | No | The Id of the parent call. | |
AccountSid | String | True | No | The Id of the account that created the call. | |
To | String | True | No | The phone number, SIP address, or client identifier that is called. | |
ToFormatted | String | True | No | The formatted phone number, SIP address, or client identifier that is called. | |
From | String | True | No | The phone number, SIP address, or client identiifer that has made the call. | |
FromFormatted | String | True | No | The formatted number, SIP address, or client identifier that has made the call. | |
PhoneNumberSid | String | True | No | If the call was inbound, the Sid of the IncomingPhoneNumber that received the call. For an outbound call, the Sid of the OutgoingCallerId that made the call. | |
Status | String | True | No | The status of the call. One of the following values: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer. | |
StartTime | Datetime | True | No | The start time of the call. Empty if the call has not yet been dialed. | |
EndTime | Datetime | True | No | The end time of the call. Empty if the call did not complete successfully. | |
Duration | Integer | True | No | The duration of the call. Empty for busy, failed, unanswered, or ongoing calls. | |
Price | Decimal | True | No | The price of the call after the call is completed. | |
Direction | String | True | No | The direction of the call. One of the following values: inbound, outbound-api, or outbound-dial. | |
AnsweredBy | String | True | No | One of the following values if the call was initiated with answering machine detection: human or machine. Empty otherwise. | |
ApiVersion | String | True | No | The API version of the call. | |
ForwardedFrom | String | True | No | The phone number that forwarded an incoming call. Note that the carrier must support forwarding. | |
CallerName | String | True | No | The caller name to a phone number that has Caller Id Lookup enabled. | |
Uri | String | True | No | The URI for the call. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CallSid | String | True | Calls.Sid | No | SID for the call |
AccountSid | String | True | No | The account SID this call belongs to | |
AttributesConferenceParticipant | Boolean | True | No | Contains call-flow specific details | |
CallState | String | True | No | Status of the call | |
CallType | String | True | No | Describes the call type | |
CarrierEdgeMetricsInboundCodec | Integer | True | No | RTP profile number for the media codec for inbound stream | |
CarrierEdgeMetricsInboundCodecName | String | True | No | Name of the media codec for inbound stream | |
CarrierEdgeMetricsInboundJitterAvg | Double | True | No | Average jitter detected for inbound stream | |
CarrierEdgeMetricsInboundJitterMax | Double | True | No | Max jitter detected for inbound stream | |
CarrierEdgeMetricsInboundPacketsLossPercentage | Double | True | No | Percentage of packets lost for inbound stream | |
CarrierEdgeMetricsInboundPacketsLost | Integer | True | No | Count of packets lost for inbound stream | |
CarrierEdgeMetricsInboundPacketsReceived | Integer | True | No | Count of packets received; inbound container only | |
CarrierEdgeMetricsOutBoundCodec | Integer | True | No | RTP profile number for the media codec for outbound stream | |
CarrierEdgeMetricsOutBoundCodecName | String | True | No | Name of the media codec for outbound stream | |
CarrierEdgeMetricsOutBoundJitterAvg | Double | True | No | Average jitter detected for outbound stream | |
CarrierEdgeMetricsOutBoundJitterMax | Double | True | No | Max jitter detected for outbound stream | |
CarrierEdgeMetricsOutBoundPacketDelayVariation | Integer | True | No | Distribution of packets delayed by a certain value | |
CarrierEdgeMetricsOutBoundPacketsLossPercentage | Double | True | No | Percentage of packets lost for outbound stream | |
CarrierEdgeMetricsOutBoundPacketsLost | Integer | True | No | Count of packets lost for outbound stream | |
CarrierEdgeMetricsOutBoundPacketsSent | Integer | True | No | Count of packets sent | |
CarrierEdgePropertiesDirection | String | True | No | Direction of media flow from the perspective of the edge. Inbound or outbound. | |
CarrierEdgePropertiesEdgeLocation | String | True | No | The Twilio edge location where media was handled. | |
CarrierEdgePropertiesMediaRegion | String | True | No | The Twilio region where media was handled. | |
CarrierEdgePropertiesSignalingRegion | String | True | No | The Twilio region where signaling was handled. | |
ClientEdge | String | True | No | Contains metrics and properties for the Twilio media gateway of a Client call | |
ConnectDuration | Integer | True | No | Duration between when the call was answered and when it ended | |
Duration | Integer | True | No | Duration between when the call was initiated and the call was ended | |
EndTime | Datetime | True | No | Call end time | |
FromCaller | String | True | No | The calling party | |
FromCarrier | String | True | No | Serving carrier of destination | |
FromConnection | String | True | No | landline, mobile, voip | |
FromCountryCode | String | True | No | Two-letter ISO country code | |
FromLocationLat | Double | True | No | Lat for number prefix | |
FromLocationLon | Double | True | No | long for number prefix | |
FromNumberPrefix | String | True | No | E.164 country code + three digits | |
ProcessingState | String | True | No | Represents the summarization state of the resource. | |
PropertiesDirection | String | True | No | Contains edge-agnostic call-level details. | |
PropertiesDisconnectedBy | String | True | No | Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party | |
PropertiesQueueTime | String | True | No | Estimated time in milliseconds between when a Programmable Voice call is created and when the call actually begins. | |
PropertiesLastSipResponseNum | Integer | True | No | The numeric value of the last SIP response received for the call | |
PropertiesPddMs | Integer | True | No | Post-dial delay in milliseconds | |
SdkEdgeMetricsInboundAudioInAvg | Double | True | No | Avg level for microphone audio. | |
SdkEdgeMetricsInboundAudioInMax | Double | True | No | Max level for microphone audio. | |
SdkEdgeMetricsInboundAudioOutAvg | Double | True | No | Avg level for speaker audio | |
SdkEdgeMetricsInboundAudioOutMax | Double | True | No | Max level for speaker audio | |
SdkEdgeMetricsInboundJitterAvg | Double | True | No | Average jitter detected | |
SdkEdgeMetricsInboundJitterMax | Double | True | No | Max jitter detected | |
SdkEdgeMetricsInboundMosAvg | Double | True | No | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Average value returned. | |
SdkEdgeMetricsInboundMosMax | Double | True | No | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Max value returned. | |
SdkEdgeMetricsInboundMosMin | Double | True | No | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Min value returned. | |
SdkEdgeMetricsInboundPacketsLossPercentage | Double | True | No | Percentage of packets lost for inbound stream | |
SdkEdgeMetricsInboundPacketsLost | Integer | True | No | Count of packets lost for inbound stream | |
SdkEdgeMetricsInboundPacketsReceived | Integer | True | No | Count of packets received; inbound container only | |
SdkEdgeMetricsInboundRttAvg | Double | True | No | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. Average value returned. | |
SdkEdgeMetricsInboundRttMax | Double | True | No | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. maximum value returned. | |
SdkEdgeMetricsInboundRttMin | Double | True | No | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. minimum value returned. | |
SdkEdgeMetricsOutBoundCodec | Integer | True | No | RTP profile number for the media codec for outbound stream | |
SdkEdgeMetricsOutBoundCodecName | String | True | No | Name of the media codec for outbound stream | |
SdkEdgeMetricsOutBoundPacketsSent | Integer | True | No | Count of packets sent | |
SdkEdgePropertiesAppBuildNumber | String | True | No | Twilio SDK build version | |
SdkEdgePropertiesAppCompileSdkVersion | String | True | No | Twilio SDK version | |
SdkEdgePropertiesAppId | String | True | No | App Id for the Twilio SDK | |
SdkEdgePropertiesAppMinOSVersion | String | True | No | Min Operating system version to the SDK | |
SdkEdgePropertiesAppName | String | True | No | App name for the SDK | |
SdkEdgePropertiesAppTargetOSVersion | String | True | No | Target Operating system version to the SDK | |
SdkEdgePropertiesAppVersion | String | True | No | App version for the SDK | |
SdkEdgePropertiesDirection | String | True | No | Direction of media flow from the perspective of the edge. Inbound or outbound. | |
SdkEdgePropertiesDisconnectedBy | String | True | No | Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party | |
SdkEdgePropertiesEventsGroupsConnection | Integer | True | No | landline, mobile, voip | |
SdkEdgePropertiesEventsGroupsGetUserMedia | Integer | True | No | Get user media count | |
SdkEdgePropertiesEventsGroupsIceConnectionState | Integer | True | No | Event group ice connection state value | |
SdkEdgePropertiesEventsGroupsIceGatheringState | Integer | True | No | Event group ice connection gathering value | |
SdkEdgePropertiesEventsGroupsNetworkInformation | Integer | True | No | Event group network information | |
SdkEdgePropertiesEventsGroupsSignalingState | Integer | True | No | Signalling state of the Event groups | |
SdkEdgePropertiesEventsLevelsDEBUG | Integer | True | No | Count of events by severity-debug for the call. | |
SdkEdgePropertiesEventsLevelsINFO | Integer | True | No | Count of events by severity-info for the call. | |
SdkEdgePropertiesSettingsDscp | Boolean | True | No | Indicates whether DSCP was enabled. | |
SdkEdgePropertiesSettingsIceRestartEnabled | Boolean | True | No | Indicates if ICE restart was enabled. | |
SipEdge | String | True | No | Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call | |
StartTime | Datetime | True | No | Call start time | |
Tags | String | True | No | Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality. | |
ToCallee | String | True | No | The called party | |
ToCarrier | String | True | No | Serving carrier of destination | |
ToConnection | String | True | No | landline, mobile, voip | |
ToCountryCode | String | True | No | Two-letter ISO country code | |
ToLocationLat | Double | True | No | Lat for number prefix | |
ToLocationLon | Double | True | No | Long for number prefix | |
ToNumberPrefix | String | True | No | E.164 country code + three digits | |
TrustBrandedCallBrandSid | String | True | No | Contains trusted communications details including Branded Call and verified caller ID | |
TrustBrandedCallBranded | Boolean | True | No | Boolean. Indicates if branding details were successfully displayed on the destination device. | |
TrustBrandedCallBrandedChannelSid | String | True | No | Branded channel SID. | |
TrustBrandedCallCaller | String | True | No | Caller ID provided. | |
TrustBrandedCallUseCase | String | True | No | Use case for the call. | |
TrustVerifiedCallerVerified | Boolean | True | No | Boolean. Indicates if the caller ID provided has been verified; e.g. SHAKEN/STIR A attestation. | |
Url | String | True | No | The URL of the Voice Insights Summary for this call |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | A 34 character string that uniquely identifies this resource. | |
AccountSid | String | True | No | The unique ID of the Account responsible for this message. | |
ConversationSid | String | True | Conversations.Sid | No | The unique ID of the Conversation for this message. |
AttributesImportance | String | True | No | A string metadata field you can use to store any data you wish. | |
Author | String | True | No | The channel specific identifier of the message's author. | |
Body | String | True | No | The content of the message, can be up to 1,600 characters long. | |
DateCreated | Datetime | True | No | The date that this resource was created. | |
DateUpdated | Datetime | True | No | The date that this resource was last updated. | |
DeliveryDelivered | String | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryFailed | String | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryRead | String | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliverySent | String | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryTotal | Integer | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryUndelivered | String | True | No | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
Index | Integer | True | No | The index of the message within the Conversation. | |
LinksDeliveryReceipts | String | True | No | Contains an absolute API resource URL to access the delivery & read receipts of this message. | |
Media | String | True | No | An array of objects that describe the Message's media. | |
ParticipantSid | String | True | No | The unique ID of messages's author participant. | |
Url | String | True | No | An absolute API resource API URL for this message. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | A 34 character string that uniquely identifies this resource. | |
AccountSid | String | True | No | The unique ID of the Account responsible for this participant. | |
AttributesRole | String | True | No | An optional string metadata field you can use to store any data | |
ConversationSid | String | True | Conversations.Sid | No | The unique ID of the Conversation for this participant. |
DateCreated | Datetime | True | No | The date that this resource was created. | |
DateUpdated | Datetime | True | No | The date that this resource was last updated. | |
Identity | String | True | No | A unique string identifier for the conversation participant as Conversation User. | |
MessagingBindingAddress | String | True | No | Information about how this participant exchanges messages with the conversation. | |
MessagingBindingProxyAddress | String | True | No | Information about how this participant exchanges messages with the conversation. | |
MessagingBindingType | String | True | No | Information about how this participant exchanges messages with the conversation. | |
RoleSid | String | True | No | The SID of a conversation-level Role to assign to the participant. | |
Url | String | True | No | An absolute API resource URL for this participant. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | A 34 character string that uniquely identifies this resource. | |
AccountSid | String | True | No | The unique ID of the Account responsible for this conversation. | |
AttributesTopic | String | True | No | An optional string metadata field you can use to store any data | |
ChatServiceSid | String | True | No | The unique ID of the Conversation Service this conversation belongs to. | |
DateCreated | Datetime | True | No | The date that this resource was created. | |
DateUpdated | Datetime | True | No | The date that this resource was last updated. | |
FriendlyName | String | True | No | The human-readable name of this conversation, limited to 256 characters. Optional. | |
LinksMessages | String | True | No | Contains absolute URLs to access the participants of this conversation. | |
LinksParticipants | String | True | No | Contains absolute URLs to access the participants of this conversation. | |
MessagingServiceSid | String | True | No | The unique ID of the Messaging Service this conversation belongs to. | |
State | String | True | No | Current state of this conversation. | |
TimersDateClosed | Datetime | True | No | Timer date values representing state update for this conversation. | |
TimersDateInactive | Datetime | True | No | Timer date values representing state update for this conversation. | |
UniqueName | String | True | No | An application-defined string that uniquely identifies the resource. | |
Url | String | True | No | An absolute API resource URL for this conversation. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the call. | |
AccountSid | String | True | No | The account Id associated with the feedback. | |
QualityScore | Integer | False | No | The quality score, represented on a scale of 1 (very poor) to 5 (perfect). | |
Issues | String | False | No | Any issues experienced during the call. Allowed values are imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, and one-way-audio. | |
DateCreated | Datetime | True | No | The creation date of the feedback. | |
DateUpdated | Datetime | True | No | The modification date of the feedback. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the feedback summary. | |
StartDate | Date | False | No | The start date of the feedback summary. | |
EndDate | Date | False | No | The end date of the feedback summary. | |
AccountSid | String | True | No | The account Id of the feedback summary. | |
IncludeSubaccounts | Boolean | False | No | Whether to include subaccounts in feedback summary. | |
Status | String | True | No | The status of the feedback summary. One of the following values: queued, in-progress, completed, or failed. | |
CallCount | Integer | True | No | The total call count. | |
CallFeedbackCount | Integer | True | No | The count of calls associated with the feedback summary. | |
QSAverage | Double | True | No | The quality score average of the feedback summary. | |
QSMedian | Double | True | No | The quality score median of the feedback avarage. | |
QSStandardDeviation | Double | True | No | The quality score standard deviation of the feedback summary. | |
IssuesDescription | String | True | No | The issues description of the feedback summary. | |
IssuesCount | Integer | True | No | The issues count of the feedback summary. | |
IssuesPercentageOfTotalCalls | Double | True | No | The percentage of calls that experienced this issue. | |
DateCreated | Datetime | True | No | The creation date of the feedback summary. | |
DateUpdated | Datetime | True | No | The modification date of the feedback summary. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the phone number. | |
AccountSid | String | False | No | The account Id of the phone number. | |
Name | String | False | No | The friendly name of the phone number. By default, this is a formatted phone number. | |
PhoneNumber | String | False | No | The phone number. | |
VoiceUrl | String | False | No | The URL Twilio will request when the phone number receives a call. | |
VoiceMethod | String | False | No | The HTTP method Twilio will use to make the request to the voice URL. | |
VoiceFallbackUrl | String | False | No | The URL Twilio will request when an error occurs requesting the voice URL. | |
VoiceFallbackMethod | String | False | No | The HTTP method to use to request the fallback voice URL. | |
VoiceCallerIdLookup | Boolean | False | No | Whether to look up the caller Id from the CNAM database. | |
DateCreated | Datetime | True | No | The creation date of the phone number. | |
DateUpdated | Datetime | True | No | The modification date of the phone number. | |
SmsUrl | String | False | No | The URL Twilio will request when the phone number receives an SMS message. | |
SmsMethod | String | False | No | The HTTP method Twilio will use to make requests to the SMS URL. | |
SmsFallbackUrl | String | False | No | The URL Twilio will request when an error occurs requesting the SMS URL. | |
SmsFallbackMethod | String | False | No | The HTTP method Twilio will use to request the fallback SMS URL of the phone number. | |
AddressRequirements | String | True | No | The address requirements for the phone number. Eligible values are: none, any, local, or foreign. | |
Beta | String | True | No | Whether the phone number is a beta phone number new to Twilio. | |
CapabilitiesVoice | Boolean | True | No | Whether the phone number supports voice. | |
CapabilitiesSms | Boolean | True | No | Whether the phone number supports SMS. | |
CapabilitiesMms | Boolean | True | No | Whether the phone number supports MMS. | |
StatusCallback | String | False | No | The URL where Twilio will pass status parameters about calls received by the phone number. | |
StatusCallbackMethod | String | False | No | The HTTP method that Twilio will use to make requests to the status callback URL. | |
ApiVersion | String | False | No | The API version of the phone number. | |
VoiceApplicationSid | String | False | No | The voice application Id of the phone number. This can be used in place of the voice URLs. | |
SmsApplicationSid | String | False | No | The SMS application Id of the phone number. This can be used in place of the SMS URLs. | |
TrunkSid | String | False | No | The trunk Id of the phone number. This overrides VoiceApplicationId and the voice URLs. | |
Uri | String | True | No | The URI of the phone number. | |
AreaCode | String | False | Yes | The desired area code for your new incoming phone number. Any three digit, US or Canada area code is valid. This column will work only with INSERT. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the phone number. | |
AccountSid | String | False | No | The account Id of the phone number. | |
Name | String | False | No | The friendly name of the phone number. By default, this is a formatted phone number. | |
PhoneNumber | String | False | No | The phone number in E.164 format. | |
VoiceUrl | String | False | No | The URL Twilio will request when the phone number receives a call. | |
VoiceMethod | String | False | No | The HTTP method Twilio will use to request the voice URL. | |
VoiceFallbackUrl | String | False | No | The URL Twilio will request when an error occurs requesting the voice URL. | |
VoiceFallbackMethod | String | False | No | The HTTP method Twilio will use to request the fallback voice URL. | |
VoiceCallerIdLookup | Boolean | False | No | Whether to look up the caller Id of the caller in the CNAM database. | |
DateCreated | Datetime | False | No | The creation date of the phone number. | |
DateUpdated | Datetime | False | No | The modification date of the phone number. | |
SmsUrl | String | False | No | The URL Twilio will request when someone sends an SMS message to the phone number. | |
SmsMethod | String | False | No | The HTTP method Twilio will use to request the SMS URL of the phone number. | |
SmsFallbackUrl | String | False | No | The URL Twilio will request when an error occurs requesting the SMS URL. | |
SmsFallbackMethod | String | False | No | The HTTP method Twilio will use to request the fallback SMS URL. | |
AddressRequirements | String | False | No | The address requirements of the phone number. | |
Beta | Boolean | False | No | Whether the phone number is a beta phone number new to Twilio. | |
CapabilitiesVoice | Boolean | False | No | Whether the phone number has voice capabilities. | |
CapabilitiesSms | Boolean | False | No | Whether the phone number has SMS capabilities. | |
CapabilitiesMms | Boolean | False | No | Whether the phone number has MMS capabilities. | |
StatusCallback | String | False | No | The URL that Twilio pass status parameters to. | |
StatusCallbackMethod | String | False | No | The HTTP method Twilio will use to make requests to the status callback URL. | |
ApiVersion | String | False | No | The API version of the phone number. | |
VoiceApplicationSid | String | False | No | The voice application Id of the phone number. This can be used in place of the voice URLs. | |
SmsApplicationSid | String | False | No | The SMS application Id of the phone number. This can be used in place of the SMS URLs. | |
TrunkSid | String | False | No | The trunk Id of the phone number. This overrides the Voice_Application_Sid. | |
Uri | String | False | No | The URI of the phone number. | |
Category | String | False | Yes | The category of the phone number. Possible values are local,mobile and tollfree. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the media. | |
AccountSid | String | False | No | The Id of the account associated with the media. | |
ParentSid | String | False | No | The Id of the entity that created the media. | |
ContentType | String | False | No | The MIME type of the media. | |
DateCreated | Datetime | False | No | The creation date of the media. | |
DateUpdated | Datetime | False | No | The modification date of the media. | |
Uri | String | False | No | The URL of the media. | |
MessageSid | String | False | Yes | The message Id of the media. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the messages. | |
DateCreated | Datetime | True | No | The creation date of the message. | |
DateUpdated | Datetime | True | No | The modification date of the message. | |
DateSent | Datetime | True | No | The sent date of the message. | |
AccountSid | String | True | No | The account Id of the message. | |
To | String | False | No | The phone number the message was sent to. | |
Sender | String | False | No | The phone number or sender Id that sent the message. | |
MessagingServiceSid | String | True | No | The messaging service Id of the message. | |
Body | String | False | No | The body of the message. | |
MediaUrl | String | False | No | The URL of the media you wish to send out with the message. | |
Status | String | True | No | The status of the message. One of the following values: accepted, queued, sending, sent, failed, delivered, undelivered, receiving, or received. | |
NumSegments | Integer | True | No | The number of segments that make up the message. | |
NumMedia | Integer | True | No | The number of media files associated with the message. The maximum is 10. | |
Direction | String | True | No | The direction of the message. One of the following values: inbound, outbound-api, outbound-call, or outbound-reply. | |
ApiVersion | String | True | No | The API version of the message. | |
Price | Decimal | True | No | The price of the message. | |
PriceUnit | String | True | No | The currency of the message. | |
ErrorCode | String | True | No | The error code of the message. | |
ErrorMessage | String | True | No | The error message. | |
Uri | String | True | No | The URI of the message. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the outgoing caller Id. | |
AccountSid | String | True | No | The account Id of the outgoing caller Id. | |
DateCreated | Datetime | True | No | The creation date of the outgoing caller Id. | |
DateUpdated | Datetime | True | No | The modfication date of the outgoing caller Id. | |
Name | String | False | No | The friendly name of the outgoing caller Id. By default, this is a formatted phone number. | |
PhoneNumber | String | False | No | The phone number of the outgoing caller Id. | |
Uri | String | True | No | The URI of the outgoing caller Id. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the recording. | |
ApiVersion | String | False | No | The API version of the recording. | |
CallSid | String | False | No | The Id of the call for the recording. | |
DateCreated | Datetime | False | No | The creation date of the recording. | |
DateUpdated | Datetime | False | No | The modification date of the recording. | |
Duration | Double | False | No | The duration of the recording in seconds. | |
AccountSid | String | False | No | The account Id of the recording. | |
Uri | String | False | No | The URI of the recording. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The unique string that identifies the Sync List resource. | |
ServiceSid | String | False | Services.Sid | No | The SID of the Sync Service the resource is associated with. |
AccountSid | String | True | Accounts.Sid | No | The SID of the Account that created the Sync List resource. |
UniqueName | String | False | No | An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. This column will work only with INSERT. | |
Url | String | True | No | The absolute URL of the Sync List resource. | |
Revision | String | True | No | The current revision of the Sync List, represented as a string. | |
DateCreated | Datetime | True | No | The date and time when the resource was created. | |
DateUpdated | Datetime | True | No | The date and time when the resource was last updated. | |
DateExpires | Datetime | True | No | The date and time when the Sync List expires and will be deleted. If the Sync List does not expire, this value is null. The Sync List might not be deleted immediately after it expires. | |
CreatedBy | String | True | No | The identity of the Sync List's creator. If the Sync List was created from inserting into ServiceLists table, the value is system. | |
TimeToLive | Integer | False | No | This column is used only when updating. It specifies how long, in seconds, before the Sync List expires and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is 0, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion. | |
Links | String | True | No | The URLs of the Sync List's nested resources. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The unique string that Twilio's created to identify the Service resource. | |
AccountSid | String | True | Accounts.Sid | No | The SID of the Account that created the Service resource. |
UniqueName | String | True | No | An application-defined string that uniquely identifies the resource. | |
FriendlyName | String | True | No | The string that you assigned to describe the resource. | |
DateCreated | Datetime | True | No | The date and time when the service was created. | |
DateUpdated | Datetime | True | No | The date and time when the service was last updated. | |
Url | String | True | No | The absolute URL of the service. | |
WebhookUrl | String | True | No | The URL that gets called when Sync objects are manipulated. | |
WebhooksFromRestEnabled | Boolean | True | No | Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false. | |
AclEnabled | Boolean | True | No | Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. | |
ReachabilityWebhooksEnabled | Boolean | True | No | Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false. | |
ReachabilityDebouncingEnabled | Boolean | True | No | Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event. | |
ReachabilityDebouncingWindow | Integer | True | No | The reachability event delay in milliseconds if ReachabilityDebouncingEnabled = true. Is between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before WebhookUrl is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring. | |
Links | String | True | No | The URLs of related resources. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | False | No | The Id of the transcription. | |
AccountSid | String | False | No | The account Id of the transcription. | |
ApiVersion | String | False | No | The API version of the transcription. | |
DateCreated | Datetime | False | No | The creation date of the transcription. | |
DateUpdated | Datetime | False | No | The modification date of the transcription. | |
Duration | Integer | False | No | The duration of the transcription in seconds. | |
Price | Decimal | False | No | The price of the transcription. | |
RecordingSid | String | False | No | The recording Id of the transcription. | |
Status | String | False | No | The status of the transcription. One of the following values: in-progress, completed, or failed. | |
TranscriptionText | String | False | No | The transcription text. | |
Type | String | False | No | The type of the transcription. | |
Uri | String | False | No | The URI of the transcription. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Sid [KEY] | String | True | No | The Id of the trigger. | |
AccountSid | String | True | No | The account Id of the trigger. | |
DateCreated | Datetime | True | No | The creation date of the trigger. | |
DateUpdated | Datetime | True | No | The modification date of the trigger. | |
DateFired | Datetime | True | No | The fired date of the trigger. | |
Name | String | False | No | The friendly name of the trigger. | |
UsageCategory | String | False | No | The usage category the trigger watches. For example: calls, sms, phonenumbers, recordings, transcriptions, totalprice. | |
TriggerBy | String | False | No | The usage record field that the trigger is watching. Allowed values: count, usage, and price. | |
Recurring | String | False | No | The recurring interval of the trigger. Allowed values: daily, monthly, and yearly. | |
TriggerValue | Double | False | No | The value of the usage record field that will fire the trigger. | |
CurrentValue | Double | True | No | The current value of the field the trigger is watching. | |
CallbackUrl | String | False | No | The callback URL of the trigger, where Twilio makes a request when the trigger fires. | |
CallbackMethod | String | False | No | The HTTP method to be used to make requests to the callback URL. | |
UsageRecordUri | String | True | No | The URI of the usage record the trigger is watching. | |
Uri | String | True | No | The URI of the trigger. | |
ApiVersion | String | True | No | The API version of the trigger. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
AccountSid | String | False | No | The account Id of the usage record. | |
Category | String | False | No | The category of the usage record. For example, calls, sms, phonenumbers, recordings, transcriptions, and totalprice. | |
Description | String | False | No | The description of the usage record. | |
StartDate | Date | False | No | The start date of the usage record. You can also specify an offset, such as -30days. | |
EndDate | Date | False | No | The end date of the usage record. You can also specify an offset, such as -1year. | |
Count | Integer | False | No | The number of usage events. For example: the number of calls. | |
CountUnit | String | False | No | The type of the usage events counted. For example: calls and messages. | |
Usage | Double | False | No | The amount of usage. | |
UsageUnit | String | False | No | The usage unit. For example: minutes and messages. | |
Price | Decimal | False | No | The total price of the usage. | |
PriceUnit | String | False | No | The currency of the price. | |
ApiVersion | String | False | No | The API version of the usage record. | |
Uri | String | False | No | The URI of the usage record. | |
Interval | String | False | Yes | The interval of records. Should be used as an escaped string in Where clause, i.e [Interval]. The allowed values are Daily, Monthly, Yearly, AllTime, Today, Yesterday, LastMonth, and ThisMonth |