Connection String OptionsBack To Top

AuthToken
AccountSID
SSLServerCert
FirewallType
FirewallServer
FirewallPort
FirewallUser
FirewallPassword
ProxyAutoDetect
ProxyServer
ProxyPort
ProxyAuthScheme
ProxyUser
ProxyPassword
ProxySSLType
ProxyExceptions
Logfile
Verbosity
LogModules
MaxLogFileSize
MaxLogFileCount
Location
BrowsableSchemas
Tables
Views
AutoCache
CacheDriver
CacheConnection
CacheLocation
CacheTolerance
Offline
CacheMetadata
BatchSize
ConnectionLifeTime
ConnectOnOpen
MaxRows
Other
PoolIdleTimeout
PoolMaxSize
PoolMinSize
PoolWaitTime
PseudoColumns
Readonly
RTK
SupportEnhancedSQL
Timeout
UseConnectionPooling

AuthToken

Data Type

string

Default Value

Remarks

Auth token of the currently authenticated user.

AccountSID

Data Type

string

Default Value

Remarks

Account SID of the currently authenticated user.

SSLServerCert

Data Type

string

Default Value

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


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

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

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

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

FirewallType

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver 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 driver opens a connection to Twilio and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the driver 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 driver 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.

FirewallServer

Data Type

string

Default Value

Remarks

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 driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

FirewallPort

Data Type

int

Default Value

Remarks

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.

FirewallUser

Data Type

string

Default Value

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

FirewallPassword

Data Type

string

Default Value

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

ProxyAutoDetect

Data Type

bool

Default Value

false

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

NOTE: When this property is set to True, the proxy used is determined as follows:

A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.

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

ProxyServer

Data Type

string

Default Value

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver 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 driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

ProxyPort

Data Type

int

Default Value

Remarks

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.

ProxyAuthScheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver 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:

BASIC: The driver performs HTTP BASIC authentication.
DIGEST: The driver performs HTTP DIGEST authentication.
NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

ProxyUser

Data Type

string

Default Value

Remarks

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

ProxyPassword

Data Type

string

Default Value

Remarks

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 driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

ProxySSLType

Data Type

string

Default Value

"AUTO"

Remarks

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

ProxyExceptions

Data Type

string

Default Value

Remarks

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

Note that the driver 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.

Logfile

Data Type

string

Default Value

Remarks

Once this property is set, the driver will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.

Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.

If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.

For more control over what is written to the log file, you can adjust the Verbosity property.

Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.

To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.

If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.

Java Logging

Java logging is also supported. To enable Java logging, set Logfile to:

Logfile=JAVALOG://myloggername

As in the above sample, JAVALOG:// is a required prefix to use Java logging, and you will substitute your own Logger.

The supplied Logger's getLogger method is then called, using the supplied value to create the Logger instance. If a logging instance already exists, it will reference the existing instance.

When Java logging is enabled, the Verbosity will now correspond to specific logging levels.

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

LogModules

Data Type

string

Default Value

Remarks

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.

MaxLogFileSize

Data Type

string

Default Value

"100MB"

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.

Adjust the maximum number of logfiles generated with MaxLogFileCount.

MaxLogFileCount

Data Type

int

Default Value

-1

Remarks

When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.

The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Adjust the maximum size of the logfiles generated with MaxLogFileSize.

Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Twilio Data Provider\\Schema"

Remarks

The path to a directory which contains the schema files for the driver (.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
Mac	~/Library/Application Support
Linux	~/.config

BrowsableSchemas

Data Type

string

Default Value

Remarks

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

Tables

Data Type

string

Default Value

Remarks

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

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

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

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

Views

Data Type

string

Default Value

Remarks

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

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

AutoCache

Data Type

bool

Default Value

false

Remarks

When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.

Setting the Caching Database

When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

CacheLocation: Specifies the path to the file store.
CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.

CacheDriver

Data Type

string

Default Value

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.

Note that you must also add the CacheDriver JAR file to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:

jdbc:twilio:CacheLocation='c:/Temp/cachedir';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:

jdbc:twilio:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

SQLite

The following is a JDBC URL for the SQLite JDBC driver:

jdbc:twilio:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

MySQL

The following is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:twilio:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

SQL Server

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:twilio:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

Oracle

The following is a JDBC URL for the Oracle Thin Client:

jdbc:twilio:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .

PostgreSQL

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:twilio:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

CacheConnection

Data Type

string

Default Value

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

Derby and Java DB

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]

For example, to cache to an in-memory database, use the following:

jdbc:derby:memory

SQLite

To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:

jdbc:sqlite:dataSource

Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

MySQL

The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache

The following are typical connection properties:

Server: The IP address or domain name of the server you want to connect to.
Port: The port that the server is running on.
User: The user name provided for authentication to the database.
Password: The password provided for authentication to the database.
Database: The name of the database.

SQL Server

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]

For example:

jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true

The following are typical SQL Server connection properties:

Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
Port: The port SQL Server is running on.
Database: The name of the SQL Server database.
Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
User Id: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.

Oracle

The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]

For example:

jdbc:oracle:thin:scott/tiger@myhost:1521:orcl

The following are typical connection properties:

Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
Password: The password provided for authentication with the Oracle database.
User Id: The user Id provided for authentication with the Oracle database.

PostgreSQL

The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]

For example, the following connection string connects to a database on the default host (localhost) and port (5432):

jdbc:postgresql:postgres

The following are typical connection properties:

Host: The address of the server hosting the PostgreSQL database.
Port: The port used to connect to the server hosting the PostgreSQL database.
Database: The name of the database.
User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
Password: The password provided for authentication with the PostgreSQL database.

CacheLocation

Data Type

string

Default Value

"%APPDATA%\\CData\\Twilio Data Provider"

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

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


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

CacheTolerance

Data Type

int

Default Value

600

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.

Offline

Data Type

bool

Default Value

false

Remarks

When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

CacheMetadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Twilio catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metadata changes often.
When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.

BatchSize

Data Type

int

Default Value

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

ConnectionLifeTime

Data Type

int

Default Value

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

ConnectOnOpen

Data Type

bool

Default Value

false

Remarks

When set to true, a connection will be made to Twilio when the connection is opened. This property enables the Test Connection feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Twilio and nothing from this initial connection is maintained.

Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).

MaxRows

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

Data Type

string

Default Value

Remarks

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

Specify multiple properties in a semicolon-separated list.

Caching Configuration


CachePartial=True	Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True	Passes the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting


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.

PoolIdleTimeout

Data Type

int

Default Value

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.

PoolMaxSize

Data Type

int

Default Value

100

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

PoolMinSize

Data Type

int

Default Value

Remarks

The minimum number of connections in the pool. The default is 1.

PoolWaitTime

Data Type

int

Default Value

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

PseudoColumns

Data Type

string

Default Value

Remarks

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

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

RTK

Data Type

string

Default Value

Remarks

The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

SupportEnhancedSQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to Twilio and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Twilio API.

Execution of Predicates

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

The driver retrieves all rows necessary to process the aggregation in memory.

Timeout

Data Type

int

Default Value

Remarks

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

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

UseConnectionPooling

Data Type

bool

Default Value

false

Remarks

This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

Accounts

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

Select

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

Insert

To add an Account, specify the Name field.

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

Update

Twilio allows updates for the Name and Status columns.

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

Delete

Twilio does not allow Accounts to be deleted.

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	True		The Id of the account.
DateCreated	Datetime	True		The creation date of the account.
DateUpdated	Datetime	True		The modification date of the account.
Name	String	False		The friendly name of the account.
OwnerAccountSid	String	True		The master account of the account.
AuthToken	String	True		The authentication token of the account.
Status	String	False		The status of the account. Allowed values are closed, suspended, and active. The allowed values are closed, suspended, active. The default value is active.
Type	String	True		The type of the account. Either Trial or Full.

Applications

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

Select

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')

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	True		The Id of the application.
DateCreated	Datetime	True		The creation date of the application.
DateUpdated	Datetime	True		The modification date of the application.
AccountSid	String	True		The account Id of the application.
Name	String	False		The friendly name of the application.
ApiVersion	String	True		The API version of the application.
VoiceUrl	String	False		The URL Twilio will request when a phone number assigned to the application receives a call.
VoiceFallbackUrl	String	False		The URL Twilio will request when an error occurs requesting the voice URL of the application.
VoiceFallbackMethod	String	False		The HTTP method to use to request the fallback voice URL of the application.
StatusCallback	String	False		The URL where Twilio will pass status parameters about calls received by phone numbers assigned to the application.
StatusCallbackMethod	String	False		The HTTP method that Twilio will use to make requests to the status callback URL of the application.
VoiceCallerIdLookup	String	False		Whether to look up the voice caller Id from the CNAM database for phone numbers assigned to this application.
VoiceMethod	String	False		The HTTP method Twilio will use to request the voice URL.
SmsUrl	String	False		The URL Twilio will request when a phone number assigned to the application receives an SMS message.
SmsMethod	String	False		The HTTP method Twilio will use to request the SMS URL of the application.
SmsFallbackUrl	String	False		The URL Twilio will request if an error occurs requesting the SMS URL.
SmsFallbackMethod	String	False		The HTTP method Twilio will use to request the fallback SMS URL of the application.
SmsStatusCallback	String	False		The URL where Twilio will POST to when an outgoing SMS request uses the Sid of the application.
MessageStatusCallback	String	False		The URL where status parameters are sent when you insert to the Messages table and specify the Sid of the application.
Uri	String	True		The URI of the application.

Calls

Delete and query connections between phones and Twilio.

Select

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

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

Insert

Twilio does not allow Calls to be added.

Update

Twilio does not allow Calls to be updated.

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	True		The Id of the call.
DateCreated	Datetime	True		The creation date of the call.
DateUpdated	Datetime	True		The modification date of the call.
ParentCallSid	String	True		The Id of the parent call.
AccountSid	String	True		The Id of the account that created the call.
To	String	True		The phone number, SIP address, or client identifier that is called.
ToFormatted	String	True		The formatted phone number, SIP address, or client identifier that is called.
From	String	True		The phone number, SIP address, or client identiifer that has made the call.
FromFormatted	String	True		The formatted number, SIP address, or client identifier that has made the call.
PhoneNumberSid	String	True		If the call was inbound, the Sid of the IncomingPhoneNumber that received the call. For an outbound call, the Sid of the OutgoingCallerId that made the call.
Status	String	True		The status of the call. One of the following values: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer. The allowed values are queued, ringing, in-progress, canceled, completed, failed, busy, no-answer.
StartTime	Datetime	True		The start time of the call. Empty if the call has not yet been dialed.
EndTime	Datetime	True		The end time of the call. Empty if the call did not complete successfully.
Duration	Integer	True		The duration of the call. Empty for busy, failed, unanswered, or ongoing calls.
Price	Decimal	True		The price of the call after the call is completed.
Direction	String	True		The direction of the call. One of the following values: inbound, outbound-api, or outbound-dial. The allowed values are inbound, outbound-api, outbound-dial.
AnsweredBy	String	True		One of the following values if the call was initiated with answering machine detection: human or machine. Empty otherwise.
ApiVersion	String	True		The API version of the call.
ForwardedFrom	String	True		The phone number that forwarded an incoming call. Note that the carrier must support forwarding.
CallerName	String	True		The caller name to a phone number that has Caller Id Lookup enabled.
Uri	String	True		The URI for the call.

Feedback

Create and query Feedback on a Call in Twilio.

Select

SELECT * FROM Feedback WHERE Sid = 'F123456789'

Insert

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

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

Update

Twilio does not allow Feedback records to be updated.

Delete

Twilio does not allow Feedback records to be deleted.

Columns


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

FeedbackSummary

Create, delete, and query Feedback Summaries in Twilio.

Select

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

SELECT * FROM FeedbackSummary WHERE Sid = 'FS123456789'

Insert

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

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

Update

Twilio does not allow FeedbackSummary to be updated.

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. The allowed values are true, false.
Status	String	True		The status of the feedback summary. One of the following values: queued, in-progress, completed, or failed.
CallCount	Integer	True		The total call count.
CallFeedbackCount	Integer	True		The count of calls associated with the feedback summary.
QSAverage	Double	True		The quality score average of the feedback summary.
QSMedian	Double	True		The quality score median of the feedback avarage.
QSStandardDeviation	Double	True		The quality score standard deviation of the feedback summary.
IssuesDescription	String	True		The issues description of the feedback summary.
IssuesCount	Integer	True		The issues count of the feedback summary.
IssuesPercentageOfTotalCalls	Double	True		The percentage of calls that experienced this issue.
DateCreated	Datetime	True		The creation date of the feedback summary.
DateUpdated	Datetime	True		The modification date of the feedback summary.

IncomingPhoneNumbers

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

Select

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

SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'

Insert

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

INSERT INTO IncomingPhoneNumbers (PhoneNumber) VALUES ('+15105555555')

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.

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 Sid column is required in the WHERE clause; DateCreated is optional and can be used with the >, >=, <, <=, or = conditions.

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

Insert

Twilio does not allow Media to be added.

Update

Twilio does not allow Media to be updated.

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	False		The Id of the media.
AccountSid	String	False		The Id of the account associated with the media.
ParentSid	String	False		The Id of the entity that created the media.
ContentType	String	False		The MIME type of the media.
DateCreated	Datetime	False		The creation date of the media.
DateUpdated	Datetime	False		The modification date of the media.
Uri	String	False		The URL of the media.

Pseudo-Columns

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


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

Messages

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

Select

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

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

Insert

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

INSERT INTO Messages(To,Sender,Body) VALUES ('+12345678965','+12019493653','Hi!')

INSERT INTO Messages(To,Sender,MediaUrl) VALUES ('+12345678965','+12019493653','http://www.mycompany.com/ui/img/logo.png')

Note: Up to 10 MediaUrl can be added per message as comma-separated-values.


INSERT INTO Messages(To, Sender, Body, MediaUrl) VALUES ('+12345678965', '+12019493653', 'Hi again!', 'http://www.mycompany.com/ui/img/logo.png,http://www.mycompany.com/ui/img/logo2.png')

Update

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

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

Delete

Messages cannot be deleted if the status is sending.

DELETE FROM Messages WHERE Sid = 'M123456789'

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	True		The Id of the messages.
DateCreated	Datetime	True		The creation date of the message.
DateUpdated	Datetime	True		The modification date of the message.
DateSent	Date	True		The sent date of the message.
AccountSid	String	True		The account Id of the message.
To	String	False		The phone number the message was sent to.
Sender	String	False		The phone number or sender Id that sent the message.
MessagingServiceSid	String	True		The messaging service Id of the message.
Body	String	False		The body of the message.
MediaUrl	String	False		The URL of the media you wish to send out with the message.
Status	String	True		The status of the message. One of the following values: accepted, queued, sending, sent, failed, delivered, undelivered, receiving, or received.
NumSegments	Integer	True		The number of segments that make up the message.
NumMedia	Integer	True		The number of media files associated with the message. The maximum is 10.
Direction	String	True		The direction of the message. One of the following values: inbound, outbound-api, outbound-call, or outbound-reply.
ApiVersion	String	True		The API version of the message.
Price	Decimal	True		The price of the message.
PriceUnit	String	True		The currency of the message.
ErrorCode	String	True		The error code of the message.
ErrorMessage	String	True		The error message.
Uri	String	True		The URI of the message.

OutgoingCallerIds

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

Select

SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'

Insert

To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.

EXEC AddOutgoingCallerIds PhoneNumber='+15105555555'

Update

Twilio allows the Name column to be updated.

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

Delete

Twilio does not allow OutgoingCallerIds to be deleted.

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	True		The Id of the outgoing caller Id.
AccountSid	String	True		The account Id of the outgoing caller Id.
DateCreated	Datetime	True		The creation date of the outgoing caller Id.
DateUpdated	Datetime	True		The modfication date of the outgoing caller Id.
Name	String	False		The friendly name of the outgoing caller Id. By default, this is a formatted phone number.
PhoneNumber	String	False		The phone number of the outgoing caller Id.
Uri	String	True		The URI of the outgoing caller Id.

Recordings

Delete and query the available Recordings in Twilio.

Select

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

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

Insert

Twilio does not allow Recordings to be added.

Update

Twilio does not allow Recordings to be updated.

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	Date	False		The creation date of the recording.
DateUpdated	Date	False		The modification date of the recording.
Duration	Double	False		The duration of the recording in seconds.
AccountSid	String	False		The account Id of the recording.
Uri	String	False		The URI of the recording.

ServiceLists

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

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.
Url	String	True		The absolute URL of the Sync List resource.
Revision	String	True		The current revision of the Sync List, represented as a string.
DateCreated	Datetime	True		The date and time when the resource was created.
DateUpdated	Datetime	True		The date and time when the resource was last updated.
DateExpires	Datetime	True		The date and time when the Sync List expires and will be deleted. If the Sync List does not expire, this value is null. The Sync List might not be deleted immediately after it expires.
CreatedBy	String	True		The identity of the Sync List's creator. If the Sync List was created from inserting into ServiceLists table, the value is system.
TimeToLive	Integer	False		This column is used only when updating. It specifies how long, in seconds, before the Sync List expires and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is 0, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.
Links	String	True		The URLs of the Sync List's nested resources.

Transcriptions

Query the available Transcriptions in Twilio.

Select

SELECT * FROM Transcriptions WHERE Sid='T12345564'

Insert

Twilio does not allow Transcriptions to be added.

Update

Twilio does not allow Transcriptions to be updated.

Columns


Name	Type	ReadOnly	References	Description
Sid [KEY]	String	False		The Id of the transcription.
AccountSid	String	False		The account Id of the transcription.
ApiVersion	String	False		The API version of the transcription.
DateCreated	Datetime	False		The creation date of the transcription.
DateUpdated	Datetime	False		The modification date of the transcription.
Duration	Integer	False		The duration of the transcription in seconds.
Price	Decimal	False		The price of the transcription.
RecordingSid	String	False		The recording Id of the transcription.
Status	String	False		The status of the transcription. One of the following values: in-progress, completed, or failed.
TranscriptionText	String	False		The transcription text.
Type	String	False		The type of the transcription.
Uri	String	False		The URI of the transcription.

Triggers

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

Select

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

SELECT * FROM Triggers WHERE Sid = 'X123456789'

Insert

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

INSERT INTO Triggers(UsageCategory,TriggerValue,CallbackUrl,CallbackMethod,Name,Recurring,TriggerBy)

VALUES('sms', 100, 'http://twilio.com/test', 'POST', 'trigger test', 'monthly', 'price')

Update

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

ViewsBack To Top

AvailablePhoneNumbers
CallEvents
CallMetrics
CallSummary
ConversationMessages
ConversationParticipants
Conversations
IncomingPhoneNumbersCategory
Services
UsageRecords

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. The allowed values are true, false.
CapabilitiesVoice	Boolean		Whether the phone number has voice capabilities. The allowed values are true, false.
CapabilitiesSms	Boolean		Whether the phone number has SMS capabilities. The allowed values are true, false.
CapabilitiesMms	Boolean		Whether the phone number has MMS capabilities. The allowed values are true, false.

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	String		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. The allowed values are true, false.
ExcludeLocalAddressRequired	String		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. The allowed values are true, false.
ExcludeForeignAddressRequired	String		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. The allowed values are true, false.
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.

CallEvents

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

Table Specific Information

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

Select

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


SELECT * FROM CallEvents where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b'



SELECT * FROM Callevents where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b' and Edge='sdk_edge'

Columns


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

CallMetrics

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

Table Specific Information

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

Select

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


SELECT * FROM CallMetrics where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b'



SELECT * FROM CallMetrics where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b' and edge ='carrier_edge'

Columns


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

CallSummary

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

Table Specific Information

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

Select

		

SELECT * FROM CallSummary where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b'

	  

SELECT * FROM CallSummary where CallSid='CH7040b87e3664410aa4c241a3d6c85f0b' and ProcessingState='Partial'

Columns


Name	Type	References	Description
CallSid	String	Calls.Sid	SID for the call
AccountSid	String		The account SID this call belongs to
AttributesConferenceParticipant	Boolean		Contains call-flow specific details
CallState	String		Status of the call
CallType	String		Describes the call type
CarrierEdgeMetricsInboundCodec	Integer		RTP profile number for the media codec for inbound stream
CarrierEdgeMetricsInboundCodecName	String		Name of the media codec for inbound stream
CarrierEdgeMetricsInboundJitterAvg	Double		Average jitter detected for inbound stream
CarrierEdgeMetricsInboundJitterMax	Double		Max jitter detected for inbound stream
CarrierEdgeMetricsInboundPacketsLossPercentage	Double		Percentage of packets lost for inbound stream
CarrierEdgeMetricsInboundPacketsLost	Integer		Count of packets lost for inbound stream
CarrierEdgeMetricsInboundPacketsReceived	Integer		Count of packets received; inbound container only
CarrierEdgeMetricsOutBoundCodec	Integer		RTP profile number for the media codec for outbound stream
CarrierEdgeMetricsOutBoundCodecName	String		Name of the media codec for outbound stream
CarrierEdgeMetricsOutBoundJitterAvg	Double		Average jitter detected for outbound stream
CarrierEdgeMetricsOutBoundJitterMax	Double		Max jitter detected for outbound stream
CarrierEdgeMetricsOutBoundPacketDelayVariation	Integer		Distribution of packets delayed by a certain value
CarrierEdgeMetricsOutBoundPacketsLossPercentage	Double		Percentage of packets lost for outbound stream
CarrierEdgeMetricsOutBoundPacketsLost	Integer		Count of packets lost for outbound stream
CarrierEdgeMetricsOutBoundPacketsSent	Integer		Count of packets sent
CarrierEdgePropertiesDirection	String		Direction of media flow from the perspective of the edge. Inbound or outbound.
CarrierEdgePropertiesEdgeLocation	String		The Twilio edge location where media was handled.
CarrierEdgePropertiesMediaRegion	String		The Twilio region where media was handled.
CarrierEdgePropertiesSignalingRegion	String		The Twilio region where signaling was handled.
ClientEdge	String		Contains metrics and properties for the Twilio media gateway of a Client call
ConnectDuration	Integer		Duration between when the call was answered and when it ended
Duration	Integer		Duration between when the call was initiated and the call was ended
EndTime	Datetime		Call end time
FromCaller	String		The calling party
FromCarrier	String		Serving carrier of destination
FromConnection	String		landline, mobile, voip
FromCountryCode	String		Two-letter ISO country code
FromLocationLat	Double		Lat for number prefix
FromLocationLon	Double		long for number prefix
FromNumberPrefix	String		E.164 country code + three digits
ProcessingState	String		Represents the summarization state of the resource.
PropertiesDirection	String		Contains edge-agnostic call-level details.
PropertiesDisconnectedBy	String		Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party
PropertiesQueueTime	String		Estimated time in milliseconds between when a Programmable Voice call is created and when the call actually begins.
PropertiesLastSipResponseNum	Integer		The numeric value of the last SIP response received for the call
PropertiesPddMs	Integer		Post-dial delay in milliseconds
SdkEdgeMetricsInboundAudioInAvg	Double		Avg level for microphone audio.
SdkEdgeMetricsInboundAudioInMax	Double		Max level for microphone audio.
SdkEdgeMetricsInboundAudioOutAvg	Double		Avg level for speaker audio
SdkEdgeMetricsInboundAudioOutMax	Double		Max level for speaker audio
SdkEdgeMetricsInboundJitterAvg	Double		Average jitter detected
SdkEdgeMetricsInboundJitterMax	Double		Max jitter detected
SdkEdgeMetricsInboundMosAvg	Double		Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Average value returned.
SdkEdgeMetricsInboundMosMax	Double		Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Max value returned.
SdkEdgeMetricsInboundMosMin	Double		Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Min value returned.
SdkEdgeMetricsInboundPacketsLossPercentage	Double		Percentage of packets lost for inbound stream
SdkEdgeMetricsInboundPacketsLost	Integer		Count of packets lost for inbound stream
SdkEdgeMetricsInboundPacketsReceived	Integer		Count of packets received; inbound container only
SdkEdgeMetricsInboundRttAvg	Double		Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. Average value returned.
SdkEdgeMetricsInboundRttMax	Double		Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. maximum value returned.
SdkEdgeMetricsInboundRttMin	Double		Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. minimum value returned.
SdkEdgeMetricsOutBoundCodec	Integer		RTP profile number for the media codec for outbound stream
SdkEdgeMetricsOutBoundCodecName	String		Name of the media codec for outbound stream
SdkEdgeMetricsOutBoundPacketsSent	Integer		Count of packets sent
SdkEdgePropertiesAppBuildNumber	String		Twilio SDK build version
SdkEdgePropertiesAppCompileSdkVersion	String		Twilio SDK version
SdkEdgePropertiesAppId	String		App Id for the Twilio SDK
SdkEdgePropertiesAppMinOSVersion	String		Min Operating system version to the SDK
SdkEdgePropertiesAppName	String		App name for the SDK
SdkEdgePropertiesAppTargetOSVersion	String		Target Operating system version to the SDK
SdkEdgePropertiesAppVersion	String		App version for the SDK
SdkEdgePropertiesDirection	String		Direction of media flow from the perspective of the edge. Inbound or outbound.
SdkEdgePropertiesDisconnectedBy	String		Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party
SdkEdgePropertiesEventsGroupsConnection	Integer		landline, mobile, voip
SdkEdgePropertiesEventsGroupsGetUserMedia	Integer		Get user media count
SdkEdgePropertiesEventsGroupsIceConnectionState	Integer		Event group ice connection state value
SdkEdgePropertiesEventsGroupsIceGatheringState	Integer		Event group ice connection gathering value
SdkEdgePropertiesEventsGroupsNetworkInformation	Integer		Event group network information
SdkEdgePropertiesEventsGroupsSignalingState	Integer		Signalling state of the Event groups
SdkEdgePropertiesEventsLevelsDEBUG	Integer		Count of events by severity-debug for the call.
SdkEdgePropertiesEventsLevelsINFO	Integer		Count of events by severity-info for the call.
SdkEdgePropertiesSettingsDscp	Boolean		Indicates whether DSCP was enabled.
SdkEdgePropertiesSettingsIceRestartEnabled	Boolean		Indicates if ICE restart was enabled.
SipEdge	String		Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call
StartTime	Datetime		Call start time
Tags	String		Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
ToCallee	String		The called party
ToCarrier	String		Serving carrier of destination
ToConnection	String		landline, mobile, voip
ToCountryCode	String		Two-letter ISO country code
ToLocationLat	Double		Lat for number prefix
ToLocationLon	Double		Long for number prefix
ToNumberPrefix	String		E.164 country code + three digits
TrustBrandedCallBrandSid	String		Contains trusted communications details including Branded Call and verified caller ID
TrustBrandedCallBranded	Boolean		Boolean. Indicates if branding details were successfully displayed on the destination device.
TrustBrandedCallBrandedChannelSid	String		Branded channel SID.
TrustBrandedCallCaller	String		Caller ID provided.
TrustBrandedCallUseCase	String		Use case for the call.
TrustVerifiedCallerVerified	Boolean		Boolean. Indicates if the caller ID provided has been verified; e.g. SHAKEN/STIR A attestation.
Url	String		The URL of the Voice Insights Summary for this call

ConversationMessages

ConversationMessage includes metadata of the Messages sent over a conversation.

Table Specific Information

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

Select

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


SELECT * FROM ConversationMessages where ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b'



SELECT * FROM ConversationMessages where ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' and Sid='MGd452e64de7dff2465702495ed6048e84'

Columns


Name	Type	References	Description
Sid [KEY]	String		A 34 character string that uniquely identifies this resource.
AccountSid	String		The unique ID of the Account responsible for this message.
ConversationSid	String	Conversations.Sid	The unique ID of the Conversation for this message.
AttributesImportance	String		A string metadata field you can use to store any data you wish.
Author	String		The channel specific identifier of the message's author.
Body	String		The content of the message, can be up to 1,600 characters long.
DateCreated	Datetime		The date that this resource was created.
DateUpdated	Datetime		The date that this resource was last updated.
DeliveryDelivered	String		An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryFailed	String		An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryRead	String		An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliverySent	String		An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryTotal	Integer		An object that contains the summary of delivery statuses for the message to non-chat participants.
DeliveryUndelivered	String		An object that contains the summary of delivery statuses for the message to non-chat participants.
Index	Integer		The index of the message within the Conversation.
LinksDeliveryReceipts	String		Contains an absolute API resource URL to access the delivery & read receipts of this message.
Media	String		An array of objects that describe the Message's media.
ParticipantSid	String		The unique ID of messages's author participant.
Url	String		An absolute API resource API URL for this message.

ConversationParticipants

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

Table Specific Information

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

Select


SELECT * FROM ConversationParticipants where conversationsid='CH7040b87e3664410aa4c241a3d6c85f0b'



SELECT * FROM ConversationParticipants where conversationsid='CH7040b87e3664410aa4c241a3d6c85f0b' and Sid='IS62451554b2b349d6a0bee0b047ead195'

Columns


Name	Type	References	Description
Sid [KEY]	String		A 34 character string that uniquely identifies this resource.
AccountSid	String		The unique ID of the Account responsible for this participant.
AttributesRole	String		An optional string metadata field you can use to store any data
ConversationSid	String	Conversations.Sid	The unique ID of the Conversation for this participant.
DateCreated	Datetime		The date that this resource was created.
DateUpdated	Datetime		The date that this resource was last updated.
Identity	String		A unique string identifier for the conversation participant as Conversation User.
MessagingBindingAddress	String		Information about how this participant exchanges messages with the conversation.
MessagingBindingProxyAddress	String		Information about how this participant exchanges messages with the conversation.
MessagingBindingType	String		Information about how this participant exchanges messages with the conversation.
RoleSid	String		The SID of a conversation-level Role to assign to the participant.
Url	String		An absolute API resource URL for this participant.

Conversations

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

Table Specific Information

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

Select


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 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.
TimersDateClosed	Datetime		Timer date values representing state update for this conversation.
TimersDateInactive	Datetime		Timer date values representing state update for this conversation.
UniqueName	String		An application-defined string that uniquely identifies the resource.
Url	String		An absolute API resource URL for this conversation.

IncomingPhoneNumbersCategory

Query Twilio Incoming Phone Numbers and filter by Category.

Select

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.

Services

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

Columns


Name	Type	References	Description
Sid [KEY]	String		The unique string that Twilio's created to identify the Service resource.
AccountSid	String	Accounts.Sid	The SID of the Account that created the Service resource.
UniqueName	String		An application-defined string that uniquely identifies the resource.
FriendlyName	String		The string that you assigned to describe the resource.
DateCreated	Datetime		The date and time when the service was created.
DateUpdated	Datetime		The date and time when the service was last updated.
Url	String		The absolute URL of the service.
WebhookUrl	String		The URL that gets called when Sync objects are manipulated.
WebhooksFromRestEnabled	Boolean		Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false.
AclEnabled	Boolean		Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.
ReachabilityWebhooksEnabled	Boolean		Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false.
ReachabilityDebouncingEnabled	Boolean		Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event.
ReachabilityDebouncingWindow	Integer		The reachability event delay in milliseconds if ReachabilityDebouncingEnabled = true. Is between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before WebhookUrl is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.
Links	String		The URLs of related resources.

UsageRecords

Query Usage Records in Twilio.

Select

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

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

Columns


Name	Type	References	Description
AccountSid	String		The account Id of the usage record.
Category	String		The category of the usage record. For example, calls, sms, phonenumbers, recordings, transcriptions, and totalprice.
Description	String		The description of the usage record.
StartDate	Date		The start date of the usage record. You can also specify an offset, such as -30days.
EndDate	Date		The end date of the usage record. You can also specify an offset, such as -1year.
Count	Integer		The number of usage events. For example: the number of calls.
CountUnit	String		The type of the usage events counted. For example: calls and messages.
Usage	Double		The amount of usage.
UsageUnit	String		The usage unit. For example: minutes and messages.
Price	Decimal		The total price of the usage.
PriceUnit	String		The currency of the price.
ApiVersion	String		The API version of the usage record.
Uri	String		The URI of the usage record.

Pseudo-Columns

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


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

Matillion ETL Data Model for TwilioVersion - 21.0.8137.0

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Java Logging

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Data Type

Default Value

Remarks

Matillion ETL Data Model for Twilio
Version - 21.0.8137.0