Saltar al contenido

Twilio Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8936 of the connector.

Get Started

Twilio Version Support

The connector uses the Twilio REST API.

Establish a Connection

Use the AccountSID and AuthToken connection properties to access data from your account. You obtain your live credentials on your Twilio account dashboard. Click Account -> Account Settings to obtain your test credentials.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Twilio connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Twilio and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

User Defined Views

The Twilio connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Applications WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

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

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The connector 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.

Tables

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

Twilio Connector Tables

Name Description
Accounts Create, update, and query Twilio Accounts belonging to the authenticated Account.
Applications Create, update, delete, and query the available Applications in Twilio.
Calls Delete and query connections between phones and Twilio.
Feedback Create and query Feedback on a Call in Twilio.
FeedbackSummary Create, delete, and query Feedback Summaries in Twilio.
IncomingPhoneNumbers Create, update, delete, and query phone numbers purchased from Twilio.
Media Delete and query Media in Twilio.
Messages Create, update, delete, and query SMS and MMS Messages in Twilio.
OutgoingCallerIds Insert, update, and query the verified numbers that may be used as a caller ID when making outgoing calls in Twilio.
Recordings Delete and query the available Recordings in Twilio.
ServiceLists Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.
Transcriptions Query the available Transcriptions in Twilio.
Triggers Create, update, delete, and query usage Triggers in Twilio.

Accounts

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Accounts are Name, Status, and Sid.

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.

Applications

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Applications are Name and Sid.

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 True 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.

Calls

Delete and query connections between phones and Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Sid are From, To, StartTime, EndTime, ParentCallSid, and Sid. StartTime and EndTime can be used with the >, >=, <, <=, or = conditions.

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

Twilio does not allow Calls to be added.

Update

Twilio does not allow Calls to be updated.

Delete
DELETE FROM Calls WHERE Sid = 'CAcdc741bdcc2ae'
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 True 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 True The phone number, SIP address, or client identiifer 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 True The status of the call. One of the following values: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer. 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.

Feedback

Create and query Feedback on a Call in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available column for Feedback is only Sid and it is required in WHERE clause.

SELECT * FROM Feedback WHERE Sid = 'F123456789'
Insert

To add a CallFeedback, specify at least QualityScore and Sid. Column Issues is optional.

INSERT INTO Feedback (Sid, QualityScore) VALUES ('X95487143505', 1)
Update

Twilio does not allow Feedback records to be updated.

Delete

Twilio does not allow Feedback records to be deleted.

Columns
Name Type ReadOnly References Description
Sid [KEY] String False The ID of the call.
AccountSid String True The account ID associated with the feedback.
QualityScore Integer False The quality score, represented on a scale of 1 (very poor) to 5 (perfect). The allowed values are 1, 2, 3, 4, 5.
Issues String False Any issues experienced during the call. Allowed values are imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, and one-way-audio. The allowed values are imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, one-way-audio.
DateCreated Datetime True The creation date of the feedback.
DateUpdated Datetime True The modification date of the feedback.

FeedbackSummary

Create, delete, and query Feedback Summaries in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. Only Sid is supported in the WHERE clause and it is required.

SELECT * FROM FeedbackSummary WHERE Sid = 'FS123456789'
Insert

To add a FeedbackSummary, specify at least these parameters: StartDate, EndDate, and IncludeSubaccounts.

INSERT INTO FeedbackSummary (StartDate, EndDate, IncludeSubaccounts) VALUES ('2014-06-01', '2014-06-30', true)
Update

Twilio does not allow FeedbackSummary to be updated.

Delete
DELETE FROM FeedbackSummary WHERE Sid = 'FS123456789'
Columns
Name Type ReadOnly References Description
Sid [KEY] String False The ID of the feedback summary.
StartDate Date False The start date of the feedback summary.
EndDate Date False The end date of the feedback summary.
AccountSid String True The account ID of the feedback summary.
IncludeSubaccounts Boolean False Whether to include subaccounts in feedback summary.
Status String True The status of the feedback summary. One of the following values: queued, in-progress, completed, or failed.
CallCount Integer True The total call count.
CallFeedbackCount Integer True The count of calls associated with the feedback summary.
QSAverage Double True The quality score average of the feedback summary.
QSMedian Double True The quality score median of the feedback avarage.
QSStandardDeviation Double True The quality score standard deviation of the feedback summary.
IssuesDescription String True The issues description of the feedback summary.
IssuesCount Integer True The issues count of the feedback summary.
IssuesPercentageOfTotalCalls Double True The percentage of calls that experienced this issue.
DateCreated Datetime True The creation date of the feedback summary.
DateUpdated Datetime True The modification date of the feedback summary.

IncomingPhoneNumbers

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbers are PhoneNumber, Name, Beta, and Sid.

SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'
Insert

To add an IncomingPhoneNumber, specify exactly one of the following parameters: PhoneNumber or AreaCode. If you include both parameters, Twilio will use the AreaCode parameter and ignore the PhoneNumber provided.

INSERT INTO IncomingPhoneNumbers (PhoneNumber, AreaCode) VALUES ('+15105555555', '123')
Update
UPDATE IncomingPhoneNumbers SET Name='appp8' WHERE Sid= 'X123456789'
Delete
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.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from 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.

Media

Delete and query Media in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The MessageSid column is required in the WHERE clause; Sid can be used with the = conditions and DateCreated is optional and can be used with the >, >=, <, <=, or = conditions.

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.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
MessageSid String The message ID of the media.

Messages

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Messages are Sender, To, DateSent, and Sid. DateSent may be used with the >, >=, <, <=, or = conditions.

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 messages.
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 True The status of the message. One of the following values: accepted, queued, sending, sent, failed, delivered, undelivered, receiving, or received.
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.
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.

OutgoingCallerIds

Insert, update, and query the verified numbers that may be used as a caller ID when making outgoing calls in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for OutgoingCallerIds are PhoneNumber, Name, and Sid.

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

Twilio does not allow OutgoingCallerIds to be deleted.

Columns
Name Type ReadOnly References Description
Sid [KEY] String True The ID of the outgoing caller Id.
AccountSid String True The account ID of the outgoing caller Id.
DateCreated Datetime True The creation date of the outgoing caller Id.
DateUpdated Datetime True The modfication 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.

Recordings

Delete and query the available Recordings in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Recordings are CallSid, DateCreated, and Sid. DateCreated may be used with the >, >=, <, <=, or = conditions.

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.

ServiceLists

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for ServiceLists are Sid, and ServiceSid.

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 and UniqueName.

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

Transcriptions

Query the available Transcriptions in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Transcriptions are RecordingSid and Sid.

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.

Triggers

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Triggers are Category, TriggerBy, UsageCategory, and Sid.

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.

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.

Twilio Connector Views

Name Description
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.
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.
IncomingPhoneNumbersCategory Query Twilio Incoming Phone Numbers and filter by Category.
Services A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists.
UsageRecords Query Usage Records in Twilio.

AvailablePhoneNumbers

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

Table Specific Information

You can use this table 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

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. IsoCountry and Category are required columns in the WHERE clause. Optional columns are AreaCode, CapabilitiesSms, CapabilitiesVoice, Beta, RateCenter, Lata, PostalCode, Distance, and PhoneNumber. PhoneNumber can be used with the LIKE condition.

SELECT * FROM AvailablePhoneNumbers WHERE IsoCountry = 'US' AND Category = 'Local'
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.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ExcludeAllAddressRequired Boolean
ExcludeLocalAddressRequired Boolean
ExcludeForeignAddressRequired Boolean
AreaCode String
Category String
NearNumber String
NearLatLong String
Distance String

CallEvents

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

Table Specific Information

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
Note: CallSid is required in order to query CallEvents.

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

CallMetrics

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

Table Specific Information

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallMetrics.

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.

CallSummary

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

Table Specific Information

The call summary resource provides an overview of metadata and quality metrics for a single call, which contains all the metadata information related to that call.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallSummary.

SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND ProcessingState = 'Partial'
Columns
Name Type References Description
CallSid 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.
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

ConversationMessages

ConversationMessage includes metadata of the Messages sent over a conversation.

Table 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

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationMessages.

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.

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.

Table 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

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationPartiticipants.

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.

Conversations

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

Table Specific Information

A Conversation is a unique thread of a conversation. each Conversation includes a list of current Participants and the Messages that they have sent amongst each other.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query Conversations.

SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b'

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

SELECT * FROM Conversations where State = 'active'

SELECT * FROM Conversations where DateCreated = '2015-12-16T22:18:37' and DateUpdated = '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.

IncomingPhoneNumbersCategory

Query Twilio Incoming Phone Numbers and filter by Category.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbersCategory are Category, PhoneNumber, Name, Beta, and Sid. The Category column must be specified in the WHERE clause.

SELECT * FROM IncomingPhoneNumbersCategory WHERE Category = 'Local'
Columns
Name Type References Description
Sid [KEY] String The ID of the phone number.
AccountSid String The account ID of the phone number.
Name String The friendly name of the phone number. By default, this is a formatted phone number.
PhoneNumber String The phone number in E.164 format.
VoiceUrl String The URL Twilio will request when the phone number receives a call.
VoiceMethod String The HTTP method Twilio will use to request the voice URL.
VoiceFallbackUrl String The URL Twilio will request when an error occurs requesting the voice URL.
VoiceFallbackMethod String The HTTP method Twilio will use to request the fallback voice URL.
VoiceCallerIdLookup Boolean Whether to look up the caller ID of the caller in the CNAM database.
DateCreated Datetime The creation date of the phone number.
DateUpdated Datetime The modification date of the phone number.
SmsUrl String The URL Twilio will request when someone sends an SMS message to the phone number.
SmsMethod String The HTTP method Twilio will use to request the SMS URL of the phone number.
SmsFallbackUrl String The URL Twilio will request when an error occurs requesting the SMS URL.
SmsFallbackMethod String The HTTP method Twilio will use to request the fallback SMS URL.
AddressRequirements String The address requirements of the phone number.
Beta Boolean Whether the phone number is a beta phone number new to Twilio.
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.
StatusCallback String The URL that Twilio pass status parameters to.
StatusCallbackMethod String The HTTP method Twilio will use to make requests to the status callback URL.
ApiVersion String The API version of the phone number.
VoiceApplicationSid String The voice application ID of the phone number. This can be used in place of the voice URLs.
SmsApplicationSid String The SMS application ID of the phone number. This can be used in place of the SMS URLs.
TrunkSid String The trunk ID of the phone number. This overrides the Voice_Application_Sid.
Uri String The URI of the phone number.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Category String

Services

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

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Services is Sid.

SELECT * FROM Services

SELECT * FROM Services WHERE Sid = 'IS5834ff94f011bc4e627a3'
Columns
Name Type References Description
Sid [KEY] String The unique string that Twilio's created to identify the Service resource.
AccountSid String Accounts.Sid The SID of the Account that created the Service resource.
UniqueName String An application-defined string that uniquely identifies the resource.
FriendlyName String The string that you assigned to describe the resource.
DateCreated Datetime The date and time when the service was created.
DateUpdated Datetime The date and time when the service was last updated.
Url String The absolute URL of the service.
WebhookUrl String The URL that gets called when Sync objects are manipulated.
WebhooksFromRestEnabled Boolean Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false.
AclEnabled Boolean Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
ReachabilityWebhooksEnabled Boolean Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false.
ReachabilityDebouncingEnabled Boolean 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 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 The URLs of related resources.

UsageRecords

Query Usage Records in Twilio.

Select

Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Triggers are Category, StartDate, EndDate, and Interval. StartDate and EndDate may be used with the >, >=, <, <=, or = conditions. Interval should be used as an escaped string, i.e [Interval].

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.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Interval String

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector 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.

Twilio Connector Stored Procedures

Name Description
AddOutgoingCallerIds Adds a new CallerId to your account.

AddOutgoingCallerIds

Adds a new CallerId to your account.

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.

SendMessage

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

Input
Name Type Required Description
From String True The phone number or sender ID that sent the message.
Body String True The body of the message.
To String True The phone number the message was sent to.
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.

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:

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 connector 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.

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.

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.

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.

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.

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.

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
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.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time 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.

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.

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.

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.

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.

sys_connection_props

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

When querying this table, the config connection string should be used:

jdbc:cdata:twilio:config:

This connection string enables you to query this table without a valid connection.

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.

sys_sqlinfo

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

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.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported 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_FUNCTIONS Supported 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_FUNCTIONS Supported 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_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A 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_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All 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_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates 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.

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.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

Property Description
AuthToken Auth token of the currently authenticated user.
AccountSID Account SID of the currently authenticated user.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
AuthToken Auth token of the currently authenticated user.
AccountSID Account SID of the currently authenticated user.

AuthToken

Auth token of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Auth token of the currently authenticated user.

AccountSID

Account SID of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Account SID of the currently authenticated user.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\Twilio Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\Twilio Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other These hidden properties are used only in specific use cases.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Applications WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.