Twilio Connector for CData Sync

Build 24.0.9175
  • Twilio
    • Establishing a Connection
    • Advanced Features
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Accounts
        • Applications
        • Calls
        • Feedback
        • FeedbackSummary
        • IncomingPhoneNumbers
        • Media
        • Messages
        • OutgoingCallerIds
        • Recordings
        • ServiceLists
        • Transcriptions
        • Triggers
      • Views
        • AvailablePhoneNumbers
        • CallEvents
        • CallMetrics
        • CallSummary
        • ConversationMessages
        • ConversationParticipants
        • Conversations
        • IncomingPhoneNumbersCategory
        • Services
        • UsageRecords
    • Connection String Options
      • Authentication
        • AuthScheme
        • AccountSID
        • AuthToken
        • APIKeySID
        • APIKeySecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Twilio Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Twilio data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Twilio connector can be used from the CData Sync application to pull data from Twilio and move it to any of the supported destinations.

Twilio Version Support

The Sync App uses the Twilio REST API.

Twilio Connector for CData Sync

Establishing a Connection

Adding a Connection to Twilio

To add a connection to Twilio:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Twilio icon is not available, click the Add More icon to download and install the Twilio connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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.

Twilio Connector for CData Sync

Advanced Features

This section details a selection of advanced features of the Twilio Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

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

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Twilio Connector for CData Sync

SSL Configuration

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Twilio Connector for CData Sync

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

Twilio Connector for CData Sync

Data Model

The CData Sync App 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 Sync App 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.

Twilio Connector for CData Sync

Tables

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

Twilio Connector for CData Sync 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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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 for CData Sync 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.

Twilio Connector for CData Sync

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 Indicates whether the response includes phone numbers which require any Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with an Address required.
ExcludeLocalAddressRequired Boolean Indicates whether the response includes phone numbers which require a local Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a local Address required.
ExcludeForeignAddressRequired Boolean Indicates whether the response includes phone numbers which require a foreign Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a foreign Address required.
AreaCode String The area code of the available phone number.
Category String The category of the available phone number. Possible values are: Local,Mobile,Tollfree.

The allowed values are Local, Mobile, Tollfree.

NearNumber String Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles.
NearLatLong String Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles.
Distance String The search radius for available phone numbers. Default is 25 miles. Max is 500 miles.

Twilio Connector for CData Sync

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

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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 The category of the phone number. Possible values are local,mobile and tollfree.

The allowed values are Local, Mobile, TollFree.

Twilio Connector for CData Sync

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.

Twilio Connector for CData Sync

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 The interval of records. Should be used as an escaped string in Where clause, i.e [Interval]. The allowed values are Daily, Monthly, Yearly, AllTime, Today, Yesterday, LastMonth, and ThisMonth

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

Twilio Connector for CData Sync

Connection String Options

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

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

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Twilio.
AccountSIDAccount SID of the currently authenticated user.
AuthTokenAuth token of the currently authenticated user.
APIKeySIDAPI Key SID of the currently authenticated user.
APIKeySecretAPI key secret of the currently authenticated user.

SSL


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

Firewall


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Twilio Connector for CData Sync

Authentication

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


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Twilio.
AccountSIDAccount SID of the currently authenticated user.
AuthTokenAuth token of the currently authenticated user.
APIKeySIDAPI Key SID of the currently authenticated user.
APIKeySecretAPI key secret of the currently authenticated user.
Twilio Connector for CData Sync

AuthScheme

The type of authentication to use when connecting to Twilio.

Remarks

  • AuthToken: Set to this to perform AuthToken authentication.
  • APIKey: Set to this to perform APIKey authentication.

Twilio Connector for CData Sync

AccountSID

Account SID of the currently authenticated user.

Remarks

Account SID of the currently authenticated user.

Twilio Connector for CData Sync

AuthToken

Auth token of the currently authenticated user.

Remarks

Auth token of the currently authenticated user.

Twilio Connector for CData Sync

APIKeySID

API Key SID of the currently authenticated user.

Remarks

API Key SID of the currently authenticated user.

Twilio Connector for CData Sync

APIKeySecret

API key secret of the currently authenticated user.

Remarks

API key secret of the currently authenticated user.

Twilio Connector for CData Sync

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
Twilio Connector for CData Sync

SSLServerCert

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

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.

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

Twilio Connector for CData Sync

Firewall

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


PropertyDescription
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.
Twilio Connector for CData Sync

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.

Protocol Default Port Description
TUNNEL 80 The port where the Sync App opens a connection to Twilio. Traffic flows back and forth via the proxy at this location.
SOCKS4 1080 The port where the Sync App opens a connection to Twilio. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5 1080 The port where the Sync App sends data to Twilio. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Twilio Connector for CData Sync

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Twilio Connector for CData Sync

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Twilio Connector for CData Sync

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Twilio Connector for CData Sync

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Twilio Connector for CData Sync

Proxy

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


PropertyDescription
ProxyAutoDetectSpecifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServerThe hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPortThe TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthSchemeSpecifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUserThe username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPasswordThe password associated with the user specified in the ProxyUser connection property.
ProxySSLTypeThe SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
Twilio Connector for CData Sync

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Twilio Connector for CData Sync

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Twilio Connector for CData Sync

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Twilio Connector for CData Sync

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NTLM: The Sync App retrieves an NTLM token.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Twilio Connector for CData Sync

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyUser
BASIC The user name of a user registered with the proxy server.
DIGEST The user name of a user registered with the proxy server.
NEGOTIATE The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

Twilio Connector for CData Sync

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value Value to set for ProxyPassword
BASIC The password associated with the proxy server user specified in ProxyUser.
DIGEST The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE The password associated with the Windows user account specified in ProxyUser.
NTLM The password associated with the Windows user account specified in ProxyUser.
NONE Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

Twilio Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

AUTODefault setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Twilio Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Twilio Connector for CData Sync

Logging

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


PropertyDescription
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
Twilio Connector for CData Sync

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Twilio Connector for CData Sync

Schema

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


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Twilio Connector for CData Sync

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Twilio Connector for CData Sync

BrowsableSchemas

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

Remarks

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

Twilio Connector for CData Sync

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Twilio Connector for CData Sync

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Twilio Connector for CData Sync

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
Twilio Connector for CData Sync

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Twilio Connector for CData Sync

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Twilio Connector for CData Sync

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

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

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Twilio Connector for CData Sync

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

Twilio Connector for CData Sync

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175