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.
The Sync App uses the Twilio REST API.
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.
This section details a selection of advanced features of the Twilio Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
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).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
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.
The Sync App models the data in tables so that it can be easily queried and updated with standard SQL.
Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.
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.
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. |
Create, update, and query Twilio Accounts belonging to the authenticated Account.
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'
To add an Account, specify the Name field.
INSERT INTO Accounts (Name) VALUES ('test1')
Twilio allows updates for the Name and Status columns.
UPDATE Accounts SET Status = 'closed' WHERE Sid = 'X123456789'
Twilio does not allow Accounts to be deleted.
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. |
Create, update, delete, and query the available Applications in Twilio.
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'
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 Applications SET Name='appp8' WHERE Sid= 'ACab6788889df1432ae'
DELETE FROM Applications WHERE Sid = 'ACab6788889df1432ae'
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. |
Delete and query connections between phones and Twilio.
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'
Twilio does not allow Calls to be added.
Twilio does not allow Calls to be updated.
DELETE FROM Calls WHERE Sid = 'CAcdc741bdcc2ae'
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. |
Create and query Feedback on a Call in Twilio.
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'
To add a CallFeedback, specify at least QualityScore and Sid. Column Issues is optional.
INSERT INTO Feedback (Sid, QualityScore) VALUES ('X95487143505', 1)
Twilio does not allow Feedback records to be updated.
Twilio does not allow Feedback records to be deleted.
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. |
Create, delete, and query Feedback Summaries in Twilio.
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'
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)
Twilio does not allow FeedbackSummary to be updated.
DELETE FROM FeedbackSummary WHERE Sid = 'FS123456789'
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. |
Create, update, delete, and query phone numbers purchased from Twilio.
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'
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 IncomingPhoneNumbers SET Name='appp8' WHERE Sid= 'X123456789'
DELETE FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'
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 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. |
Delete and query Media in Twilio.
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'
Twilio does not allow Media to be added.
Twilio does not allow Media to be updated.
DELETE FROM Media WHERE MessageSid='MM319a82ae6d7411407ef7dc7d78eb2081' AND Sid='MS123456789'
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 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. |
Create, update, delete, and query SMS and MMS Messages in Twilio.
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'
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')
To update a Message record, the Body column must be empty.
UPDATE Messages SET Body = "" WHERE Sid = 'M1233455'
DELETE FROM Messages WHERE Sid = 'M123456789'
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. |
Insert, update, and query the verified numbers that may be used as a caller Id when making outgoing calls in Twilio.
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'
To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.
EXEC AddOutgoingCallerIds PhoneNumber = '+15105555555'
Twilio allows the Name column to be updated.
UPDATE OutgoingCallerIds SET Name = 'test' WHERE Sid = 'O123456789'
Twilio does not allow OutgoingCallerIds to be deleted.
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. |
Delete and query the available Recordings in Twilio.
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'
Twilio does not allow Recordings to be added.
Twilio does not allow Recordings to be updated.
DELETE FROM Recordings WHERE Sid='REfb1f22afc4f6243242'
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. |
Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.
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'
To add a ServiceList, specify at least the ServiceSid and UniqueName.
INSERT INTO ServiceLists (ServiceSid, UniqueName) VALUES ('ISbd3a2af64e5c39', 'Denis')
UPDATE ServiceLists SET TimeToLive = 10 WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'
DELETE FROM ServiceLists WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'
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. |
Query the available Transcriptions in Twilio.
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'
Twilio does not allow Transcriptions to be added.
Twilio does not allow Transcriptions to be updated.
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. |
Create, update, delete, and query usage Triggers in Twilio.
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'
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')
Triggers allow UPDATEs for the Name, CallbackUrl, and CallbackMethod columns.
UPDATE Triggers SET Name = 'updated' WHERE Sid = 'X123456789'
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the trigger. | |
AccountSid | String | True |
The account Id of the trigger. | |
DateCreated | Datetime | True |
The creation date of the trigger. | |
DateUpdated | Datetime | True |
The modification date of the trigger. | |
DateFired | Datetime | True |
The fired date of the trigger. | |
Name | String | False |
The friendly name of the trigger. | |
UsageCategory | String | False |
The usage category the trigger watches. For example: calls, sms, phonenumbers, recordings, transcriptions, totalprice. | |
TriggerBy | String | False |
The usage record field that the trigger is watching. Allowed values: count, usage, and price. The allowed values are count, usage, price. | |
Recurring | String | False |
The recurring interval of the trigger. Allowed values: daily, monthly, and yearly. The allowed values are daily, monthly, yearly. | |
TriggerValue | Double | False |
The value of the usage record field that will fire the trigger. | |
CurrentValue | Double | True |
The current value of the field the trigger is watching. | |
CallbackUrl | String | False |
The callback URL of the trigger, where Twilio makes a request when the trigger fires. | |
CallbackMethod | String | False |
The HTTP method to be used to make requests to the callback URL. | |
UsageRecordUri | String | True |
The URI of the usage record the trigger is watching. | |
Uri | String | True |
The URI of the trigger. | |
ApiVersion | String | True |
The API version of the trigger. |
Views 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.
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. |
Query the local, mobile, and toll-free phone numbers available in Twilio.
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.
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'
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 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. |
The call events resource provides programmatic access to call progress and SDK events for a provided call SID.
The call events resource provides metadata on SDK events for specific user over a call.
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'
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 |
The call metrics resource provides an overview of metadata and quality metrics for a provided call.
The call metrics resource provides an overview of metadata and quality metrics for a provided call.
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'
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. |
This resource provides an overview of metadata and quality metrics for a single call.
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.
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'
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 |
ConversationMessage includes metadata of the Messages sent over a conversation.
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.
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'
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. |
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.
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.
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'
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. |
Conversation includes a list of current Participants and the Messages that they have sent amongst each other.
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.
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'
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. |
Query Twilio Incoming Phone Numbers and filter by Category.
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'
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 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. |
A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists.
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'
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. |
Query Usage Records in Twilio.
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'
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 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. |
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.
Property | Description |
AuthToken | Auth token of the currently authenticated user. |
AccountSID | Account SID of the currently authenticated user. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AuthToken | Auth token of the currently authenticated user. |
AccountSID | Account SID of the currently authenticated user. |
Auth token of the currently authenticated user.
Auth token of the currently authenticated user.
Account SID of the currently authenticated user.
Account SID of the currently authenticated user.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
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.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that 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.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to Twilio and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your 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.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
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, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Twilio Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Applications WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.