Cloud

Build 26.0.9770
  • Twilio
    • Getting Started
      • Establishing a Connection
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Accounts
        • Addresses
        • Applications
        • ByocTrunk
        • CallAnnotation
        • Calls
        • ConferenceParticipants
        • Conferences
        • ConnectionPolicy
        • ConnectionPolicyTarget
        • ContentTemplates
        • IncomingPhoneNumbers
        • IpRecord
        • Media
        • Messages
        • OutgoingCallerIds
        • QueueMembers
        • Queues
        • RealTimeTranscriptionForVideo
        • Recordings
        • Rooms
        • ServiceLists
        • Services
        • SIPCredential
        • SIPCredentialList
        • SIPCredentialListMapping
        • SIPDomain
        • SIPDomainRegistrationCredentialListMapping
        • SIPIpAccessControlList
        • SIPIpAccessControlListMapping
        • SIPIpAddress
        • SourceIpMapping
        • Transcriptions
        • Triggers
        • VerificationServices
        • VoiceInsightsSettings
      • Views
        • Alerts
        • AvailableNumbers
        • AvailablePhoneNumbers
        • CallEvents
        • CallMetrics
        • CallSummary
        • ConferenceParticipantsSummary
        • ConferenceSummary
        • ConversationMessages
        • ConversationParticipants
        • Conversations
        • Events
        • OutboundPhoneNumberReport
        • PricingPhoneNumbers
        • UsageRecords
      • Stored Procedures
        • AddOutgoingCallerIds
        • AddParticipants
        • AddRecording
        • DownloadMedia
        • GenerateOutboundPhoneNumberReport
        • ModifyParticipants
        • SendMessage
        • UpdateRecording
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • AuthScheme
        • AccountSID
        • AuthToken
        • APIKeySID
        • APIKeySecret
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

Twilio - CData Cloud

Overview

CData Cloud offers access to Twilio across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Twilio through CData Cloud.

CData Cloud allows you to standardize and configure connections to Twilio as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: Twilio appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to Twilio in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Twilio

Establishing a Connection shows how to authenticate to Twilio and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Twilio through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to Twilio by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Twilio

You can authenticate to Twilio using any of the following authentication methods: Auth Token, API Key, or OAuth Client.

Auth Token

To authenticate to Twilio using an Auth Token and an Account SID:

Open the Twilio Console Dashboard, navigate to the Account Info section, and set these connection properties:

  • AccountSID: The value of the Account SID field.
  • AuthToken: The value of the Auth Token field. Click Show to unhide it.

API Key

To authenticate to Twilio using an API key:

  1. Open the Twilio Console Dashboard and click Account Info > API Keys > Go to API Keys. The API keys & tokens page opens.
  2. Click Create API key. The Create new API key menu opens.
    • Set Friendly name to a name you want to use to refer to the token.
    • Set Region to the region in which you want the API key to apply.
    • Set Key type to your desired key type. The options include:
      • Standard - Grants access to all Twilio API features except for managing API Keys, Account Configuration, and Subaccounts.
      • Main - Grants access to the same features as the Standard key type, with the added ability to manage API Keys, Account Configuration, and Subaccounts.
      • Restricted - Allows granular access to a subset of the Twilio API features that the standard APIKey grants. If you select this option, you must manually specify the permissions that the token grants.
  3. Click Create. This opens the Copy secret key page.
  4. Note the values of the SID and Secret fields. The latter is only shown once, so make sure you copy it before leaving this page.
  5. Set the following connection properties:
    • AuthScheme: APIKey.
    • AccountSID: The value of the Account SID field in the Account Info section of the Twilio Console Dashboard.
    • APIKeySID: The SID of the API key you generated earlier, which you noted in step 4.
    • APIKeySecret: The API key secret of the API key you generated earlier, which you noted in step 4.

OAuth Client

Twilio supports OAuth authentication using the Client Credentials grant flow.

Before connecting, you must create a custom OAuth application, and define the required scopes. See Creating a Custom OAuth Application for instructions.

Then, set the following properties to connect:

  • AuthScheme: OAuthClient.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret assigned when you registered your application.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

Data Model

The CData Cloud models the Twilio API as relational tables and views. These are defined in schema files, which are simple, text-based configuration files.

The Cloud uses the Twilio API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Tables

The Cloud models the data in tables so that it can be easily queried and updated with standard SQL.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces that you invoke with SQL queries. They perform tasks beyond standard create, read, update, and delete (CRUD) operations, such as sending messages, downloading media, managing call recordings, and managing conference participants.

CData Cloud

Tables

The Cloud models the data in Twilio as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Twilio Tables

Name Description
Accounts Create, update, and query Twilio Accounts belonging to the authenticated Account.
Addresses An Address resource represents a physical address that can be used with Twilio phone numbers.
Applications Create, update, delete, and query the available Applications in Twilio.
ByocTrunk A ByocTrunk resource describes a trunk that can be configured to send and receive voice traffic to and from a PSTN Carrier via Bring Your Own Carrier (BYOC).
CallAnnotation Fetch and update the Annotation for a specific call.
Calls Create, query, update, and delete calls between phones and Twilio.
ConferenceParticipants Lists all the participants in an active conference.
Conferences The Conferences resource allows you to query and manage the state of conferences on your Twilio account.
ConnectionPolicy A ConnectionPolicy resource describes a set of routing rules for outbound calls made using Twilio's BYOC feature.
ConnectionPolicyTarget A ConnectionPolicyTarget resource describes a destination for voice traffic for a Connection Policy.
ContentTemplates Create, update, delete, and query Content templates in Twilio.
IncomingPhoneNumbers Create, update, delete, and query phone numbers purchased from Twilio.
IpRecord An IpRecord resource represents a static IP address used to address the BYOC Trunk's Termination SIP Domain via an IP address instead of an FQDN (Fully Qualified Domain Name).
Media Delete and query Media in Twilio.
Messages Create, update, delete, and query SMS and MMS Messages in Twilio.
OutgoingCallerIds Represents verified phone numbers that can be used as a caller Id when making outgoing calls.
QueueMembers Members is a subresource of Queues and represents a single call in a call queue.
Queues A Queue resource describes a call queue that contains individual calls.
RealTimeTranscriptionForVideo A RealTimeTranscriptionForVideo resource represents the configuration and state of real-time speech-to-text transcriptions for a Video Room.
Recordings Delete and query the available Recordings in Twilio.
Rooms A Room resource represents a Programmable Video communication session among multiple endpoints using Twilio's Video SDKs. When listing Rooms, the API returns only Rooms with a status of in-progress.
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.
SIPCredential A SIP Credential resource represents a username and password used to authenticate SIP Endpoints to a SIP Domain.
SIPCredentialList A SIP CredentialList resource manages lists of users authorized to access a SIP Domain. Each CredentialList can contain up to 1,000 Credential resources.
SIPCredentialListMapping A SIP CredentialListMapping resource associates a CredentialList with a SIP Domain for call authentication. Requests to the domain are challenged and authenticated against the mapped credential lists.
SIPDomain A SIP Domain resource describes a custom DNS hostname that can accept SIP traffic for your account. SIP requests to the domain are routed to Twilio and authenticated before TwiML is requested.
SIPDomainRegistrationCredentialListMapping A SIP Domain Registration CredentialListMapping resource links CredentialLists to a SIP Domain for registration authentication. Incoming SIP registrations are challenged and must match credentials in a mapped list.
SIPIpAccessControlList A SIP IpAccessControlList resource contains IP addresses authorized to access a SIP Domain. Each account can have up to 1,000 IpAccessControlList resources, each containing up to 100 IP address entries.
SIPIpAccessControlListMapping A SIP IpAccessControlListMapping resource associates an IpAccessControlList with a SIP Domain for call authentication. Incoming SIP INVITE requests must originate from an IP address in a mapped access control list.
SIPIpAddress A SIP IpAddress resource represents an IP address entry within an IpAccessControlList. SIP requests from allowed IP addresses are permitted access to the associated SIP Domain. Each IpAccessControlList can contain up to 100 IP address entries.
SourceIpMapping A SourceIpMapping resource associates an IP Record with a SIP Domain, allowing you to control which IP addresses are allowed to send traffic to your SIP infrastructure.
Transcriptions Query the available Transcriptions in Twilio.
Triggers Create, update, delete, and query usage Triggers in Twilio.
VerificationServices A Verification Service is the set of common configurations used to create and check verifications.
VoiceInsightsSettings Query and update the Voice Insights monitoring configuration for an account.

CData Cloud

Accounts

Create, update, and query Twilio Accounts belonging to the authenticated Account.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Name=
Status=
Sid=

For example, the following queries are processed server-side:

SELECT * FROM Accounts WHERE Name = 'test' AND Status = 'suspended'

INSERT

To add an Account, specify the Name field.

INSERT INTO Accounts (Name) VALUES ('test1')

UPDATE

Twilio allows updates for the Name and Status columns.

UPDATE Accounts SET Status = 'closed' WHERE Sid = 'X123456789'

DELETE

Twilio does not allow Accounts to be deleted.

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the account.

DateCreated Datetime True

The creation date of the account.

DateUpdated Datetime True

The modification date of the account.

Name String False

The friendly name of the account.

OwnerAccountSid String True

The master account of the account.

AuthToken String True

The authentication token of the account.

Status String False

The status of the account. Allowed values are closed, suspended, and active.

The allowed values are closed, suspended, active.

The default value is active.

Type String True

The type of the account. Either Trial or Full.

SubresourceUris String True

The subresources available for the given account.

ItemURL String True

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

CData Cloud

Addresses

An Address resource represents a physical address that can be used with Twilio phone numbers.

Table-Specific Information

SELECT

Returns a list of Address resource representations, each representing an address within your account.

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
CustomerName=
Name=
EmergencyEnabled=
IsoCountry=

For example, the following queries are processed server-side:

SELECT * FROM Addresses;
SELECT * FROM Addresses WHERE Sid = 'X123456789'

INSERT

To add an Address, you must specify the following parameters: CustomerName, Street, City, Region, PostalCode, and IsoCountry.

INSERT INTO Addresses (Name, customername, street, city, region, postalcode, isocountry) VALUES ('Sample Address', 'twilio',  'ChapelHill', 'SF', 'CA','94019', 'US')

UPDATE

The following columns can be updated: Name, CustomerName, Street, City, Region, PostalCode, EmergencyEnabled, AutoCorrectAddress, StreetSecondary

UPDATE Addresses SET NAME = 'CustomerAddress' WHERE sid='AD46c6bd5385d1c58e51163f1488247d74' 

DELETE


DELETE FROM Addresses WHERE Sid = 'AD46c6bd5385d1c58e51163f1488247d74'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that Twilio created to identify this Address resource.

AccountSid String True

The Account SID that created this Address resource.

Name String False

A human-readable name for the address.

CustomerName String False

The name of the customer associated with the address.

Street String False

The street address.

City String False

The city of the address.

Region String False

The state or region of the address.

PostalCode String False

The postal or ZIP code.

IsoCountry String False

The ISO country code (e.g., US, IN).

EmergencyEnabled Boolean False

Whether the address is enabled for emergency services.

DateCreated Datetime True

The date and time when the address was created.

DateUpdated Datetime True

The date and time when the address was last updated.

Uri String True

The URI of this Address resource.

StreetSecondary String False

The additional number and street address of the address.

Verified Boolean True

Whether the address has been verified to comply with regulation.

Validated Boolean True

Whether the address has been validated to comply with local regulation.

CData Cloud

Applications

Create, update, delete, and query the available Applications in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Name supports the = operator.
  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Applications WHERE Sid = 'X123456789'

INSERT

To add an Application, specify at least the Name.

INSERT INTO Applications (Name, VoiceUrl, VoiceFallbackUrl, VoiceFallbackMethod, StatusCallback, StatusCallbackMethod, VoiceCallerIdLookup,
SmsUrl, SmsMethod, SmsFallbackUrl, SmsStatusCallback, MessageStatusCallback) VALUES ('app7', 'http://demo.twilio.com/docs/voiceUrl.xml', 'http://demo.twilio.com/docs/voiceFallback.xml', 'POST', 'http://demo.twilio.com/docs/statusCallback.xml', 'POST', true, 'http://demo.twilio.com/docs/smsFallback.xml', 'POST', 'http://demo.twilio.com/docs/smsFallback.xml', 'http://demo.twilio.com/docs/smsStatusCallback.xml', 'http://demo.twilio.com/docs/voiceUrl.xml')

UPDATE


UPDATE Applications SET Name = 'appp8' WHERE Sid = 'ACab6788889df1432ae'

DELETE


DELETE FROM Applications WHERE Sid = 'ACab6788889df1432ae'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the application.

DateCreated Datetime True

The creation date of the application.

DateUpdated Datetime True

The modification date of the application.

AccountSid String True

The account Id of the application.

Name String False

The friendly name of the application.

ApiVersion String False

The API version of the application.

VoiceUrl String False

The URL Twilio will request when a phone number assigned to the application receives a call.

VoiceFallbackUrl String False

The URL Twilio will request when an error occurs requesting the voice URL of the application.

VoiceFallbackMethod String False

The HTTP method to use to request the fallback voice URL of the application.

StatusCallback String False

The URL where Twilio will pass status parameters about calls received by phone numbers assigned to the application.

StatusCallbackMethod String False

The HTTP method that Twilio will use to make requests to the status callback URL of the application.

VoiceCallerIdLookup String False

Whether to look up the voice caller Id from the CNAM database for phone numbers assigned to this application.

VoiceMethod String False

The HTTP method Twilio will use to request the voice URL.

SmsUrl String False

The URL Twilio will request when a phone number assigned to the application receives an SMS message.

SmsMethod String False

The HTTP method Twilio will use to request the SMS URL of the application.

SmsFallbackUrl String False

The URL Twilio will request if an error occurs requesting the SMS URL.

SmsFallbackMethod String False

The HTTP method Twilio will use to request the fallback SMS URL of the application.

SmsStatusCallback String False

The URL where Twilio will POST to when an outgoing SMS request uses the Sid of the application.

MessageStatusCallback String False

The URL where status parameters are sent when you insert to the Messages table and specify the Sid of the application.

Uri String True

The URI of the application.

PublicApplicationConnectEnabled Boolean False

Whether to allow other Twilio accounts to dial this application using Dial verb. Can be: true or false.

CData Cloud

ByocTrunk

A ByocTrunk resource describes a trunk that can be configured to send and receive voice traffic to and from a PSTN Carrier via Bring Your Own Carrier (BYOC).

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM ByocTrunk WHERE Sid = 'BYabc123def456'

INSERT


INSERT INTO ByocTrunk(FriendlyName) VALUES ('MyTrunk')

UPDATE


UPDATE ByocTrunk SET FriendlyName = 'UpdatedTrunk' WHERE Sid = 'BYabc123def456'

DELETE


DELETE FROM ByocTrunk WHERE Sid = 'BYabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the BYOC Trunk resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the BYOC Trunk resource.

FriendlyName String False

A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

VoiceUrl String False

The URL Twilio calls using the voice_method when the BYOC Trunk receives a call.

VoiceMethod String False

The HTTP method used to call voice_url. Can be GET or POST.

The allowed values are GET, POST.

VoiceFallbackUrl String False

The URL Twilio calls when an error occurs while retrieving or executing the TwiML requested from voice_url.

VoiceFallbackMethod String False

The HTTP method used to call voice_fallback_url. Can be GET or POST.

The allowed values are GET, POST.

StatusCallbackUrl String False

The URL Twilio calls to pass status parameters such as call ended to your application.

StatusCallbackMethod String False

The HTTP method used to call status_callback_url. Can be GET or POST.

The allowed values are GET, POST.

CnamLookupEnabled Boolean False

Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, inbound calls from the US and Canada automatically perform a CNAM Lookup.

ConnectionPolicySid String False

ConnectionPolicy.Sid

The SID of the Connection Policy that Twilio will use when routing traffic to your communications infrastructure.

FromDomainSid String False

SIPDomain.Sid

The SID of the SIP Domain to use in the From header of originating calls sent to your SIP infrastructure.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the resource.

CData Cloud

CallAnnotation

Fetch and update the Annotation for a specific call.

Table-Specific Information

A Call Annotation captures details about the subjective experience of a voice call.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the Cloud.

  • CallSid supports the = operator.

For example:

SELECT * FROM CallAnnotation WHERE CallSid='CA78c6b6f8e5a08a9b87a3036d78e9ebd8';

UPDATE

You can update the following columns: AnsweredBy, ConnectivityIssue, QualityIssues, Spam, CallScore, Comment, and Incident.

UPDATE CallAnnotation SET AnsweredBy='human', ConnectivityIssue='no_connectivity_issue', QualityIssues='no_quality_issue', Spam=false, CallScore=4, Comment='tested', Incident='abcd' WHERE CallSid='CA78c6b6f8e5a08a9b87a3036d78e9ebd8'

Columns

Name Type ReadOnly References Description
CallSid [KEY] String True

Calls.Sid

The unique SID identifier of the call.

AccountSid String True

The account SID that owns the call.

AnsweredBy String False

Specifies which entity answered the call.

The allowed values are human, machine, unknown_answered_by.

ConnectivityIssue String False

Specifies the connectivity issue.

The allowed values are unknown_connectivity_issue, no_connectivity_issue, invalid_number, caller_id, dropped_call, number_reachability.

QualityIssues String False

Specifies quality issues with the call.

The allowed values are no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise.

Spam Boolean False

Specifies if the call was a spam call.

CallScore Integer False

Specifies the call score. An integer value from 1 to 5 where 1 represents very poor and 5 represents very good.

The allowed values are 1, 2, 3, 4, 5.

Comment String False

Specifies any comments pertaining to the call.

Incident String False

Specifies the incident or support ticket associated with the call.

Url String True

The URL of this resource.

CData Cloud

Calls

Create, query, update, and delete calls between phones and Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
ParentCallSid=
Status=
StartTime=, >, >=, <, <=
EndTime=, >, >=, <, <=

For example:

SELECT * FROM Calls WHERE StartTime >= '2014-10-10' AND EndTime <= '2015-10-10'

INSERT

From, To, and one of Url, Twiml, or ApplicationSid are required for INSERT. Because this is a conditional one-of-three requirement, the driver does not enforce it locally; if none of the three is provided, Twilio will reject the request with an API error.

INSERT INTO Calls([From], [To], Url) VALUES ('+12243318812', '+919870123123', 'https://example.com')

UPDATE


UPDATE Calls SET Status = 'canceled' WHERE Sid = 'CAa123'

DELETE

The following is an example of how to delete from the Calls table.
DELETE FROM Calls WHERE Sid = 'CAa123'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the call.

DateCreated Datetime True

The creation date of the call.

DateUpdated Datetime True

The modification date of the call.

ParentCallSid String True

The Id of the parent call.

AccountSid String True

The Id of the account that created the call.

To String False

The phone number, SIP address, or client identifier that is called.

ToFormatted String True

The formatted phone number, SIP address, or client identifier that is called.

From String False

The phone number, SIP address, or client identifier that has made the call.

FromFormatted String True

The formatted number, SIP address, or client identifier that has made the call.

PhoneNumberSid String True

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 False

The status of the call. One of the following values: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer. Set to canceled or completed to end an in-progress call.

The allowed values are queued, ringing, in-progress, canceled, completed, failed, busy, no-answer.

StartTime Datetime True

The start time of the call. Empty if the call has not yet been dialed.

EndTime Datetime True

The end time of the call. Empty if the call did not complete successfully.

Duration Integer True

The duration of the call. Empty for busy, failed, unanswered, or ongoing calls.

Price Decimal True

The price of the call after the call is completed.

Direction String True

The direction of the call. One of the following values: inbound, outbound-api, or outbound-dial.

The allowed values are inbound, outbound-api, outbound-dial.

AnsweredBy String True

One of the following values if the call was initiated with answering machine detection: human or machine. Empty otherwise.

ApiVersion String True

The API version of the call.

ForwardedFrom String True

The phone number that forwarded an incoming call. Note that the carrier must support forwarding.

CallerName String True

The caller name to a phone number that has Caller Id Lookup enabled.

Uri String True

The URI for the call.

PriceUnit String True

The currency used in the price property.

TrunkSid String True

The Id of the trunk resource used for this call.

QueueTime Long True

The wait time in milliseconds before the call is placed.

GroupSid String True

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

SubresourceUris String True

The subresources available for the given call.

Annotation String True

A user-defined string that provides additional information about the call.

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
Url String

The absolute URL that returns TwiML instructions for the call. Required for INSERT unless Twiml or ApplicationSid is provided. Applicable to INSERT and UPDATE queries.

Twiml String

TwiML instructions for the call. Mutually exclusive with Url and ApplicationSid. Applicable to INSERT and UPDATE queries.

ApplicationSid String

The SID of the Application that should handle the call. Mutually exclusive with Url and Twiml. Applicable to INSERT queries only.

Method String

The HTTP method to use when calling Url. Allowed values: GET, POST. Default is POST. Applicable to INSERT and UPDATE queries.

FallbackUrl String

The URL to call if an error occurs when fetching or executing the TwiML from Url. Applicable to INSERT and UPDATE queries.

FallbackMethod String

The HTTP method to use when requesting FallbackUrl. Allowed values: GET, POST. Default is POST. Applicable to INSERT and UPDATE queries.

StatusCallback String

The URL to call with status updates. Applicable to INSERT and UPDATE queries.

StatusCallbackMethod String

The HTTP method to use when calling StatusCallback. Allowed values: GET, POST. Default is POST. Applicable to INSERT and UPDATE queries.

StatusCallbackEvent String

The call progress events that trigger a StatusCallback. Allowed values: initiated, ringing, answered, completed. Applicable to INSERT queries only.

SendDigits String

A string of keys to dial after connecting to the number. Valid digits: 0-9, #, *, and w (wait 0.5 seconds). Applicable to INSERT queries only.

Timeout Integer

The integer number of seconds to wait for an answer. Default is 60 seconds. Applicable to INSERT queries only.

Record Boolean

Whether to record the call. Applicable to INSERT queries only.

RecordingChannels String

The number of channels in the recording. Allowed values: mono, dual. Applicable to INSERT queries only.

RecordingTrack String

The audio track to record. Allowed values: inbound, outbound, both. Applicable to INSERT queries only.

RecordingStatusCallback String

The URL to call when the recording is available. Applicable to INSERT queries only.

RecordingStatusCallbackMethod String

The HTTP method to use when calling RecordingStatusCallback. Allowed values: GET, POST. Applicable to INSERT queries only.

Trim String

Whether to trim silence from the recording. Allowed values: trim-silence, do-not-trim. Applicable to INSERT queries only.

TimeLimit Integer

The maximum duration of the call in seconds. Applicable to INSERT and UPDATE queries.

MachineDetection String

Whether to detect if a human or an answering machine picks up the call. Allowed values: Enable, DetectMessageEnd. Applicable to INSERT queries only.

CData Cloud

ConferenceParticipants

Lists all the participants in an active conference.

Table-Specific Information

Participants is a subresource of Conferences. It represents a participant who is either connecting to, or actively connected to, a Conference that is not in "completed" status. This means that the Participants endpoint does not return results for participants whose call has ended, whose associated conference has ended, or whose call has been modified to use the new Twilio Markup Language (TwiML). In other words, this resource does not return historical participant logs.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators.

ColumnSupported Operators
Muted=
Hold=
Coaching=
ConferenceSid=

For example, the following queries are processed server-side:

SELECT * FROM ConferenceParticipants WHERE ConferenceSid = 'CF5843bda0e992d145a0c989a33e2ba7d0'

Note: ConferenceSid is required in order to query ConferenceParticipants.

The rest of the filter is executed client-side within the Cloud.

INSERT

You can use the AddParticipants stored procedure for this operation.

UPDATE

You can use the ModifyParticipants stored procedure for this operation.

DELETE

Deletes the Participant subresource to remove the participant from the conference who are actively connected or connecting to the conference.

To delete a participant from the conference, you must specify the ConferenceSid and CallSid.

DELETE FROM ConferenceParticipants WHERE CallSid = 'CA84916e5a00e017d571bc7b1ef043166e' AND ConferenceSid = 'CF392ab62a295633aab3b2dc55298480bd'

Columns

Name Type ReadOnly References Description
CallSid [KEY] String True

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

ConferenceSid [KEY] String True

Conferences.Sid

The SID of the conference the participant is in.

AccountSid String True

The SID of the Account that created the Participant resource.

CallSidToCoach String False

The SID of the participant who is being coached.

Label String True

The user-specified label of this participant, if one was given when the participant was created.

Coaching Boolean False

Indicates whether the participant is coaching another call.

EndConferenceOnExit Boolean True

Indicates whether the conference ends when the participant leaves.

Muted Boolean False

Indicates whether the participant is muted.

Hold Boolean False

Indicates whether the participant is on hold.

StartConferenceOnEnter Boolean True

Indicates whether the conference starts when the participant joins the conference, if it has not already started.

DateCreated Datetime True

The date and time when the resource was created.

DateUpdated Datetime True

The date and time when the resource was updated.

Status String False

The status of the participant's call in a session.

The allowed values are queued, connecting, ringing, connected, ringing, failed.

Uri String True

The URI of this resource.

QueueTime String True

The wait time in milliseconds before participant's call is placed.

CData Cloud

Conferences

The Conferences resource allows you to query and manage the state of conferences on your Twilio account.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Name=
Status=
Sid=
DateCreated=, >, <, >=, <=
DateUpdated=, >, <, >=, <=

For example, the following queries are processed server-side:

SELECT * FROM Conferences
SELECT * FROM Conferences WHERE Sid = 'CF5843bda0e992d145a0c989a33e2ba7d0'

INSERT

Twilio does not allow Conferences to be added.

UPDATE

You can complete the Conference by updating the Status to Completed.

UPDATE Conferences SET Status = 'completed' WHERE Sid = 'CF2cdebca26bc915f19eea7efc0dc0ffe3'

DELETE

Twilio does not allow Conferences to be deleted.

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

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

AccountSid String True

The Id of the account that created this Conference resource.

DateCreated Datetime True

Date and time when the resource was created.

DateUpdated Datetime True

Date and time when the resource was updated.

ApiVersion String True

The API version used to create this conference.

Name String True

A string that you assigned to describe this conference room.

Region String True

A string that represents the Twilio Region where the conference audio was mixed.

The allowed values are us1, us2, ie1, de1, sg1, br1, au1, jp1.

Status String False

Status of this conference. One of: init, in-progress, or completed.

The allowed values are init, in-progress, completed.

Uri String True

The URI of this resource.

SubresourceUris String True

A list of related resources identified by their URIs.

ReasonConferenceEnded String True

The reason why a conference ended.

The allowed values are conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, last-participant-left.

CallSidEndingConference String True

The call SID that caused the conference to end.

CData Cloud

ConnectionPolicy

A ConnectionPolicy resource describes a set of routing rules for outbound calls made using Twilio's BYOC feature.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM ConnectionPolicy WHERE Sid = 'NYabc123def456'

INSERT

FriendlyName is required for INSERT.

INSERT INTO ConnectionPolicy(FriendlyName) VALUES ('MyPolicy')

UPDATE


UPDATE ConnectionPolicy SET FriendlyName = 'UpdatedPolicy' WHERE Sid = 'NYabc123def456'

DELETE


DELETE FROM ConnectionPolicy WHERE Sid = 'NYabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the Connection Policy resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the Connection Policy resource.

FriendlyName String False

A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the Connection Policy resource.

LinksTargets String True

The URL of the Targets sub-resource for the Connection Policy.

CData Cloud

ConnectionPolicyTarget

A ConnectionPolicyTarget resource describes a destination for voice traffic for a Connection Policy.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
ConnectionPolicySid=
Sid=

For example:

SELECT * FROM ConnectionPolicyTarget WHERE ConnectionPolicySid = 'NYabc123def456'
SELECT * FROM ConnectionPolicyTarget WHERE ConnectionPolicySid = 'NYabc123def456' AND Sid = 'NEabc123def456'

INSERT

ConnectionPolicySid and Target are required for INSERT.

INSERT INTO ConnectionPolicyTarget(ConnectionPolicySid, Target) VALUES ('NYabc123def456', 'sip:[email protected]')

UPDATE


UPDATE ConnectionPolicyTarget SET FriendlyName = 'UpdatedTarget' WHERE ConnectionPolicySid = 'NYabc123def456' AND Sid = 'NEabc123def456'

DELETE


DELETE FROM ConnectionPolicyTarget WHERE ConnectionPolicySid = 'NYabc123def456' AND Sid = 'NEabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the Connection Policy Target resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the Connection Policy Target resource.

ConnectionPolicySid [KEY] String False

ConnectionPolicy.Sid

The SID of the Connection Policy that owns this Target.

FriendlyName String False

A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

Target String False

The SIP address you want Twilio to route your calls to. This must be a sip: schema. sips is NOT supported.

Priority Integer False

The relative importance of the target. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important target.

Weight Integer False

The value that determines the relative share of the load the Target should receive compared to other Targets with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. Targets with higher values receive more load than those with lower ones with the same priority.

Enabled Boolean False

Whether the Target is enabled. The default is true.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the Connection Policy Target resource.

CData Cloud

ContentTemplates

Create, update, delete, and query Content templates in Twilio.

Table-Specific Information

The ContentTemplates table exposes the Content templates in your Twilio account. A Content template lets you define a message once and send it across channels such as SMS, WhatsApp, and Facebook Messenger. To send a template, pass its Sid to the ContentTemplateSid input of the SendMessage stored procedure.

The Cloud expects a JSON document for the Types and Variables columns. Types defines the body of the template for each channel, such as twilio/text or twilio/quick-reply. Variables supplies a default value for each placeholder in the body. Placeholders are written as {{1}}, {{2}}, and so on, and are replaced at send time by the ContentTemplateVariables input of SendMessage.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ContentTemplates;
SELECT * FROM ContentTemplates WHERE Sid = 'HX13cc1b73677f8ead76782b1ecec13299';

INSERT

To add a Content template, specify at least Language and Types.

INSERT INTO ContentTemplates (FriendlyName, Language, Types) VALUES ('owl_air_qr', 'en', '{"twilio/text": {"body": "Hi, {{1}}. Thanks for contacting Owl Air Support."}}')

Set Variables to give each placeholder a default value. If you plan to submit the template for WhatsApp approval, use self-evident defaults, because WhatsApp treats them as sample values during the review.

INSERT INTO ContentTemplates (FriendlyName, Language, Types, Variables) VALUES ('owl_air_qr', 'en', '{"twilio/text": {"body": "Hi, {{1}}. Thanks for contacting Owl Air Support."}}', '{"1": "Owl Air Customer"}')

UPDATE

Specify Sid in the WHERE clause. You can update FriendlyName, Language, Types, and Variables. Twilio does not allow you to update a template after you submit it for WhatsApp approval.

UPDATE ContentTemplates SET FriendlyName = 'owl_air_qr_v2', Types = '{"twilio/text": {"body": "Hello."}}' WHERE Sid = 'HX13cc1b73677f8ead76782b1ecec13299'

DELETE

Specify Sid in the WHERE clause.

DELETE FROM ContentTemplates WHERE Sid = 'HX13cc1b73677f8ead76782b1ecec13299'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the Content resource.

AccountSid String True

The SID of the Account that created the Content resource.

DateCreated Datetime True

The date and time the Content resource was created.

DateUpdated Datetime True

The date and time the Content resource was last updated.

FriendlyName String False

The string name used to describe the Content resource.

Language String False

The BCP-47 language code for the Content resource, such as en or fr.

Types String False

The content types and their definitions for the Content resource, such as twilio/text or twilio/quick-reply.

Variables String False

The key-value pairs of the variables and their default values for the Content resource.

Url String True

The absolute URL of the Content resource.

LinksApprovalCreate String True

The URL to submit the Content resource for WhatsApp approval.

LinksApprovalFetch String True

The URL to fetch the approval status of the Content resource.

CData Cloud

IncomingPhoneNumbers

Create, update, delete, and query phone numbers purchased from Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
Name=
PhoneNumber=
Beta=
Origin=

For example:

SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'

INSERT

To add an IncomingPhoneNumber, specify only one of the following columns: PhoneNumber or AreaCode. If you include both columns, Twilio uses the AreaCode column and ignores the PhoneNumber provided.

INSERT INTO IncomingPhoneNumbers (PhoneNumber, AreaCode) VALUES ('+15105555555', '123')

UPDATE

The following is an example of how to update the IncomingPhoneNumbers table:
UPDATE IncomingPhoneNumbers SET Name = 'appp8' WHERE Sid = 'X123456789'

DELETE

The following is an example of how to delete from the IncomingPhoneNumbers table:
DELETE FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the phone number.

AccountSid String False

The account Id of the phone number.

Name String False

The friendly name of the phone number. By default, this is a formatted phone number.

PhoneNumber String False

The phone number.

VoiceUrl String False

The URL Twilio will request when the phone number receives a call.

VoiceMethod String False

The HTTP method Twilio will use to make the request to the voice URL.

VoiceFallbackUrl String False

The URL Twilio will request when an error occurs requesting the voice URL.

VoiceFallbackMethod String False

The HTTP method to use to request the fallback voice URL.

VoiceCallerIdLookup Boolean False

Whether to look up the caller Id from the CNAM database.

DateCreated Datetime True

The creation date of the phone number.

DateUpdated Datetime True

The modification date of the phone number.

SmsUrl String False

The URL Twilio will request when the phone number receives an SMS message.

SmsMethod String False

The HTTP method Twilio will use to make requests to the SMS URL.

SmsFallbackUrl String False

The URL Twilio will request when an error occurs requesting the SMS URL.

SmsFallbackMethod String False

The HTTP method Twilio will use to request the fallback SMS URL of the phone number.

AddressRequirements String True

The address requirements for the phone number. Eligible values are: none, any, local, or foreign.

Beta String True

Whether the phone number is a beta phone number new to Twilio.

CapabilitiesVoice Boolean True

Whether the phone number supports voice.

CapabilitiesSms Boolean True

Whether the phone number supports SMS.

CapabilitiesMms Boolean True

Whether the phone number supports MMS.

StatusCallback String False

The URL where Twilio will pass status parameters about calls received by the phone number.

StatusCallbackMethod String False

The HTTP method that Twilio will use to make requests to the status callback URL.

ApiVersion String False

The API version of the phone number.

VoiceApplicationSid String False

The voice application Id of the phone number. This can be used in place of the voice URLs.

SmsApplicationSid String False

The SMS application Id of the phone number. This can be used in place of the SMS URLs.

TrunkSid String False

The trunk Id of the phone number. This overrides VoiceApplicationId and the voice URLs.

Uri String True

The URI of the phone number.

AddressSid String False

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

IdentitySid String False

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

Origin String True

The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers.

VoiceReceiveMode String False

Mode of Received voice.

The allowed values are voice, fax.

CapabilitiesFax Boolean True

Whether the phone number supports fax.

EmergencyStatus String False

The emergency calling status of this phone number.

The allowed values are Active, Inactive.

EmergencyAddressSid String False

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

EmergencyAddressStatus String True

The status of address registration with emergency services.

The allowed values are registered, unregistered, pending-registration, registration-failure, pending-unregistration, unregistration-failure.

BundleSid String False

The SID of the Bundle resource that you associate with the phone number.

Status String True

The status of the phone number.

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
AreaCode String

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.

Category String

The category of the phone number. Possible values are Local, Mobile and TollFree.

The allowed values are Local, Mobile, TollFree.

CData Cloud

IpRecord

An IpRecord resource represents a static IP address used to address the BYOC Trunk's Termination SIP Domain via an IP address instead of an FQDN (Fully Qualified Domain Name).

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM IpRecord WHERE Sid = 'NEabc123def456'

INSERT

IpAddress is required for INSERT.

INSERT INTO IpRecord(IpAddress) VALUES ('192.0.2.1')

UPDATE


UPDATE IpRecord SET FriendlyName = 'UpdatedRecord' WHERE Sid = 'NEabc123def456'

DELETE


DELETE FROM IpRecord WHERE Sid = 'NEabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the IP Record resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the IP Record resource.

FriendlyName String False

A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.

IpAddress String False

An IP address in dotted decimal notation, IPv4 only.

CidrPrefixLength Integer False

An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. Minimum is 1 and maximum is 32.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the IP Record resource.

CData Cloud

Media

Delete and query Media in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: MessageSid is required in the WHERE clause.

ColumnSupported Operators
MessageSid=
Sid=
DateCreated=, >, >=, <, <=

For example, the following queries are processed server-side:

SELECT * FROM Media WHERE MessageSid = 'SM53a7aeeed5ac474ea'

SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea'

SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea' AND DateCreated > '2015-10-10'

INSERT

Twilio does not allow Media to be added.

UPDATE

Twilio does not allow Media to be updated.

DELETE


DELETE FROM Media WHERE MessageSid = 'MM319a82ae6d7411407ef7dc7d78eb2081' AND Sid = 'MS123456789'

Columns

Name Type ReadOnly References Description
Sid [KEY] String False

The Id of the media.

AccountSid String False

The Id of the account associated with the media.

ParentSid String False

The Id of the entity that created the media.

ContentType String False

The MIME type of the media.

DateCreated Datetime False

The creation date of the media.

DateUpdated Datetime False

The modification date of the media.

Uri String False

The URL of the media.

MessageSid [KEY] String False

The message Id of the media.

CData Cloud

Messages

Create, update, delete, and query SMS and MMS Messages in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sender=
To=
DateSent=, >, >=, <, <=
Sid=

For example, the following queries are processed server-side:

SELECT * FROM Messages WHERE Sid = 'MS123456789' AND DateSent > '2015-10-10' 

INSERT

To add a Message, specify Body, MediaUrl, or both, and To. At least one of the following conditional parameters must also be included: MessagingServiceSid or Sender.

INSERT INTO Messages (To, Sender, Body) VALUES ('+12345678965', '+12019493653', 'Hi!')
INSERT INTO Messages (To, Sender, MediaUrl) VALUES ('+12345678965', '+12019493653', 'http://www.mycompany.com/ui/img/logo.png')
Note: Up to 10 MediaUrl can be added per message as comma-separated-values.
INSERT INTO Messages (To, Sender, Body, MediaUrl) VALUES ('+12345678965', '+12019493653', 'Hi again!', 'http://www.mycompany.com/ui/img/logo.png, http://www.mycompany.com/ui/img/logo2.png')

UPDATE

To update a Message record, the Body column must be empty.

UPDATE Messages SET Body = "" WHERE Sid = 'M1233455'

DELETE

Messages cannot be deleted if the status is sending.
DELETE FROM Messages WHERE Sid = 'M123456789' 

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the message.

DateCreated Datetime True

The creation date of the message.

DateUpdated Datetime True

The modification date of the message.

DateSent Datetime True

The sent date of the message.

AccountSid String True

The account Id of the message.

To String False

The phone number the message was sent to.

Sender String False

The phone number or sender Id that sent the message.

MessagingServiceSid String True

The messaging service Id of the message.

Body String False

The body of the message.

MediaUrl String False

The URL of the media you wish to send out with the message.

Status String False

The status of the message. One of the following values: accepted, queued, sending, sent, failed, delivered, undelivered, receiving, received, scheduled, read, partially_delivered or canceled.

The allowed values are accepted, queued, sending, sent, failed, delivered, undelivered, receiving, received, scheduled, read, partially_delivered, canceled.

NumSegments Integer True

The number of segments that make up the message.

NumMedia Integer True

The number of media files associated with the message. The maximum is 10.

Direction String True

The direction of the message. One of the following values: inbound, outbound-api, outbound-call, or outbound-reply.

The allowed values are inbound, outbound-api, outbound-call, outbound-reply.

ApiVersion String True

The API version of the message.

Price Decimal True

The price of the message.

PriceUnit String True

The currency of the message.

ErrorCode String True

The error code of the message.

ErrorMessage String True

The error message.

Uri String True

The URI of the message.

SubresourceUris String True

The subresources available for the given message.

StatusCallback String False

The URL Twilio will POST MessageSid and MessageStatus to when the message status changes.

ApplicationSid String False

The SID of the application that should receive message updates.

ProvideFeedback Boolean False

Indicates whether feedback was provided for this message.

Attempt Integer False

The attempt number of sending the message.

ValidityPeriod Integer False

The amount of time in seconds that the message can remain in a Twilio queue.

ForceDelivery Boolean False

Indicates whether the message should be sent using force delivery.

AddressRetention String False

Specifies how to handle the addresses of the message. One of: retain or obfuscate.

The allowed values are retain, obfuscate.

SmartEncoded Boolean False

Indicates whether to automatically detect unicode characters and switch to UCS-2 encoding.

PersistentAction String False

Rich actions for non-SMS/MMS channels. Possible action types are reply, call, and url.

TrafficType String False

Identifies the message traffic type for messages sent via the Messaging Service.

ShortenURLs Boolean False

Indicates whether to detect and shorten URLs in the message.

ScheduleType String False

Specifies the scheduling type for the message. Allowed value: fixed.

The allowed values are fixed.

SendAt Datetime False

The time that Twilio will send the message. Must be in ISO 8601 format.

SendAsMms Boolean False

Indicates whether to send the message as MMS.

ContentVariables String False

Key-value pairs of variable names to substitution values used with a content template.

RiskCheck String False

Enables or disables filtering of messages with potential high-risk content. One of: enable or disable.

The allowed values are enable, disable.

ContentSid String False

The SID of the content template to be used with the message.

CData Cloud

OutgoingCallerIds

Represents verified phone numbers that can be used as a caller Id when making outgoing calls.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
Name=
PhoneNumber=

For example:

SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'

INSERT

To add an OutgoingCallerId, use the AddOutgoingCallerIds stored procedure.

EXEC AddOutgoingCallerIds PhoneNumber = '+15105555555'

UPDATE

Twilio allows the Name column to be updated.

UPDATE OutgoingCallerIds SET Name = 'test' WHERE Sid = 'O123456789'

DELETE

The following is an example of how to delete from the OutgoingCallerIds table.
DELETE FROM OutgoingCallerIds WHERE Sid = 'PNb4c1e6bd6f0a81c70a0cc4dc8b0c82e6'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the outgoing caller Id record.

AccountSid String True

The unique Id of the account associated with the outgoing caller Id.

DateCreated Datetime True

The creation date of the outgoing caller Id.

DateUpdated Datetime True

The modification date of the outgoing caller Id.

Name String False

The friendly name of the outgoing caller Id. By default, this is a formatted phone number.

PhoneNumber String False

The phone number of the outgoing caller Id.

Uri String True

The URI of the outgoing caller Id.

CData Cloud

QueueMembers

Members is a subresource of Queues and represents a single call in a call queue.

Table-Specific Information

A Queue resource describes a call queue that contains individual calls, which are described by the queue's Members subsresource. Your account can have more than one call queue.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: QueueSid is required in order to query QueueMembers.

  • QueueSid supports the = operator.
  • CallSid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM QueueMembers WHERE QueueSid = 'QUb6b54410a940521a074713abfd5a4226'

INSERT

Twilio does not allow QueueMembers to be added.

UPDATE

QueueSid and CallSid are required in the WHERE clause for an UPDATE.

UPDATE QueueMembers SET Url = 'https://example.com/handler.xml' WHERE QueueSid = 'QUb6b54410a940521a074713abfd5a4226' AND CallSid = 'CA1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d'

DELETE

Twilio does not allow QueueMembers to be deleted.

Columns

Name Type ReadOnly References Description
CallSid [KEY] String True

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

QueueSid [KEY] String True

The SID of the Queue the member is in.

AccountSid String True

The Id of the account that created this Conference resource.

DateEnqueued Datetime True

The date that the member was enqueued, given in RFC 2822 format.

Position Integer True

This member's current position in the queue.

Url String False

The URI of this resource.

WaitTime Integer True

The number of seconds the member has been in the queue.

AverageWaitTime Integer True

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

MaxSize Integer True

The maximum number of calls that can be in the queue.

CData Cloud

Queues

A Queue resource describes a call queue that contains individual calls.

Table-Specific Information

A Queue resource describes a call queue that contains individual calls, which are described by the queue's Members subsresource. Your account can have more than one call queue.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Queues;

SELECT * FROM Queues WHERE Sid = 'QU5b50281a74c6168acdf884e419990ea1';

INSERT

To add a Queue, at least Name should be specified. Additional columns that are available for insert are: MaxSize.

 INSERT INTO Queues (MaxSize, Name) VALUES (34, 'testing');

UPDATE


 UPDATE Queues SET MaxSize = 50, Name = 'Test value' WHERE SID = 'QU5b50281a74c6168acdf884e419990ea1';

DELETE


DELETE FROM Queues WHERE SID = 'QUb6b54410a940521a074713abfd5a4226'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

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

AccountSid String True

The Id of the account that created this Conference resource.

DateCreated Datetime True

Date and time when the resource was created.

DateUpdated Datetime True

Date and time when the resource was updated.

CurrentSize Integer True

The number of calls currently in the queue.

Name String False

A string that you assigned to describe this resource.

Uri String True

The URI of this resource.

AverageWaitTime Integer True

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

MaxSize Integer False

The maximum number of calls that can be in the queue.

SubresourceUris String True

The subresources available for the given queue.

CData Cloud

RealTimeTranscriptionForVideo

A RealTimeTranscriptionForVideo resource represents the configuration and state of real-time speech-to-text transcriptions for a Video Room.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
RoomSid=
Ttid=

For example:

SELECT * FROM RealTimeTranscriptionForVideo WHERE RoomSid = 'RMabc123def456'
SELECT * FROM RealTimeTranscriptionForVideo WHERE RoomSid = 'RMabc123def456' AND Ttid = 'video_extension_00000000-0000-0000-0000-000000000000'

INSERT

RoomSid is required for INSERT.

INSERT INTO RealTimeTranscriptionForVideo(ConfigurationLanguageCode, ConfigurationPartialResults, ConfigurationProfanityFilter, ConfigurationSpeechModel, RoomSid) VALUES ('EN-us', false, false, 'long', 'RMabc123def456')

UPDATE


UPDATE RealTimeTranscriptionForVideo SET Status = 'stopped' WHERE RoomSid = 'RMabc123def456' AND Ttid = 'video_extension_00000000-0000-0000-0000-000000000000'

Columns

Name Type ReadOnly References Description
Ttid [KEY] String True

The Twilio Type ID of the Transcriptions resource assigned at creation time.

AccountSid String True

Accounts.Sid

The SID of the Account that owns the Transcriptions resource.

RoomSid [KEY] String False

Rooms.Sid

The SID of the parent Video Room.

Status String False

The status of the Transcriptions resource. Can be: started, stopped, or failed.

The allowed values are started, stopped, failed.

SourceSid String True

The SID of the source of the transcription.

ConfigurationTranscriptionEngine String False

The transcription engine used. Default is google.

ConfigurationSpeechModel String False

The speech recognition model used by the transcription engine. Default is telephony.

ConfigurationLanguageCode String False

The language of the audio to transcribe, specified in BCP-47 format. Default is en-US.

ConfigurationPartialResults Boolean False

Whether to deliver partial (interim) transcription results before the final result. Default is false.

ConfigurationProfanityFilter Boolean False

Whether to filter profanity from the transcription output, replacing filtered words with asterisks. Default is true.

ConfigurationHints String False

A comma-separated list of words or phrases to help the transcription engine recognize expected content during transcription.

ConfigurationEnableAutomaticPunctuation Boolean False

Whether to enable automatic punctuation in the transcription output. Default is true.

StartTime Datetime True

The date and time in UTC when the resource entered started status and the first participant joined the Room, specified in ISO 8601 format.

EndTime Datetime True

The date and time in UTC when transcription processing paused in the Room, specified in ISO 8601 format.

Duration Integer True

The cumulative time in seconds that the transcription resource has been in started status and at least one participant is in the Room.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the resource.

CData Cloud

Recordings

Delete and query the available Recordings in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
CallSid=
DateCreated=, >, >=, <, <=
Sid=

For example, the following queries are processed server-side:

SELECT * FROM Recordings WHERE DateCreated > '2011-10-10' 

INSERT

Twilio does not allow Recordings to be added.

UPDATE

Twilio does not allow Recordings to be updated.

DELETE


DELETE FROM Recordings WHERE Sid = 'REfb1f22afc4f6243242'

Columns

Name Type ReadOnly References Description
Sid [KEY] String False

The Id of the recording.

ApiVersion String False

The API version of the recording.

CallSid String False

The Id of the call for the recording.

DateCreated Datetime False

The creation date of the recording.

DateUpdated Datetime False

The modification date of the recording.

Duration Double False

The duration of the recording in seconds.

AccountSid String False

The account Id of the recording.

Uri String False

The URI of the recording.

ConferenceSid String False

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

StartTime Datetime False

The start time of the recording.

Price Decimal False

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

PriceUnit String False

The currency used in the price property.

Status String False

The status of the recording.

The allowed values are in-progress, paused, stopped, processing, completed, absent, deleted.

Channels Integer False

The number of channels in the recording resource.

Source String False

How the recording was created.

The allowed values are DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, StartConferenceRecordingAPI.

ErrorCode Integer False

The error code that describes why the recording is absent.

MediaUrl String False

The URL of the media file associated with this recording resource.

SubresourceUris String False

The subresources available for the given recording.

EncryptionDetailsEncryptionPublicKeySid String False

The SID of the public key used to encrypt the recording.

EncryptionDetailsEncryptionCek String False

The Content Encryption Key (CEK) used to decrypt the encrypted recording.

EncryptionDetailsEncryptionIv String False

The initialization vector (IV) used to decrypt the encrypted recording.

CData Cloud

Rooms

A Room resource represents a Programmable Video communication session among multiple endpoints using Twilio's Video SDKs. When listing Rooms, the API returns only Rooms with a status of in-progress.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
UniqueName=
Status=
DateCreated=, >, >=, <, <=

For example:

SELECT * FROM Rooms WHERE Sid = 'RMabc123def456'

INSERT


INSERT INTO Rooms(UniqueName) VALUES ('MyRoom')

UPDATE


UPDATE Rooms SET Status = 'completed' WHERE Sid = 'RMabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the Room resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the Room resource.

UniqueName String False

An application-defined string that uniquely identifies the resource. SDK clients can use this name to connect to the room.

Status String False

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

The allowed values are in-progress, completed, failed.

Type String False

Type of room. Use group for new implementations. go, peer-to-peer, and group-small are deprecated.

The allowed values are group, go, peer-to-peer, group-small.

MaxParticipants Integer False

The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50.

MaxParticipantDuration Integer False

The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours).

MaxConcurrentPublishedTracks Integer True

The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time.

Duration Integer True

The duration of the room in seconds.

MediaRegion String False

The region for the Room's media server.

AudioOnly Boolean False

When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed.

LargeRoom Boolean False

Indicates if this is a large room.

EmptyRoomTimeout Integer False

Specifies how long (in minutes) a room will remain active after the last participant leaves. Valid values range from 1 to 60 minutes.

UnusedRoomTimeout Integer False

Specifies how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes.

RecordParticipantsOnConnect Boolean False

Whether to start recording when Participants connect.

StatusCallback String False

The URL Twilio calls to send status information to your application on every room event.

StatusCallbackMethod String False

The HTTP method Twilio uses to call status_callback. Can be POST or GET.

The allowed values are GET, POST.

VideoCodecs String False

The video codecs supported when publishing a track in the room. Can be: VP8 and H264. Multiple values can be specified as a comma-separated list in INSERT statements (for example, VP8,H264).

EnableTurn Boolean True

Deprecated, now always considered to be true.

EndTime Datetime True

The UTC end time of the room in ISO 8601 format.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the resource.

LinksParticipants String True

The URL of the Participants sub-resource for the room.

LinksRecordings String True

The URL of the Recordings sub-resource for the room.

LinksRecordingRules String True

The URL of the RecordingRules sub-resource for the room.

LinksTranscriptions String True

The URL of the Transcriptions sub-resource for the room.

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
TranscribeParticipantsOnConnect Boolean

Whether to start real-time transcriptions when Participants connect. If TranscriptionsConfiguration is not provided, default settings will be used. Used in INSERT statements.

RecordingRules String

A JSON array of Recording Rules that describe how to include or exclude matching tracks for recording. Each rule specifies a type (include or exclude) and an all flag. Used in INSERT statements.

TranscriptionsConfiguration String

A JSON string with key-value configuration settings for the transcription engine (e.g. languageCode, speechModel, partialResults). Used when TranscribeParticipantsOnConnect is true. Used in INSERT statements.

CData Cloud

ServiceLists

Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Sid supports the = operator.
  • ServiceSid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ServiceLists WHERE Sid = 'ES5efaf437f5274d89a79' AND ServiceSid = 'ISbd3a2af64'

SELECT * FROM ServiceLists WHERE ServiceSid = 'ISbd3a2af64'

INSERT

To add a ServiceList, specify at least the ServiceSid.

INSERT INTO ServiceLists (ServiceSid, UniqueName) VALUES ('ISbd3a2af64e5c39', 'Denis') 

UPDATE


UPDATE ServiceLists SET TimeToLive = 10 WHERE Sid = 'ES5efaf437f5274d89a79' AND ServiceSid = 'ISbd3a2af64'

DELETE


DELETE FROM ServiceLists WHERE Sid = 'ES5efaf437f5274d89a79' AND ServiceSid = 'ISbd3a2af64'

Columns

Name Type ReadOnly References Description
Sid [KEY] String False

The unique string that identifies the Sync List resource.

ServiceSid [KEY] String False

Services.Sid

The SID of the Sync Service the resource is associated with.

AccountSid String True

Accounts.Sid

The SID of the Account that created the Sync List resource.

UniqueName String False

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

The absolute URL of the Sync List resource.

Revision String True

The current revision of the Sync List, represented as a string.

DateCreated Datetime True

The date and time when the resource was created.

DateUpdated Datetime True

The date and time when the resource was last updated.

DateExpires Datetime True

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

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

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

The URLs of the Sync List's nested resources.

CData Cloud

Services

A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Services

SELECT * FROM Services WHERE Sid = 'CAa123'

INSERT

FriendlyName is required for INSERT.

INSERT INTO Services (FriendlyName) VALUES ('abc')

UPDATE


UPDATE Services SET FriendlyName = 'update_test' WHERE Sid = 'CAa123'

DELETE


DELETE FROM Services WHERE Sid = 'CAa123'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that Twilio's created to identify the Service resource.

AccountSid String True

Accounts.Sid

The SID of the Account that created the Service resource.

UniqueName String True

An application-defined string that uniquely identifies the resource.

FriendlyName String False

The string that you assigned to describe the resource.

DateCreated Datetime True

The date and time when the service was created.

DateUpdated Datetime True

The date and time when the service was last updated.

Url String True

The absolute URL of the service.

WebhookUrl String False

The URL that gets called when Sync objects are manipulated.

WebhooksFromRestEnabled Boolean False

Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false.

AclEnabled Boolean False

Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.

ReachabilityWebhooksEnabled Boolean False

Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false.

ReachabilityDebouncingEnabled Boolean False

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 False

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

The URLs of related resources.

CData Cloud

SIPCredential

A SIP Credential resource represents a username and password used to authenticate SIP Endpoints to a SIP Domain.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
CredentialListSid=
Sid=

For example:

SELECT * FROM SIPCredential WHERE CredentialListSid = 'CLabc123def456'
SELECT * FROM SIPCredential WHERE CredentialListSid = 'CLabc123def456' AND Sid = 'CRabc123def456'

INSERT

CredentialListSid, Username, and Password are required for INSERT. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case.

INSERT INTO SIPCredential (CredentialListSid, Username, Password) VALUES ('CLabc123def456', 'myuser', 'MyPassword123')

UPDATE


UPDATE SIPCredential SET Password = 'NewPassword123' WHERE CredentialListSid = 'CLabc123def456' AND Sid = 'CRabc123def456'

DELETE


DELETE FROM SIPCredential WHERE CredentialListSid = 'CLabc123def456' AND Sid = 'CRabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this Credential resource.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

CredentialListSid [KEY] String False

SIPCredentialList.Sid

The unique ID of the CredentialList that contains this Credential.

Username String False

The username used to identify this Credential.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Uri String True

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

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
Password String

The password used to authenticate the username. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. Not returned by the API. Used in INSERT/UPDATE statements.

CData Cloud

SIPCredentialList

A SIP CredentialList resource manages lists of users authorized to access a SIP Domain. Each CredentialList can contain up to 1,000 Credential resources.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM SIPCredentialList WHERE Sid = 'CLabc123def456'

INSERT

FriendlyName is required for INSERT.

INSERT INTO SIPCredentialList(FriendlyName) VALUES ('MyCredentialList')

UPDATE


UPDATE SIPCredentialList SET FriendlyName = 'UpdatedName' WHERE Sid = 'CLabc123def456'

DELETE


DELETE FROM SIPCredentialList WHERE Sid = 'CLabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this CredentialList resource.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

FriendlyName String False

A human-readable description of the CredentialList, up to 64 characters.

DateCreated Datetime True

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

DateUpdated Datetime True

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

SubresourceUrisCredentials String True

The URI of the Credentials subresource for this CredentialList.

Uri String True

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

CData Cloud

SIPCredentialListMapping

A SIP CredentialListMapping resource associates a CredentialList with a SIP Domain for call authentication. Requests to the domain are challenged and authenticated against the mapped credential lists.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
DomainSid=
Sid=

For example:

SELECT * FROM SIPCredentialListMapping WHERE DomainSid = 'SDabc123def456'
SELECT * FROM SIPCredentialListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'CLabc123def456'

INSERT

DomainSid and CredentialListSid are required for INSERT.

INSERT INTO SIPCredentialListMapping(DomainSid, CredentialListSid) VALUES ('SDabc123def456', 'CLabc123def456')

DELETE


DELETE FROM SIPCredentialListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'CLabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this CredentialListMapping resource.

DomainSid [KEY] String False

SIPDomain.Sid

The unique ID of the SIP Domain that contains this CredentialListMapping.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

FriendlyName String True

A human-readable description of the mapped CredentialList.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
CredentialListSid String

The SID of the CredentialList resource to map to the SIP Domain. Required on INSERT.

CData Cloud

SIPDomain

A SIP Domain resource describes a custom DNS hostname that can accept SIP traffic for your account. SIP requests to the domain are routed to Twilio and authenticated before TwiML is requested.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM SIPDomain WHERE Sid = 'SDabc123def456'

INSERT

DomainName is required for INSERT.

INSERT INTO SIPDomain(DomainName, Secure) VALUES ('example.sip.twilio.com', true)

UPDATE


UPDATE SIPDomain SET DomainName = 'updated.sip.twilio.com', Secure = false WHERE Sid = 'SDabc123def456'

DELETE


DELETE FROM SIPDomain WHERE Sid = 'SDabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this SIP Domain resource.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

DomainName String False

The unique address on Twilio to which SIP traffic is routed. Must contain letters, digits, and hyphens, and end with sip.twilio.com.

FriendlyName String False

A human-readable description of the SIP Domain, up to 64 characters.

ApiVersion String True

The API version used to process the call.

AuthType String True

The types of authentication mapped to the domain. Can be IP_ACL, CREDENTIAL_LIST, or both in a comma-delimited string.

SipRegistration Boolean False

Whether to allow SIP Endpoints to register with the domain to receive calls.

Secure Boolean False

Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls.

EmergencyCallingEnabled Boolean False

Whether emergency calling is enabled for the domain.

ByocTrunkSid String False

ByocTrunk.Sid

The SID of the BYOC Trunk resource associated with this SIP Domain.

EmergencyCallerSid String False

The SID of the phone number used as the callback for emergency calls on the domain.

VoiceUrl String False

The URL Twilio calls when the domain receives a call.

VoiceMethod String False

The HTTP method used to call the VoiceUrl. Can be GET or POST.

The allowed values are GET, POST.

VoiceFallbackUrl String False

The URL Twilio calls when an error occurs retrieving or executing the TwiML from the VoiceUrl.

VoiceFallbackMethod String False

The HTTP method used to call the VoiceFallbackUrl. Can be GET or POST.

The allowed values are GET, POST.

VoiceStatusCallbackUrl String False

The URL Twilio calls to pass status parameters to your application when a call ends.

VoiceStatusCallbackMethod String False

The HTTP method used to call the VoiceStatusCallbackUrl. Can be GET or POST.

The allowed values are GET, POST.

DateCreated Datetime True

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

DateUpdated Datetime True

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

SubresourceUrisCredentialListMappings String True

The URI of the CredentialListMappings subresource for this SIP Domain.

SubresourceUrisIpAccessControlListMappings String True

The URI of the IpAccessControlListMappings subresource for this SIP Domain.

Uri String True

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

CData Cloud

SIPDomainRegistrationCredentialListMapping

A SIP Domain Registration CredentialListMapping resource links CredentialLists to a SIP Domain for registration authentication. Incoming SIP registrations are challenged and must match credentials in a mapped list.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
DomainSid=
Sid=

For example:

SELECT * FROM SIPDomainRegistrationCredentialListMapping WHERE DomainSid = 'SDabc123def456'
SELECT * FROM SIPDomainRegistrationCredentialListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'CLabc123def456'

INSERT

DomainSid and CredentialListSid are required for INSERT.

INSERT INTO SIPDomainRegistrationCredentialListMapping (DomainSid, CredentialListSid) VALUES ('SDabc123def456', 'CLabc123def456')

DELETE


DELETE FROM SIPDomainRegistrationCredentialListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'CLabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this CredentialListMapping resource.

DomainSid [KEY] String False

SIPDomain.Sid

The unique ID of the SIP Domain that contains this registration CredentialListMapping.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

FriendlyName String True

A human-readable description of the mapped CredentialList.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
CredentialListSid String

The SID of the CredentialList resource to map to the SIP Domain registration. Required on INSERT.

CData Cloud

SIPIpAccessControlList

A SIP IpAccessControlList resource contains IP addresses authorized to access a SIP Domain. Each account can have up to 1,000 IpAccessControlList resources, each containing up to 100 IP address entries.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM SIPIpAccessControlList WHERE Sid = 'ALabc123def456'

INSERT

FriendlyName is required for INSERT.

INSERT INTO SIPIpAccessControlList(FriendlyName) VALUES ('MyACL')

UPDATE


UPDATE SIPIpAccessControlList SET FriendlyName = 'UpdatedACL' WHERE Sid = 'ALabc123def456'

DELETE


DELETE FROM SIPIpAccessControlList WHERE Sid = 'ALabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this IpAccessControlList resource.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

FriendlyName String False

A human-readable description of the IpAccessControlList, up to 255 characters.

DateCreated Datetime True

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

DateUpdated Datetime True

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

SubresourceUrisIpAddresses String True

The URI of the IpAddresses subresource for this IpAccessControlList.

Uri String True

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

CData Cloud

SIPIpAccessControlListMapping

A SIP IpAccessControlListMapping resource associates an IpAccessControlList with a SIP Domain for call authentication. Incoming SIP INVITE requests must originate from an IP address in a mapped access control list.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
DomainSid=
Sid=

For example:

SELECT * FROM SIPIpAccessControlListMapping WHERE DomainSid = 'SDabc123def456'
SELECT * FROM SIPIpAccessControlListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'ALabc123def456'

INSERT

DomainSid and IpAccessControlListSid are required for INSERT.

INSERT INTO SIPIpAccessControlListMapping(DomainSid, IpAccessControlListSid) VALUES ('SDabc123def456', 'ALabc123def456')

DELETE


DELETE FROM SIPIpAccessControlListMapping WHERE DomainSid = 'SDabc123def456' AND Sid = 'ALabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this IpAccessControlListMapping resource.

DomainSid [KEY] String False

SIPDomain.Sid

The unique ID of the SIP Domain that contains this IpAccessControlListMapping.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

FriendlyName String True

A human-readable description of the mapped IpAccessControlList.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
IpAccessControlListSid String

The SID of the IpAccessControlList resource to map to the SIP Domain. Required on INSERT.

CData Cloud

SIPIpAddress

A SIP IpAddress resource represents an IP address entry within an IpAccessControlList. SIP requests from allowed IP addresses are permitted access to the associated SIP Domain. Each IpAccessControlList can contain up to 100 IP address entries.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
IpAccessControlListSid=
Sid=

For example:

SELECT * FROM SIPIpAddress WHERE IpAccessControlListSid = 'ALabc123def456'
SELECT * FROM SIPIpAddress WHERE IpAccessControlListSid = 'ALabc123def456' AND Sid = 'IPabc123def456'

INSERT

IpAccessControlListSid, FriendlyName, and IpAddress are required for INSERT.

INSERT INTO SIPIpAddress(IpAccessControlListSid, FriendlyName, IpAddress) VALUES ('ALabc123def456', 'MyAddress', '10.0.0.11')

UPDATE


UPDATE SIPIpAddress SET FriendlyName = 'UpdatedAddress' WHERE IpAccessControlListSid = 'ALabc123def456' AND Sid = 'IPabc123def456'

DELETE


DELETE FROM SIPIpAddress WHERE IpAccessControlListSid = 'ALabc123def456' AND Sid = 'IPabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

A 34 character string that uniquely identifies this IpAddress resource.

AccountSid String True

Accounts.Sid

The unique ID of the Account responsible for this resource.

IpAccessControlListSid [KEY] String False

SIPIpAccessControlList.Sid

The unique ID of the IpAccessControlList that contains this IpAddress.

FriendlyName String False

A human-readable description of this IpAddress resource, up to 255 characters.

IpAddress String False

An IPv4 address in dotted decimal notation from which SIP requests will be accepted.

CidrPrefixLength Integer False

The length of the CIDR prefix to use with this IP address when accepting traffic. Defaults to 32 (entire IP address).

DateCreated Datetime True

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

DateUpdated Datetime True

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

Uri String True

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

CData Cloud

SourceIpMapping

A SourceIpMapping resource associates an IP Record with a SIP Domain, allowing you to control which IP addresses are allowed to send traffic to your SIP infrastructure.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=

For example:

SELECT * FROM SourceIpMapping WHERE Sid = 'MRabc123def456'

INSERT

IpRecordSid and SipDomainSid are required for INSERT.

INSERT INTO SourceIpMapping(IpRecordSid, SipDomainSid) VALUES ('NEabc123def456', 'NYabc123def456')

UPDATE


UPDATE SourceIpMapping SET SipDomainSid = 'SDabc123def456' WHERE Sid = 'MRabc123def456'

DELETE


DELETE FROM SourceIpMapping WHERE Sid = 'MRabc123def456'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The unique string that identifies the Source IP Mapping resource.

IpRecordSid String False

IpRecord.Sid

The Twilio-provided string that uniquely identifies the IP Record resource to map from.

SipDomainSid String False

SIPDomain.Sid

The SID of the SIP Domain that the IP Record is mapped to.

DateCreated Datetime True

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

DateUpdated Datetime True

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

Url String True

The absolute URL of the Source IP Mapping resource.

CData Cloud

Transcriptions

Query the available Transcriptions in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • RecordingSid supports the = operator.
  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM Transcriptions WHERE Sid = 'T12345564' 

INSERT

Twilio does not allow Transcriptions to be added.

UPDATE

Twilio does not allow Transcriptions to be updated.

Columns

Name Type ReadOnly References Description
Sid [KEY] String False

The Id of the transcription.

AccountSid String False

The account Id of the transcription.

ApiVersion String False

The API version of the transcription.

DateCreated Datetime False

The creation date of the transcription.

DateUpdated Datetime False

The modification date of the transcription.

Duration Integer False

The duration of the transcription in seconds.

Price Decimal False

The price of the transcription.

RecordingSid String False

The recording Id of the transcription.

Status String False

The status of the transcription. One of the following values: in-progress, completed, or failed.

TranscriptionText String False

The transcription text.

Type String False

The type of the transcription.

Uri String False

The URI of the transcription.

PriceUnit String False

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

CData Cloud

Triggers

Create, update, delete, and query usage Triggers in Twilio.

Table-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
UsageCategory=
TriggerBy=
Recurring=

For example:

SELECT * FROM Triggers WHERE Sid = 'X123456789'

INSERT

To add a Trigger specify the UsageCategory, TriggerValue, and CallbackUrl. Other optional columns are Name, TriggerBy, Recurring, and CallbackMethod.

INSERT INTO Triggers (UsageCategory, TriggerValue, CallbackUrl, CallbackMethod, Name, Recurring, TriggerBy)
VALUES ('sms', 100, 'http://twilio.com/test', 'POST', 'trigger test', 'monthly', 'price')

UPDATE

Triggers allow UPDATEs for the Name, CallbackUrl, and CallbackMethod columns.

UPDATE Triggers SET Name = 'updated' WHERE Sid = 'X123456789'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

The Id of the trigger.

AccountSid String True

The account Id of the trigger.

DateCreated Datetime True

The creation date of the trigger.

DateUpdated Datetime True

The modification date of the trigger.

DateFired Datetime True

The fired date of the trigger.

Name String False

The friendly name of the trigger.

UsageCategory String False

The usage category the trigger watches. For example: calls, sms, phonenumbers, recordings, transcriptions, totalprice.

TriggerBy String False

The usage record field that the trigger is watching. Allowed values: count, usage, and price.

The allowed values are count, usage, price.

Recurring String False

The recurring interval of the trigger. Allowed values: daily, monthly, and yearly.

The allowed values are daily, monthly, yearly.

TriggerValue Double False

The value of the usage record field that will fire the trigger.

CurrentValue Double True

The current value of the field the trigger is watching.

CallbackUrl String False

The callback URL of the trigger, where Twilio makes a request when the trigger fires.

CallbackMethod String False

The HTTP method to be used to make requests to the callback URL.

UsageRecordUri String True

The URI of the usage record the trigger is watching.

Uri String True

The URI of the trigger.

ApiVersion String True

The API version of the trigger.

CData Cloud

VerificationServices

A Verification Service is the set of common configurations used to create and check verifications.

Table-Specific Information

SELECT

Returns a list of verification services.

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM VerificationServices;
SELECT * FROM VerificationServices WHERE Sid = 'VAc7f330c7bc7bdf9bd104b569529a483d'

INSERT

To add a VerificationService, you must specify the following parameters: Name.

INSERT INTO VerificationServices (LookupEnabled, Name, totpTimeStep) VALUES (true, 'testing', 20)

UPDATE


UPDATE VerificationServices SET Name = 'New Name' WHERE Sid = 'VAc7f330c7bc7bdf9bd104b569529a483d'

DELETE


DELETE FROM VerificationServices WHERE Sid = 'VAc7f330c7bc7bdf9bd104b569529a483d'

Columns

Name Type ReadOnly References Description
Sid [KEY] String True

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

AccountSid String True

The Id of the account that created the Service resource.

Name String False

The name that appears in the body of your verification messages.

CodeLength Integer False

The length of the verification code to generate.

LookupEnabled Boolean False

Whether to perform a lookup with each verification started and return info about the phone number.

Psd2Enabled Boolean False

Whether to pass PSD2 transaction parameters when starting a verification.

SkipSmsToLandlines Boolean False

Whether to skip sending SMS verifications to landlines.

DtmfInputRequired Boolean False

Whether to ask the user to press a number before delivering the verify code in a phone call.

DoNotShareWarningEnabled Boolean False

Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS.

CustomCodeEnabled Boolean False

Whether to allow sending verifications with a custom code instead of a randomly generated one.

VerifyEventSubscriptionEnabled Boolean False

Whether to allow verifications from the service to reach the stream-events sinks if configured.

TtsName String False

The name of an alternative text-to-speech service to use in phone calls.

Url String True

The absolute URL of the resource.

Links String True

The URLs of related resources.

DateCreated Datetime True

Date and time when the resource was created.

DateUpdated Datetime True

Date and time when the resource was updated.

PushApnCredentialSid String False

Optional configuration for the Push factors. Set the APN Credential for this service.

PushFcmCredentialSid String False

Optional configuration for the Push factors. Set the FCM Credential for this service.

PushIncludeDate Boolean False

Optional configuration for the Push factors. If true, include the date in the Challenge's response.

TotpCodeLength Integer False

Optional configuration for the TOTP factors. Number of digits for generated TOTP codes.

TotpIssuer String False

This will allow to configure the issuer of the TOTP URI.

TotpSkew Integer False

Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1.

The allowed values are 0, 1, 2.

TotpTimeStep Integer False

Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated.

WhatsappFrom String False

The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.

WhatsappMsgServiceSid String False

The SID of the Messaging Service containing WhatsApp Sender(s).

PasskeysAuthenticatorAttachment String False

This is the type of authenticator that will be used to create Passkeys.

The allowed values are platform, cross-platform, any.

PasskeysDiscoverableCredentials String False

Indicates whether credentials must be discoverable by the authenticator.

The allowed values are required, preferred, discouraged.

PasskeysUserVerification String False

This is the type of user verification that will be used to create Passkeys.

The allowed values are required, preferred, discouraged.

PasskeysRelyingPartyId String False

The Relying Party ID for Passkeys. This is the domain of your application.

PasskeysRelyingPartyName String False

The Relying Party Name for Passkeys. This is the name of your application.

PasskeysRelyingPartyOrigin String False

The Relying Party Name for Passkeys. This is the origin of your application.

DefaultTemplateSid String False

The default message template. Will be used for all SMS verifications unless explicitly overriden. SMS channel only.

CData Cloud

VoiceInsightsSettings

Query and update the Voice Insights monitoring configuration for an account.

Table-Specific Information

The VoiceInsightsSettings view exposes the Voice Insights monitoring configuration for an account. It allows you to query and update whether Advanced Features and Voice Trace are enabled.

SELECT

No filters are required to query VoiceInsightsSettings. The view returns the current settings for the authenticated account.

SELECT * FROM VoiceInsightsSettings

UPDATE

You can update the following columns: AdvancedFeatures and VoiceTrace. Specify AccountSid in the WHERE clause to identify the account.

UPDATE VoiceInsightsSettings SET AdvancedFeatures = true, VoiceTrace = true WHERE AccountSid = 'ACd0bc704eda2aaec142ef7b75eedf2e10'

Columns

Name Type ReadOnly References Description
AccountSid [KEY] String True

The unique SID identifier of the account.

AdvancedFeatures Boolean False

Indicates whether Advanced Features for Voice Insights are enabled.

VoiceTrace Boolean False

Indicates whether Voice Trace is enabled.

Url String True

The URL of this resource.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Twilio Views

Name Description
Alerts An Alert resource instance represents a single log entry for an error or warning encountered when Twilio makes a webhook request.
AvailableNumbers Represents a phone number currently available for purchase via the Twilio Global Catalog API.
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.
CallSummary This resource provides an overview of metadata and quality metrics for a single call.
ConferenceParticipantsSummary A Conference Summary provides an overview for a conference Call.
ConferenceSummary A Conference Summary provides an overview for a conference 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.
Events An Event resource represents an operational or error event generated by Twilio.
OutboundPhoneNumberReport A read-only view of Voice Insights metrics aggregated per outbound phone number handle for a previously generated report. Requires a ReportId returned by the GenerateOutboundPhoneNumberReport stored procedure.
PricingPhoneNumbers This resource represents the Twilio phone number prices for a given country, separated by phone number type.
UsageRecords Query Usage Records in Twilio.

CData Cloud

Alerts

An Alert resource instance represents a single log entry for an error or warning encountered when Twilio makes a webhook request.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Id=
DateCreated=, >, <, >=, <=
LogLevel=

For example, the following queries are processed server-side:

SELECT * FROM Alerts;
SELECT * FROM Alerts WHERE Sid = 'AE4fbfad32d9c0ba07007f25f03a22ca9f';

Columns

Name Type References Description
Sid [KEY] String The unique string that we created to identify the Alert resource.
AccountSid String The Id of the account that created the alert.
AlertText String The text of the alert.
ApiVersion String The API version used when the alert was generated. Can be empty for events that don't have a specific API version.
DateCreated Datetime Date and time when the resource was created.
DateGenerated Datetime The date and time in GMT when the alert was generated. Due to buffering, this can be different than created date.
DateUpdated Datetime Date and time when the resource was updated.
ErrorCode String error code for the condition that generated the alert.
LogLevel String The log level of the alert. Possible values are error, warning, notice, or debug.

The allowed values are error, warning, notice, debug.

MoreInfo String The URL of the page in our Error Dictionary with more information about the error condition.
ResourceSid String SID of the resource for which the alert was generated.
Url String The absolute URL of the Alert resource.
ServiceSid String The SID of the service or resource that generated the alert.
RequestVariables String The variables passed in the request that generated the alert.
ResponseBody String The response body of the request that generated the alert.
ResponseHeaders String The response headers of the request that generated the alert.
RequestHeaders String The request headers of the request that generated the alert.

CData Cloud

AvailableNumbers

Represents a phone number currently available for purchase via the Twilio Global Catalog API.

View-Specific Information

Represents a phone number currently available for purchase via the Twilio Global Catalog API. Includes pricing, lifecycle status, regulatory requirements, geographic metadata, and detailed Voice, SMS, and MMS capability information.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • Type supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM AvailableNumbers;

SELECT * FROM AvailableNumbers where Type = 'tollfree';

Columns

Name Type References Description
PhoneNumber [KEY] String The available phone number in E.164 format.
BaseSetupPrice Decimal The one-time setup fee required to purchase this phone number.
BaseRecurringPrice Decimal The recurring monthly fee for maintaining this phone number.
Type String The classification of the phone number (e.g., local, mobile, toll-free, national).
Lifecycle String Indicates the availability status of the number (for example: generally_available, beta, restricted).
CapabilitiesVoiceInboundConnectivity Boolean Indicates whether inbound voice calls can be received.
CapabilitiesVoiceOutboundConnectivity Boolean Indicates whether outbound voice calls can be initiated.
CapabilitiesVoiceE911 Boolean Indicates whether emergency calling (E911) is supported.
CapabilitiesVoiceFax Boolean Indicates whether fax transmission is supported.
CapabilitiesVoiceSipTrunking Boolean Indicates whether the number supports SIP trunking integration.
CapabilitiesVoiceCallsPerSecond Integer Maximum number of voice calls allowed per second.
CapabilitiesVoiceConcurrentCallsLimit Integer Maximum number of concurrent active voice calls supported.
CapabilitiesVoiceLongRecordLength Integer Maximum supported voice recording duration in seconds.
CapabilitiesVoiceInboundCalledDtmf Boolean Indicates whether DTMF tones from the called party are supported.
CapabilitiesVoiceInboundCallerDtmf Boolean Indicates whether DTMF tones from the calling party are supported.
CapabilitiesVoiceInboundCallerIdPreservation String Describes how caller ID is preserved for inbound calls.
CapabilitiesVoiceInboundReachability String Defines the geographic or network scope for inbound voice calls.
CapabilitiesSmsInboundConnectivity Boolean Indicates whether inbound SMS messages can be received.
CapabilitiesSmsOutboundConnectivity Boolean Indicates whether outbound SMS messages can be sent.
CapabilitiesSmsGsm7 Boolean Indicates support for GSM-7 character encoding for SMS.
CapabilitiesSmsUcs2 Boolean Indicates support for UCS-2 character encoding for SMS.
CapabilitiesSmsGsm7Concatenation Boolean Indicates whether concatenated GSM-7 SMS messages are supported.
CapabilitiesSmsUcs2Concatenation Boolean Indicates whether concatenated UCS-2 SMS messages are supported.
CapabilitiesSmsInboundSenderIdPreservation String Describes how sender ID is preserved for inbound SMS messages.
CapabilitiesSmsInboundReachability String Defines the geographic or network scope for inbound SMS delivery.
CapabilitiesSmsInboundMps Integer Maximum inbound SMS messages per second supported.
CapabilitiesMmsInboundConnectivity Boolean Indicates whether inbound MMS messages can be received.
CapabilitiesMmsOutboundConnectivity Boolean Indicates whether outbound MMS messages can be sent.
CapabilitiesMmsInboundReachability String Defines the geographic or network scope for inbound MMS delivery.
CapabilitiesMmsInboundMps Integer Maximum inbound MMS messages per second supported.
RegulatoryAddressRequirements String Indicates whether regulatory address documentation is required before purchasing this number.
GeographyIsoCountry String The ISO 3166-1 alpha-2 country code associated with the number.
GeographyLata String The Local Access and Transport Area (LATA) for the number, if applicable.
GeographyRateCenter String The rate center associated with the phone number.
GeographyLatitude Double Latitude coordinate of the phone number's geographic location.
GeographyLongitude Double Longitude coordinate of the phone number's geographic location.
GeographyRegion String The state or province abbreviation associated with the number.
GeographyLocality String The city or locality associated with the number.
GeographyPostalCode String The postal or ZIP code associated with the number.

CData Cloud

AvailablePhoneNumbers

Query the local, mobile, and toll-free phone numbers available in Twilio.

View-Specific Information

You can use this view to search for local, toll-free, and mobile phone numbers that are available for you to purchase. You can search for phone numbers by specifying a pattern, country, area code (NPA) or exchange (NXX), or geography.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: IsoCountry and Category are required in the WHERE clause.

ColumnSupported Operators
IsoCountry=
Category=
PhoneNumber=, CONTAINS
AreaCode=
CapabilitiesVoice=
CapabilitiesSms=
CapabilitiesMms=
Beta=
Lata=
RateCenter=
PostalCode=
Region=
Distance=
NearNumber=
NearLatLong=
FaxEnabled=

For example, the following queries are processed server-side:

SELECT * FROM AvailablePhoneNumbers WHERE IsoCountry = 'US' AND Category = 'Local'

You can also use the PhoneNumber column to search for phone numbers that match a specific pattern using the CONTAINS function. Note that the CONTAINS function requires the input value to be more than one character.

SELECT * FROM AvailablePhoneNumbers WHERE IsoCountry = 'US' AND Category = 'Local' AND CONTAINS(PhoneNumber, '1626')

Columns

Name Type References Description
PhoneNumber [KEY] String 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 The friendly name of the available phone number.
Lata String The LATA of the available phone number.
RateCenter String The rate center of the available phone number.
Latitude Double The latitude of the available phone number.
Longitude Double The longitude of the available phone number.
Region String The region of the available phone number.
PostalCode String The postal code of the available phone number.
IsoCountry String The ISO country code in ISO 3166-1 alpha-2 format ('US' for United States, 'CA' for Canada, 'GB' for United Kingdom).
AddressRequirements String The address requirements of the available phone number. Eligible values are: none, any, local, or foreign.

The allowed values are none, any, local, foreign.

Beta Boolean Whether the phone number is a beta number new to the Twilio platform.
CapabilitiesVoice Boolean Whether the phone number has voice capabilities.
CapabilitiesSms Boolean Whether the phone number has SMS capabilities.
CapabilitiesMms Boolean Whether the phone number has MMS capabilities.
Locality String The locality/city of this phone number.
CapabilitiesFax Boolean Whether the available phone number supports fax.

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
ExcludeAllAddressRequired Boolean 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 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 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 Integer The area code of the available phone number.
Category String The category of the available phone number. Possible values are: Local,Mobile,Tollfree.

The allowed values are Local, Mobile, Tollfree.

NearNumber String Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles.
NearLatLong String Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles.
Distance Integer The search radius for available phone numbers. Default is 25 miles. Max is 500 miles.
FaxEnabled Boolean Whether the phone numbers can receive faxes. Can be: true or false.

CData Cloud

CallEvents

The call events resource provides programmatic access to call progress and SDK events for a provided call SID.

View-Specific Information

The call events resource provides metadata on SDK events for specific user over a call.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: CallSid is required in order to query CallEvents.

  • CallSid supports the = operator.
  • Edge supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM CallEvents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM Callevents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Edge = 'sdk_edge'

Columns

Name Type References Description
CallSid String

Calls.Sid

Call SID for the call the events are associated with.
AccountSid String The account SID this call belongs to.
CarrierEdge String Represents the connection between Twilio and our immediate carrier partners.
ClientEdgeMetadataEdgeLocation String Represents the edge location value for Twilio media gateway for Client calls.
ClientEdgeMetadataRegion String Represents the edge location value for Twilio media gateway for Client calls.
Edge String The edge reporting the event.
Group String Event group.
Level String Detail level.
Name String Event name.
SdkEdgeMetadataClientName String The Voice SDK client name running locally in the browser or in the application.
SdkEdgeMetadataCountryCode String The Voice SDK country_code running locally in the browser or in the application.
SdkEdgeMetadataIpAddress String The Voice SDK ip_address running locally in the browser or in the application.
SdkEdgeMetadataLocationLat Double The Voice SDK lattitude of location running locally in the browser or in the application.
SdkEdgeMetadataLocationLon Double The Voice SDK longitude value of location client running locally in the browser or in the application.
SdkEdgeMetadataSdkDeviceArch String The Voice SDK device arch of client running locally in the browser or in the application.
SdkEdgeMetadataSdkDeviceModel String The Voice SDK device model of client running locally in the browser or in the application.
SdkEdgeMetadataSdkDeviceType String The Voice SDK device type of client running locally in the browser or in the application.
SdkEdgeMetadataSdkDeviceVendor String The Voice SDK device vendor of client running locally in the browser or in the application.
SdkEdgeMetadataSdkEdgeLocation String The Voice SDK edge_location running locally in the browser or in the application.
SdkEdgeMetadataSdkOSName String The Voice SDK OS name running locally in the browser or in the application.
SdkEdgeMetadataSdkOSVersion String The Voice SDK OS version running locally in the browser or in the application.
SdkEdgeMetadataSdkPlatform String The Voice SDK platform of the application.
SdkEdgeMetadataSdkSelectedRegion String The Voice SDK selected_region of client in the application.
SdkEdgeMetadataSdkType String The Voice SDK of the application.
SdkEdgeMetadataSdkVersion String The Voice SDK version of the application.
SipEdge String Represents the Twilio media gateway for SIP interface and SIP trunking calls.
Timestamp Datetime Event time.

CData Cloud

CallMetrics

The call metrics resource provides an overview of metadata and quality metrics for a provided call.

View-Specific Information

The call metrics resource provides an overview of metadata and quality metrics for a provided call.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: CallSid is required in order to query CallMetrics.

  • CallSid supports the = operator.
  • Edge supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Edge = 'carrier_edge'

Columns

Name Type References Description
CallSid String

Calls.Sid

SID for the call.
AccountSid String The account SID this call belongs to.
CarrierEdgecodec Integer Contains Carrier edge codec value for the Twilio media gateway of a PSTN call.
CarrierEdgecodec_name String Contains Carrier edge codec_name value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativeJitterAvg Double Contains Carrier edge jitter average value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativeJitterMax Double Contains Carrier edge jitter max value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativePacketDelayVariationD300 Integer Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativePacketDelayVariationD50 Integer Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativePacketDelayVariationD70 Integer Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativePacketsLost Integer Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call.
CarrierEdgecumulativePacketsReceived Integer Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call.
CarrierEdgeintervalPacketsLossPercentage Integer Contains Carrier edge packets_loss_percentage value for the Twilio media gateway of a PSTN call.
CarrierEdgeintervalPacketsLost Integer Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call.
CarrierEdgeintervalPacketsReceived Integer Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call.
CarrierEdgemetadataEdgeLocation String Contains Carrier edge location info for the Twilio media gateway of a PSTN call.
CarrierEdgemetadataRegion String Contains Carrier edge region info for the Twilio media gateway of a PSTN call.
ClientEdge String Contains metrics and properties for the Twilio media gateway of a Client call.
Direction String Defines media stream direction from the perspective of the Twilio Media edge.
Edge String Represents the Twilio Media Edge the metric was captured on.
SdkEdge String Contains metrics and properties for the SDK sensor library for Client calls.
SipEdge String Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
Timestamp Datetime Timestamp of metric sample.

CData Cloud

CallSummary

This resource provides an overview of metadata and quality metrics for a single call.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • CallSid supports the = operator.
  • ProcessingState supports the = operator. Note: ProcessingState values are case-sensitive. Valid values are partial and complete.

For example:

SELECT * FROM CallSummary

SELECT * FROM CallSummary WHERE CallSid = 'CAa123'

SELECT * FROM CallSummary WHERE CallSid = 'CAa123' AND ProcessingState = 'partial'

Columns

Name Type References Description
CallSid [KEY] String

Calls.Sid

SID for the call.
AccountSid String The account SID this call belongs to.
AttributesConferenceParticipant Boolean Contains call-flow specific details.
CallState String Status of the call.
CallType String Describes the call type.
CarrierEdgeMetricsInboundCodec Integer RTP profile number for the media codec for inbound stream.
CarrierEdgeMetricsInboundCodecName String Name of the media codec for inbound stream.
CarrierEdgeMetricsInboundJitterAvg Double Average jitter detected for inbound stream.
CarrierEdgeMetricsInboundJitterMax Double Max jitter detected for inbound stream.
CarrierEdgeMetricsInboundPacketsLossPercentage Double Percentage of packets lost for inbound stream.
CarrierEdgeMetricsInboundPacketsLost Integer Count of packets lost for inbound stream.
CarrierEdgeMetricsInboundPacketsReceived Integer Count of packets received; inbound container only.
CarrierEdgeMetricsOutBoundCodec Integer RTP profile number for the media codec for outbound stream.
CarrierEdgeMetricsOutBoundCodecName String Name of the media codec for outbound stream.
CarrierEdgeMetricsOutBoundJitterAvg Double Average jitter detected for outbound stream.
CarrierEdgeMetricsOutBoundJitterMax Double Max jitter detected for outbound stream.
CarrierEdgeMetricsOutBoundPacketDelayVariation Integer Distribution of packets delayed by a certain value.
CarrierEdgeMetricsOutBoundPacketsLossPercentage Double Percentage of packets lost for outbound stream.
CarrierEdgeMetricsOutBoundPacketsLost Integer Count of packets lost for outbound stream.
CarrierEdgeMetricsOutBoundPacketsSent Integer Count of packets sent.
CarrierEdgePropertiesDirection String Direction of media flow from the perspective of the edge. Inbound or outbound.
CarrierEdgePropertiesEdgeLocation String The Twilio edge location where media was handled.
CarrierEdgePropertiesMediaRegion String The Twilio region where media was handled.
CarrierEdgePropertiesSignalingRegion String The Twilio region where signaling was handled.
ClientEdge String Contains metrics and properties for the Twilio media gateway of a Client call.
ConnectDuration Integer Duration between when the call was answered and when it ended.
Duration Integer Duration between when the call was initiated and the call was ended.
EndTime Datetime Call end time.
FromCaller String The calling party.
FromCarrier String Serving carrier of destination.
FromConnection String landline, mobile, voip.
FromCountryCode String Two-letter ISO country code.
FromLocationLat Double Lat for number prefix.
FromLocationLon Double long for number prefix.
FromNumberPrefix String E.164 country code + three digits.
ProcessingState String Represents the summarization state of the resource.

The allowed values are complete, partial.

PropertiesDirection String Contains edge-agnostic call-level details.
PropertiesDisconnectedBy String 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 Estimated time in milliseconds between when a Programmable Voice call is created and when the call actually begins.
PropertiesLastSipResponseNum Integer The numeric value of the last SIP response received for the call.
PropertiesPddMs Integer Post-dial delay in milliseconds.
SdkEdgeMetricsInboundAudioInAvg Double Avg level for microphone audio.
SdkEdgeMetricsInboundAudioInMax Double Max level for microphone audio.
SdkEdgeMetricsInboundAudioOutAvg Double Avg level for speaker audio.
SdkEdgeMetricsInboundAudioOutMax Double Max level for speaker audio.
SdkEdgeMetricsInboundJitterAvg Double Average jitter detected.
SdkEdgeMetricsInboundJitterMax Double Max jitter detected.
SdkEdgeMetricsInboundMosAvg Double 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 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 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 Percentage of packets lost for inbound stream.
SdkEdgeMetricsInboundPacketsLost Integer Count of packets lost for inbound stream.
SdkEdgeMetricsInboundPacketsReceived Integer Count of packets received; inbound container only.
SdkEdgeMetricsInboundRttAvg Double 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 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 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 RTP profile number for the media codec for outbound stream.
SdkEdgeMetricsOutBoundCodecName String Name of the media codec for outbound stream.
SdkEdgeMetricsOutBoundPacketsSent Integer Count of packets sent.
SdkEdgePropertiesAppBuildNumber String Twilio SDK build version.
SdkEdgePropertiesAppCompileSdkVersion String Twilio SDK version.
SdkEdgePropertiesAppId String App Id for the Twilio SDK.
SdkEdgePropertiesAppMinOSVersion String Min Operating system version to the SDK.
SdkEdgePropertiesAppName String App name for the SDK.
SdkEdgePropertiesAppTargetOSVersion String Target Operating system version to the SDK.
SdkEdgePropertiesAppVersion String App version for the SDK.
SdkEdgePropertiesDirection String Direction of media flow from the perspective of the edge. Inbound or outbound.
SdkEdgePropertiesDisconnectedBy String 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 landline, mobile, voip.
SdkEdgePropertiesEventsGroupsGetUserMedia Integer Get user media count.
SdkEdgePropertiesEventsGroupsIceConnectionState Integer Event group ice connection state value.
SdkEdgePropertiesEventsGroupsIceGatheringState Integer Event group ice connection gathering value.
SdkEdgePropertiesEventsGroupsNetworkInformation Integer Event group network information.
SdkEdgePropertiesEventsGroupsSignalingState Integer Signalling state of the Event groups.
SdkEdgePropertiesEventsLevelsDEBUG Integer Count of events by severity-debug for the call.
SdkEdgePropertiesEventsLevelsINFO Integer Count of events by severity-info for the call.
SdkEdgePropertiesSettingsDscp Boolean Indicates whether DSCP was enabled.
SdkEdgePropertiesSettingsIceRestartEnabled Boolean Indicates if ICE restart was enabled.
SipEdge String Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
StartTime Datetime Call start time.
Tags String Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
ToCallee String The called party.
ToCarrier String Serving carrier of destination.
ToConnection String landline, mobile, voip.
ToCountryCode String Two-letter ISO country code.
ToLocationLat Double Lat for number prefix.
ToLocationLon Double Long for number prefix.
ToNumberPrefix String E.164 country code + three digits.
TrustBrandedCallBrandSid String Contains trusted communications details including Branded Call and verified caller ID.
TrustBrandedCallBranded Boolean Boolean. Indicates if branding details were successfully displayed on the destination device.
TrustBrandedCallBrandedChannelSid String Branded channel SID.
TrustBrandedCallCaller String Caller ID provided.
TrustBrandedCallUseCase String Use case for the call.
TrustVerifiedCallerVerified Boolean Boolean. Indicates if the caller ID provided has been verified; e.g. SHAKEN/STIR A attestation.
Url String The URL of the Voice Insights Summary for this call.
AnsweredBy String Specifies which entity answered the call. One of: human, machine, or unknown.

The allowed values are human, machine, unknown.

CreatedTime Datetime The date and time when the call was created.
Annotation String The annotation associated with the call.

CData Cloud

ConferenceParticipantsSummary

A Conference Summary provides an overview for a conference Call.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: ConferenceSid is required to fetch data.

ColumnSupported Operators
Label=
ConferenceSid=
ParticipantSid=

For example, the following queries are processed server-side:

SELECT * FROM ConferenceParticipantsSummary WHERE ConferenceSid = 'CF5fc41d7970eb504f89a27d91a0c31350';

Columns

Name Type References Description
ParticipantSid [KEY] String SID for this participant.
ConferenceSid String The unique SID identifier of the Conference.
CallSid String Unique SID identifier of the call that generated the Participant resource.
AccountSid String The Id of the account that created this Conference resource.
Label String The user-specified label of this participant.
CallDirection String Call direction of the participant; inbound or outbound.

The allowed values are inbound, outbound.

From String Caller ID of the calling party.
To String Called party.
CallStatus String Call status of the call that generated the participant.

The allowed values are answered, completed, busy, fail, noanswer, ringing, canceled.

CountryCode String ISO alpha-2 country code of the participant based on caller ID or called number.
IsModerator Boolean Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
JoinTime Datetime ISO 8601 timestamp of participant join event.
LeaveTime Datetime ISO 8601 timestamp of participant leave event.
DurationSeconds Integer Participant durations in seconds.
OutboundQueueLength Integer Add Participant API only. Estimated time in queue at call creation.
OutboundTimeInQueue Integer Add Participant API only. Actual time in queue in seconds.
JitterBufferSize String The Jitter Buffer Size of this Conference Participant.

The allowed values are large, small, medium, off..

IsCoach Boolean Indicated whether participant was a coach.
CoachParticipants String Call SIDs coached by this participant.
ParticipantRegion String Twilio region where the participant media was mixed.

The allowed values are us1, us2, ie1, de1, sg1, br1, au1, jp1, in1.

ConferenceRegion String Twilio region where the conference media was mixed.

The allowed values are us1, us2, ie1, de1, sg1, br1, au1, jp1, in1.

CallType String The Call Type of this Conference Participant.

The allowed values are carrier, client, sip.

ProcessingState String Processing state for the Conference Summary resource.

The allowed values are complete, in_progress, timeout.

PropertiesStartConferenceOnEnter Boolean Indicates whether the participant was configured to start the conference upon entering.
PropertiesEndConferenceOnExit Boolean Indicates whether the conference was set to end when this participant exited.
PropertiesPlayEarlyMedia Boolean Indicates whether early media was played to the participant before joining the conference.
PropertiesEnterMuted Boolean Indicates whether the participant joined the conference in muted state.
PropertiesBeepOnEnter Boolean Indicates whether a beep sound was played when the participant entered the conference.
PropertiesBeepOnExit Boolean Indicates whether a beep sound was played when the participant exited the conference.
MetricsInboundTotalPacketsLost Integer Total number of inbound RTP packets lost during the participant's session.
MetricsInboundTotalPacketsReceived Integer Total number of inbound RTP packets successfully received during the session.
MetricsInboundPacketLossPercentage Decimal Percentage of inbound RTP packets lost during the session.
MetricsInboundJitterAvg Decimal Average inbound network jitter experienced during the session.
MetricsInboundJitterMax Decimal Maximum inbound network jitter experienced during the session.
MetricsInboundLatencyAvg Decimal Average inbound network latency during the session.
MetricsInboundLatencyMax Decimal Maximum inbound network latency during the session.
MetricsInboundMos Decimal Mean Opinion Score (MOS) representing inbound audio quality for the participant.
MetricsOutboundTotalPacketsLost Integer Total number of outbound RTP packets lost during the participant's session.
MetricsOutboundTotalPacketsReceived Integer Total number of outbound RTP packets successfully sent during the session.
MetricsOutboundPacketLossPercentage Decimal Percentage of outbound RTP packets lost during the session.
MetricsOutboundJitterAvg Decimal Average outbound network jitter during the session.
MetricsOutboundJitterMax Decimal Maximum outbound network jitter during the session.
MetricsOutboundLatencyAvg Decimal Average outbound network latency during the session.
MetricsOutboundLatencyMax Decimal Maximum outbound network latency during the session.
MetricsOutboundMos Decimal Mean Opinion Score (MOS) representing outbound audio quality for the participant.
EventsMute String Indicates mute/unmute events triggered for the participant during the conference.
EventsHold String Indicates hold/unhold events triggered for the participant during the conference.
Url String The URI of this resource.

CData Cloud

ConferenceSummary

A Conference Summary provides an overview for a conference Call.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Status=
FriendlyName=
EndReason=
MixerRegion=
Sid=
DateCreated=, >, <, >=, <=

For example, the following queries are processed server-side:

SELECT * FROM ConferenceSummary;

SELECT * FROM ConferenceSummary where Sid = 'CF5843bda0e992d145a0c989a33e2ba7d0';

Columns

Name Type References Description
Sid [KEY] String The unique string that we created to identify this conference resource.
AccountSid String The Id of the account that created this Conference resource.
Name String A string that you assigned to describe this conference room.
DateCreated Datetime Date and time when the resource was created.
StartTime Datetime Date and time when the conference was started.
EndTime Datetime Date and time when the conference was ended.
DurationSeconds Integer Conference duration in seconds.
ConnectDurationSeconds Integer Duration of the between conference start event and conference end event in seconds.
Status String Status of this conference.

The allowed values are in_progress, not_started, completed, summary_timeout.

MaxParticipants Integer Maximum number of concurrent participants as specified by the configuration.
MaxConcurrentParticipants Integer Actual maximum number of concurrent participants in the conference.
UniqueParticipants Integer Unique conference participants based on caller ID.
EndReason String Conference end reason; e.g. last participant left, modified by API, etc.

The allowed values are last_participant_left, conference_ended_via_api, participant_with_end_conference_on_exit_left, last_participant_kicked, participant_with_end_conference_on_exit_kicked.

EndedBy String Call SID of the participant whose actions ended the conference.
Region String Twilio region where the conference media was mixed.

The allowed values are us1, us2, ie1, de1, sg1, br1, au1, jp1, in1.

MixerRegionRequested String Twilio region where conference mixed was specified to be mixed in configuration.

The allowed values are us1, us2, ie1, de1, sg1, br1, au1, jp1, in1.

RecordingEnabled Boolean Boolean. Indicates whether recording was enabled at the conference mixer.
DetectedIssuesCallQuality Integer Potential issues detected by Twilio during the conference with call qualtiy.
DetectedIssuesRegionConfiguration Integer Potential issues detected by Twilio during the conference with region configuration.
DetectedIssuesParticipantBehavior Integer Potential issues detected by Twilio during the conference with participant behavior.
Tags String Tags for detected conference conditions and participant behaviors which may be of interest.
Url String The URI of this resource.
Links String Contains a dictionary of URL links to nested resources of this Conference.
ProcessingState String Processing state for the Conference Summary resource.

The allowed values are complete, in_progress, timeout.

TagInfo String The call SID that caused the conference to end.

CData Cloud

ConversationMessages

ConversationMessage includes metadata of the Messages sent over a conversation.

View-Specific Information

Each Conversation includes a list of the Messages that they have sent amongst each other and an array of objects that describe the Message's media.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: ConversationSid is required in order to query ConversationMessages.

  • ConversationSid supports the = operator.
  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'MGd452e64de7dff2465702495ed6048e84'

Columns

Name Type References Description
Sid [KEY] String A 34 character string that uniquely identifies this resource.
AccountSid String The unique ID of the Account responsible for this message.
ConversationSid String

Conversations.Sid

The unique ID of the Conversation for this message.
AttributesImportance String A string metadata field you can use to store any data you wish.
Author String The channel specific identifier of the message's author.
Body String The content of the message, can be up to 1,600 characters long.
DateCreated Datetime The date that this resource was created.
DateUpdated Datetime The date that this resource was last updated.
DeliveryDelivered String An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryFailed String An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryRead String An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliverySent String An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryTotal Integer An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryUndelivered String An object that contains the summary of delivery statuses for the message to non-chat participants.
Index Integer The index of the message within the Conversation.
LinksDeliveryReceipts String Contains an absolute API resource URL to access the delivery & read receipts of this message.
Media String An array of objects that describe the Message's media.
ParticipantSid String The unique ID of messages's author participant.
Url String An absolute API resource API URL for this message.
ContentSid String The unique ID of the multi-channel Rich Content template.
LinksChannelMetadata String Contains an absolute API resource URL to access the delivery & read receipts of this message.

CData Cloud

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.

View-Specific Information

Each participant in a Conversation represents one real (probably human) participant in a Conversation. Participant joins with the conversation, and the connected person will receive all subsequent messages.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

Note: ConversationSid is required in order to query ConversationParticipants.

  • ConversationSid supports the = operator.
  • Sid supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM ConversationParticipants WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM ConversationParticipants WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195'

Columns

Name Type References Description
Sid [KEY] String A 34 character string that uniquely identifies this resource.
AccountSid String The unique ID of the Account responsible for this participant.
AttributesRole String An optional string metadata field you can use to store any data.
ConversationSid String

Conversations.Sid

The unique ID of the Conversation for this participant.
DateCreated Datetime The date that this resource was created.
DateUpdated Datetime The date that this resource was last updated.
Identity String A unique string identifier for the conversation participant as Conversation User.
MessagingBindingAddress String Information about how this participant exchanges messages with the conversation.
MessagingBindingProxyAddress String Information about how this participant exchanges messages with the conversation.
MessagingBindingType String Information about how this participant exchanges messages with the conversation.
RoleSid String The SID of a conversation-level Role to assign to the participant.
Url String An absolute API resource URL for this participant.
LastReadMessageIndex Integer Index of last “read” message in the Conversation for the Participant.
LastReadTimestamp Datetime Timestamp of last “read” message in the Conversation for the Participant.

CData Cloud

Conversations

Conversation includes a list of current Participants and the Messages that they have sent amongst each other.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Sid=
State=
DateCreated=, >, >=, <, <=

For example:

SELECT * FROM Conversations WHERE Sid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM Conversations WHERE State = 'active'

SELECT * FROM Conversations WHERE DateCreated = '2015-12-16T22:18:37' AND DateCreated <= '2015-12-16T22:18:38'

Columns

Name Type References Description
Sid [KEY] String A 34 character string that uniquely identifies this resource.
AccountSid String The unique ID of the Account responsible for this conversation.
AttributesTopic String An optional string metadata field you can use to store any data.
ChatServiceSid String The unique ID of the Conversation Service this conversation belongs to.
DateCreated Datetime The date that this resource was created.
DateUpdated Datetime The date that this resource was last updated.
FriendlyName String The human-readable name of this conversation, limited to 256 characters. Optional.
LinksMessages String Contains absolute URLs to access the participants of this conversation.
LinksParticipants String Contains absolute URLs to access the participants of this conversation.
MessagingServiceSid String The unique ID of the Messaging Service this conversation belongs to.
State String Current state of this conversation.

The allowed values are active, inactive, closed.

TimersDateClosed Datetime Timer date values representing state update for this conversation.
TimersDateInactive Datetime Timer date values representing state update for this conversation.
UniqueName String An application-defined string that uniquely identifies the resource.
Url String An absolute API resource URL for this conversation.
Bindings String Binding conversation.
LinksWebhooks String Contains absolute URLs to access the webhooks of this conversation.
LinksExport String Contains absolute URLs to export this conversation.

CData Cloud

Events

An Event resource represents an operational or error event generated by Twilio.

View-Specific Information

An Event resource represents an operational or error event generated by Twilio.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
EventType=
ResourceSid=
SourceIpAddress=
Sid=
EventDate=, >, <, >=, <=

For example, the following queries are processed server-side:

SELECT * FROM Events;

SELECT * FROM Events WHERE Sid = 'AE4fbfad32d9c0ba07007f25f03a22ca9f';

Columns

Name Type References Description
Sid [KEY] String The unique string that Twilio created to identify this Event resource.
AccountSid String The Account SID associated with the event.
ActorSid String The SID of the actor that triggered the event.
ActorType String The type of actor that triggered the event.
EventType String The type of event that occurred.
Description String A human-readable description of the event.
ResourceSid String The SID of the resource related to this event.
ResourceType String The type of resource related to this event.
Source String The source that generated the event.
SourceIpAddress String The IP address from which the event originated.
EventDate Datetime The date and time when the event occurred.
Links String Related resource links for the event.
Url String The absolute URL of the resource that was affected.
EventData String The absolute URL of the resource that was affected.

CData Cloud

OutboundPhoneNumberReport

A read-only view of Voice Insights metrics aggregated per outbound phone number handle for a previously generated report. Requires a ReportId returned by the GenerateOutboundPhoneNumberReport stored procedure.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
ReportId=

ReportId is required in the WHERE clause. It is returned by the GenerateOutboundPhoneNumberReport stored procedure, which defaults to the last 7 days when no time range is specified.

For example:

SELECT * FROM OutboundPhoneNumberReport WHERE ReportId = 'voiceinsights_report_00000000000000000000000000'

Columns

Name Type References Description
ReportId String The unique report identifier returned by the GenerateOutboundPhoneNumberReport stored procedure. Required in WHERE clause.
Handle String Outbound phone number handle represented in the report.
TotalCalls Integer Total number of outbound calls made during the report period.
CallAnswerScore Double Score (0-100) representing how often outbound calls were answered.
SilentCallsPercentage Double Percentage of calls with silence tags over total calls. A silent tag is indicative of a connectivity issue or muted audio.
ShortDurationCallsPercentage Double Percentage of completed outbound calls under 6 seconds. More than 15% is typically indicative of low trust.
LongDurationCallsPercentage Double Percentage of outbound calls lasting 60 seconds or longer.
PotentialRobocallsPercentage Double Percentage of completed outbound calls to unassigned or unallocated phone numbers.
CallsByDeviceTypeMobile Integer Number of outbound calls placed from a mobile device type.
CallsByDeviceTypeVoip Integer Number of outbound calls placed from a VoIP device type.
CallsByDeviceTypeLandline Integer Number of outbound calls placed from a landline device type.
CallsByDeviceTypeUnknown Integer Number of outbound calls placed from an unknown device type.
AnswerRateDeviceTypeMobile Double Answer rate percentage for outbound calls placed from a mobile device type.
AnswerRateDeviceTypeVoip Double Answer rate percentage for outbound calls placed from a VoIP device type.
AnswerRateDeviceTypeLandline Double Answer rate percentage for outbound calls placed from a landline device type.
AnswerRateDeviceTypeUnknown Double Answer rate percentage for outbound calls placed from an unknown device type.
CallStatePercentageBusy Double Percentage of outbound calls that ended with a busy state.
CallStatePercentageCanceled Double Percentage of outbound calls that ended with a canceled state.
CallStatePercentageCompleted Double Percentage of outbound calls that ended with a completed state.
CallStatePercentageFail Double Percentage of outbound calls that ended with a failed state.
CallStatePercentageNoAnswer Double Percentage of outbound calls that ended with a no-answer state.
BlockedCallsByCarrier String JSON array with metrics for completed outbound calls blocked by downstream carriers (e.g. ATT, T-Mobile, Verizon in the US).
AnsweringMachineDetectionTotalCalls Integer Total number of calls analyzed for answering machine detection.
AnsweringMachineDetectionAnsweredByHumanPercentage Double Percentage of analyzed calls answered by a human.
AnsweringMachineDetectionAnsweredByMachinePercentage Double Percentage of analyzed calls answered by a machine.

CData Cloud

PricingPhoneNumbers

This resource represents the Twilio phone number prices for a given country, separated by phone number type.

View-Specific Information

This resource represents the Twilio phone number prices for a given country, separated by phone number type.

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

  • IsoCountry supports the = operator.

For example, the following queries are processed server-side:

SELECT * FROM PricingPhoneNumbers;

SELECT * FROM PricingPhoneNumbers WHERE IsoCountry = 'US';

Columns

Name Type References Description
IsoCountry [KEY] String The iso code of the country.
Country String The name of the country.
Url String The absolute URL of the resource.
PriceUnit String The currency in which prices are measured.
PhoneNumberPrices String The list of PhoneNumberPrice records.

CData Cloud

UsageRecords

Query Usage Records in Twilio.

View-Specific Information

SELECT

The Cloud uses the Twilio API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the Cloud.

ColumnSupported Operators
Category=
StartDate=, >, >=, <, <=
EndDate=, >, >=, <, <=
Interval=

Note: Interval should be used as an escaped string, i.e [Interval].

For example, the following queries are processed server-side:

SELECT * FROM UsageRecords WHERE [Interval] = 'Today'

Columns

Name Type References Description
AccountSid String The account Id of the usage record.
Category String The category of the usage record. For example, calls, sms, phonenumbers, recordings, transcriptions, and totalprice.
Description String The description of the usage record.
StartDate Date The start date of the usage record. You can also specify an offset, such as -30days.
EndDate Date The end date of the usage record. You can also specify an offset, such as -1year.
Count Integer The number of usage events. For example: the number of calls.
CountUnit String The type of the usage events counted. For example: calls and messages.
Usage Double The amount of usage.
UsageUnit String The usage unit. For example: minutes and messages.
Price Decimal The total price of the usage.
PriceUnit String The currency of the price.
ApiVersion String The API version of the usage record.
Uri String The URI of the usage record.
AsOf Datetime Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00
SubresourceUris String A list of related resources identified by their URIs. For more information, see List Subresources.

Pseudocolumns

Pseudocolumn fields can be used in SELECT, INSERT, and UPDATE statements to provide additional control over data retrieval and modification in the data source.

Name Type Description
Interval String 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

The allowed values are Daily, Monthly, Yearly, AllTime, Today, Yesterday, LastMonth, ThisMonth.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Twilio.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Twilio, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Twilio Stored Procedures

Name Description
AddOutgoingCallerIds Adds a new CallerId to your account.
AddParticipants Adds a Participant to a Conference.
AddRecording Starts a new recording on a live call.
DownloadMedia Downloads a media file attached to a Twilio message. Returns the file content as Base64, writes it to a local path, or streams it to an output stream.
GenerateOutboundPhoneNumberReport Generates a Voice Insights Outbound Phone Number Report and returns the report identifier. The report aggregates Voice Insights metrics for outbound calls, defaulting to the last 7 days when no time range is provided. The returned ReportId can be used with the OutboundPhoneNumberReport view to fetch the report data. Reports are available for 5 days after creation.
ModifyParticipants Updates the status of a Participant in an active Conference.
SendMessage Send outgoing SMS messages from your Twilio phone number to mobile phones around the globe.
UpdateRecording Updates a recording on a live call.

CData Cloud

AddOutgoingCallerIds

Adds a new CallerId to your account.

Stored Procedure-Specific Information

To add an outgoing caller ID, specify PhoneNumber in E.164 format. Twilio initiates a validation call to the number; enter the ValidationCode returned by the procedure to complete verification:
EXEC AddOutgoingCallerIds PhoneNumber='+16175551212'

To delay the validation call or dial an extension, use the optional inputs:

EXEC AddOutgoingCallerIds PhoneNumber='+16175551212', CallDelay='5', Extension='1234', Name='My Caller ID'

Input

Name Type Required Description
PhoneNumber String True The phone number to verify. Should be formatted with a + and country code; e.g., +16175551212 (E.164 format). Twilio will also accept unformatted US numbers; e.g., (415) 555-1212, 415-555-1212.
CallDelay String False The number of seconds between 0 and 60 to delay before initiating the verification call.
Extension String False Digits to dial after connecting the verification call.
StatusCallback String False The URL that Twilio will pass status parameters to.
StatusCallbackMethod String False The HTTP method Twilio should use to make requests to the status callback URL.
Name String False The name of the outgoing caller Id. By default, this is a formatted phone number.

Result Set Columns

Name Type Description
AccountSid String The unique Id of the Account to which the validation request belongs.
PhoneNumber String The incoming phone number being validated, formatted with a + and country code; e.g., +16175551212.
Name String The name you provided, if any.
ValidationCode String The 6-digit validation code that must be entered via the phone to validate this phone number for caller Id.
CallSid String The unique Id of the call created for this validation attempt.

CData Cloud

AddParticipants

Adds a Participant to a Conference.

Stored Procedure-Specific Information

Adds a Participant to a Conference. Specify the target conference by setting ConferenceSid to either a conference SID or a friendly name.

If you set ConferenceSid to a friendly name that does not exist, the Cloud creates a new conference with that name and adds the participant.

If you set ConferenceSid to a conference SID that does not exist, this procedure fails. The following example specifies the target conference by its friendly name:

EXEC AddParticipants ConferenceSid = 'MyConference', From = '+18149044818', To = '919602968074'

Input

Name Type Required Description
ConferenceSid String True The SID of the participant's conference.
From String True The phone number, Client identifier, or username portion of SIP address that made this call.
To String True The phone number, SIP address, Client, TwiML App identifier that received this call.
StatusCallback String False The URL we should call using the status_callback_method to send status information to your application
StatusCallbackMethod String False The HTTP method we should use to call status_callback. Can be: GET and POST and defaults to POST
StatusCallbackEvent String False The conference state changes that should generate a call to status_callback.
Label String False A label for this participant.
WaitTime Integer False The number of seconds that we should allow the phone to ring before assuming there is no answer.
Record Boolean False Whether to record the participant and their conferences, including the time between conferences.
Muted Boolean False Whether the agent is muted in the conference.
Beep String False Whether to play a notification beep to the conference when the participant joins.
StartConferenceOnEnter Boolean False Whether to start the conference when the participant joins, if it has not already started.
EndConferenceOnExit Boolean False Whether to end the conference when the participant leaves.
WaitUrl String False The URL that Twilio calls using the wait_method before the conference has started.
WaitMethod String False The HTTP method we should use to call wait_url.
EarlyMedia Boolean False Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages.
MaxParticipants Integer False The maximum number of participants in the conference. Can be a positive integer from 2 to 250.
ConferenceRecord String False Whether to record the conference the participant is joining.
ConferenceTrim String False Whether to trim leading and trailing silence from the conference recording.
ConferenceStatusCallback String False The URL we should call using the conference_status_callback_method when the conference events in conference_status_callback_event occur.
ConferenceStatusCallbackMethod String False The HTTP method we should use to call conference_status_callback.
ConferenceStatusCallbackEvent String False The conference state changes that should generate a call to conference_status_callback.
RecordingChannels String False The recording channels for the final recording.
RecordingStatusCallback String False The URL that we should call using the recording_status_callback_method when the recording status changes.
RecordingStatusCallbackMethod String False The HTTP method we should use when we call recording_status_callback.
Region String False The region where we should mix the recorded audio
ConferenceRecordingStatusCallback String False The URL we should call using the conference_recording_status_callback_method when the conference recording is available.
ConferenceRecordingStatusCallbackMethod String False The HTTP method we should use to call conference_recording_status_callback.
RecordingStatusCallbackEvent String False The recording state changes that should generate a call to recording_status_callback.
ConferenceRecordingStatusCallbackEvent String False The conference recording state changes that generate a call to conference_recording_status_callback.
Coaching Boolean False Whether the participant is coaching another call.
CallSidToCoach String False The SID of the participant who is being coached.
JitterBufferSize String False Jitter buffer size for the connecting participant.
Byoc String False The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with.
CallerId String False The phone number, Client identifier, or username portion of SIP address that made this call.
CallReason String False The Reason for the outgoing call.
RecordingTrack String False The audio track to record for the call.
TimeLimit Integer False The maximum duration of the call in seconds.
MachineDetection String False Whether to detect if a human, answering machine, or fax has picked up the call.
MachineDetectionTimeout Integer False The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy of unknown.
MachineDetectionSpeechThreshold Integer False The number of milliseconds that is used as the measuring stick for the length of the speech activity.
MachineDetectionSpeechEndThreshold Integer False The number of milliseconds of silence after speech activity at which point the speech activity is considered complete.
MachineDetectionSilenceTimeout Integer False The number of milliseconds of initial silence after which an unknown AnsweredBy result will be returned.
AmdStatusCallback String False The URL that we should call using the amd_status_callback_method to notify customer application whether the call was answered by human, machine or fax.
AmdStatusCallbackMethod String False The HTTP method we should use when calling the amd_status_callback URL.
Trim String False Whether to trim any leading and trailing silence from the participant recording.
CallToken String False A token string needed to invoke a forwarded call.
ClientNotificationUrl String False The URL that we should use to deliver push call notification.
CallerDisplayName String False The name that populates the display name in the From header.

Result Set Columns

Name Type Description
AccountSid String The SID of the Account that created the Participant resource.
CallSid String The SID of the Call the Participant resource is associated with.
ConferenceSid String The SID of the conference the participant is in.
Status String The status of the participant's call in a session.

CData Cloud

AddRecording

Starts a new recording on a live call.

Stored Procedure-Specific Information

To run this procedure, you must specify the following parameter: CallSid. For example:
EXEC AddRecording CallSid = 'CA6cc04c10ed3cb8fa6b77c00b16560cbb', RecordingStatusCallbackEvent = 'in-progress', RecordingStatusCallback = 'https://myapp.com/recording-events', RecordingStatusCallbackMethod = 'POST', Trim = 'do-not-trim', RecordingChannels = 'mono', RecordingTrack='both'

Input

Name Type Required Description
CallSid String True The SID of the call to associate the recording with.
RecordingStatusCallbackEvent String False The recording status events on which to call the recording_status_callback URL. Allowed values are:in-progress,completed,absent
RecordingStatusCallback String False The URL to call using the recording_status_callback_method on each recording event specified in recording_status_callback_event.
RecordingStatusCallbackMethod String False The HTTP method to use when calling recording_status_callback. Allowed values are: POST,GET
Trim String False Indicates whether to trim any leading and trailing silence in the recording. Allowed values are: trim-silence,do-not-trim
RecordingChannels String False The number of channels used in the recording. Allowed values are: mono,dual
RecordingTrack String False The audio track to record for the call. Allowed values are: inbound,outbound,both

Result Set Columns

Name Type Description
Success String Indicates whether the recording was created successfully.
AccountSid String The unique Id of the account associated with the recording.
Sid String The unique string that identifies the recording resource.
CallSid String The SID of the call the recording resource is associated with. This always refers to the parent leg of a two-leg call.
ConferenceSid String The conference SID that identifies the conference associated with the recording, if a conference recording.

CData Cloud

DownloadMedia

Downloads a media file attached to a Twilio message. Returns the file content as Base64, writes it to a local path, or streams it to an output stream.

Stored Procedure-Specific Information

Downloads a media file attached to a Twilio message. To run this procedure, you must specify MessageSid and MediaSid.

By default, the procedure returns the file content as Base64 in the FileData output column. Specify LocalPath to write the file to disk instead, or use FileStream to stream the file data to an output stream. The following example returns the media file as Base64:

EXEC DownloadMedia MessageSid = 'MM5246efb7f153081c77630d6351e3d36f', MediaSid = 'MEf8e6341f75a8a24e56b73ffe50a5985a'
The following example writes the media file to a specific file path:
EXEC DownloadMedia MessageSid = 'MM5246efb7f153081c77630d6351e3d36f', MediaSid = 'MEf8e6341f75a8a24e56b73ffe50a5985a', LocalPath = 'C:/media/image.png'

Input

Name Type Required Description
MessageSid String True The SID of the message containing the media.
MediaSid String True The SID of the media file to download.
LocalPath String False The local path to write the downloaded file to. Specify a full file path to write to an exact location. If not specified, the file data is returned as Base64.

Result Set Columns

Name Type Description
FileData String The Base64-encoded file content. Populated when LocalPath and FileStream are not provided.
Status String Stored Procedure Execution Status

CData Cloud

GenerateOutboundPhoneNumberReport

Generates a Voice Insights Outbound Phone Number Report and returns the report identifier. The report aggregates Voice Insights metrics for outbound calls, defaulting to the last 7 days when no time range is provided. The returned ReportId can be used with the OutboundPhoneNumberReport view to fetch the report data. Reports are available for 5 days after creation.

Stored Procedure-Specific Information

Generates a Voice Insights Outbound Phone Number Report and returns the report identifier. No parameters are required; by default the report covers the last 7 days. The returned ReportId can be used with the OutboundPhoneNumberReport view to retrieve the report data.

The following example generates a report using default settings:

EXEC GenerateOutboundPhoneNumberReport

The following example generates a report for a specific time range:

EXEC GenerateOutboundPhoneNumberReport StartDatetime = '2024-10-01 00:00:00', EndDatetime = '2024-10-31 23:59:59'

The following example filters results by call state and limits the number of phone numbers in the report:

EXEC GenerateOutboundPhoneNumberReport StartDatetime = '2024-10-01 00:00:00', EndDatetime = '2024-10-31 23:59:59', CallState = 'completed,noanswer', Size = 10

Input

Name Type Required Description
StartDatetime Datetime False Start date and time of the report in ISO 8601 format. If omitted, defaults to 7 days before EndDatetime.
EndDatetime Datetime False End date and time of the report in ISO 8601 format. Cannot be in the future. If omitted, defaults to the current time.
Size Integer False Maximum number of phone numbers to include in the report.
CallState String False Comma-separated list of call states to filter by.
CallDirection String False Comma-separated list of call directions to filter by.
CallType String False Comma-separated list of call types to filter by.
TwilioRegions String False Comma-separated list of Twilio region identifiers to filter by.
CallerCountryCode String False Comma-separated list of ISO 3166-1 alpha-2 caller country codes to filter by.
CalleeCountryCode String False Comma-separated list of ISO 3166-1 alpha-2 callee country codes to filter by.
Silent Boolean False Silent call flag values to filter by.

Result Set Columns

Name Type Description
Success String Indicates whether the report was generated successfully.
ReportId String The unique report identifier. Use this value with the OutboundPhoneNumberReport view to fetch report data.
Status String The status of the report generation. Can be: created, running, or completed.

CData Cloud

ModifyParticipants

Updates the status of a Participant in an active Conference.

Stored Procedure-Specific Information

Updates the status of a Participant in an active Conference. To update the status, you must specify the following Parameters: ConferenceSid, CallSid. For example:

EXEC ModifyParticipants ConferenceSid = 'MyConference', CallSid = 'CA6cc04c10ed3cb8fa6b77c00b16560cbb', Muted = true;

Input

Name Type Required Description
ConferenceSid String True The SID of the participant's conference.
CallSid String True The Call SID or label of the participant to update.
Muted Boolean False Whether the agent is muted in the conference.
Hold Boolean False Whether the participant should be on hold.
HoldUrl String False The URL we call using the hold_method for music that plays when the participant is on hold.
HoldMethod String False The HTTP method we should use to call hold_url.
AnnounceUrl String False The URL we call using the announce_method for an announcement to the participant.
AnnounceMethod String False The HTTP method we should use to call announce_url.
WaitUrl String False The URL that Twilio calls using the wait_method before the conference has started.
WaitMethod String False The HTTP method we should use to call wait_url.
BeepOnExit Boolean False Whether to play a notification beep to the conference when the participant exits.
Coaching Boolean False Whether the participant is coaching another call.
EndConferenceOnExit Boolean False Whether to end the conference when the participant leaves.
CallSidToCoach String False The SID of the participant who is being coached.

Result Set Columns

Name Type Description
AccountSid String The SID of the Account that created the Participant resource.
CallSid String The SID of the Call the Participant resource is associated with.
ConferenceSid String The SID of the conference the participant is in.
Status String The status of the participant's call in a session.

CData Cloud

SendMessage

Send outgoing SMS messages from your Twilio phone number to mobile phones around the globe.

Stored Procedure-Specific Information

To run this procedure, you must specify From, To, and at least one of Body or ContentTemplateSid.

To send a plain text message, specify Body:

EXEC SendMessage From='12243318812', To='18777804236', Body='Hello from Twilio'

To send a Content template, specify ContentTemplateSid. Optionally pass ContentTemplateVariables to supply values for the placeholders defined in the template:

EXEC SendMessage From='12243318812', To='18777804236', ContentTemplateSid='HXdbb2d39ce55b1a1c33c6e52200c2030f';
EXEC SendMessage From='12243318812', To='18777804236', ContentTemplateSid='HXdbb2d39ce55b1a1c33c6e52200c2030f', ContentTemplateVariables='{"1":"Owl Air Customer"}';

Input

Name Type Required Description
From String True The phone number or sender Id that sent the message.
Body String False The body of the message.
To String True The phone number the message was sent to.
ContentTemplateSid String False The SID of the Content Template to use when sending the message.
ContentTemplateVariables String False A JSON object containing values for the variables defined in the content template.
StatusCallback String False By including a StatusCallback URL in your API call, you can tell Twilio where to POST information about your message.

Result Set Columns

Name Type Description
Status String Sucess Message that represents message is sent.
AccountSid String Account Sid.
APIVersion String Version of the API.
Body String Message body.
DateCreated String Date created.
DateSent String Sent message date.
DateUpdated String Message updated date.
Direction String Direction.
ErrorCode String Error code in case message is not sent.
ErrorMessage String Error message in case message is not sent.
From String Twilio phone number or messaging service that sends this message.
MessagingServiceSid String Messaging service sid.
NumMedia String Num media.
NumSegments String Num segments.
Price String Price.
PriceUnit String Price Unit.
Sid String Sid.
SubresourceUrisMedia String Subresource media urls.
To String PhoneNumber on which messaging is sent.
Uri String Uri.

CData Cloud

UpdateRecording

Updates a recording on a live call.

Stored Procedure-Specific Information

To run this procedure, you must specify the following parameters: Status, CallSid, and RecordingSid. For example:
EXEC UpdateRecording CallSid = 'CA6cc04c10ed3cb8fa6b77c00b16560cbb', Status = 'in-progress', RecordingSid = 'REXXc10ed3cb8fa6b77c00b16560cbbXX'

Input

Name Type Required Description
CallSid String True The SID of the call to associate the recording with.
RecordingSid String True The unique string that identifies the recording resource.
Status String True The status of the recording. Allowed values are: in-progress, paused, stopped, processing, completed, absent.
PauseBehavior String False The HTTP method to use when calling recording_status_callback. Allowed values are: skip, silence.

Result Set Columns

Name Type Description
Success String Indicates whether the recording was updated successfully.
AccountSid String The unique Id of the account associated with the recording.
Sid String The unique string that identifies the recording resource.
CallSid String The SID of the call the recording resource is associated with. This always refers to the parent leg of a two-leg call.
ConferenceSid String The conference SID that identifies the conference associated with the recording, if a conference recording.

CData Cloud

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Twilio:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.
IsInsertable Boolean Whether the table can be inserted into.
IsDeleteable Boolean Whether rows can be deleted from the table.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Applications table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'Applications' 

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.
ColumnCapabilities Int32 A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native Twilio procedure.

Pseudocolumns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Applications table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Applications' 
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported string functions.LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSSupported numeric functions.ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSSupported date/time functions.NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Twilio.
AccountSIDSpecifies the Account SID used to authenticate with Twilio.
AuthTokenSpecifies the authentication token used to authenticate with Twilio.
APIKeySIDSpecifies the SID of the API key used to authenticate with Twilio.
APIKeySecretSpecifies the secret of the API key used to authenticate with Twilio.

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
AuthSchemeSpecifies the type of authentication to use when connecting to Twilio.
AccountSIDSpecifies the Account SID used to authenticate with Twilio.
AuthTokenSpecifies the authentication token used to authenticate with Twilio.
APIKeySIDSpecifies the SID of the API key used to authenticate with Twilio.
APIKeySecretSpecifies the secret of the API key used to authenticate with Twilio.
CData Cloud

AuthScheme

Specifies the type of authentication to use when connecting to Twilio.

Possible Values

AuthToken, APIKey, OAuthClient

Data Type

string

Default Value

"AuthToken"

Remarks

The following authentication schemes are supported:

  • AuthToken: Authenticate using your Twilio Account SID and Auth Token.
  • APIKey: Authenticate using a Twilio API key SID and secret.
  • OAuthClient: Authenticate using the OAuth Client Credentials grant flow.

CData Cloud

AccountSID

Specifies the Account SID used to authenticate with Twilio.

Data Type

string

Default Value

""

Remarks

To find this value, open the Twilio Console Dashboard and locate the Account SID field in the Account Info section.

CData Cloud

AuthToken

Specifies the authentication token used to authenticate with Twilio.

Data Type

string

Default Value

""

Remarks

To find this value, open the Twilio Console Dashboard and locate the Auth Token field in the Account Info section.

CData Cloud

APIKeySID

Specifies the SID of the API key used to authenticate with Twilio.

Data Type

string

Default Value

""

Remarks

To generate an API key SID, open the Twilio Console Dashboard and navigate to Account Info > API Keys > Go to API Keys > Create API key.

CData Cloud

APIKeySecret

Specifies the secret of the API key used to authenticate with Twilio.

Data Type

string

Default Value

""

Remarks

The secret is displayed only once, on the Copy secret key page that appears after you click Create when generating an API key in the Twilio Console. Copy and store it securely before leaving that page, as it cannot be retrieved afterward.

CData Cloud

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770