Twilio Query Data Model

Connection String Options

  1. Account SID
  2. Auth Token
  3. Auto Cache
  4. Batch Size
  5. Cache Connection
  6. Cache Driver
  7. Cache Location
  8. Cache Metadata
  9. Cache Query Result
  10. Connection Life Time
  11. Connect On Open
  12. Firewall Password
  13. Firewall Port
  14. Firewall Server
  15. Firewall Type
  16. Firewall User
  17. Location
  18. Logfile
  19. Max Log File Size
  20. Offline
  21. Other
  22. Pool Idle Timeout
  23. Pool Max Size
  24. Pool Min Size
  25. Pool Wait Time
  26. Proxy Auth Scheme
  27. Proxy Auto Detect
  28. Proxy Exceptions
  29. Proxy Password
  30. Proxy Port
  31. Proxy Server
  32. Proxy SSL Type
  33. Proxy User
  34. Pseudo Columns
  35. Readonly
  36. RTK
  37. SSL Server Cert
  38. Support Enhanced SQL
  39. Tables
  40. Timeout
  41. Use Connection Pooling
  42. Verbosity
  43. Views

Account SID

Data Type

string

Default Value

""

Remarks

Account SID of the currently authenticated user.

 

Auth Token

Data Type

string

Default Value

""

Remarks

Auth token of the currently authenticated user.

 

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Twilio data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Twilio in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Applications#CACHE]

 

 

Setting the Caching Database

 

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

 

 

See Also

 

 

  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Twilio metadata. Metadata then needs to be retrieved only once instead of every connection.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

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.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

 

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies 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 CacheProvider and CacheConnection. Below 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. Below 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. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below 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 username 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
Below 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 username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

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

 

Below 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
Below 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.
  • Username: 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.

 

 

Cache Driver

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 would like to use to cache data.

Note that you must also add the CacheDriver JAR 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 is shipped in the JDK. You can find the JAR, 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

 

Below 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

 

Below 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;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Twilio 2018 installation directory.
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

 

Below is a JDBC URL for the Oracle Thin Client:

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

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:twilio:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';AccountSid=MyAccountSid;AuthToken=MyAuthToken;

 

 

Cache Location

Data Type

string

Default Value

""

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 to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Twilio catalog in CacheLocation.

 

 

Cache Metadata

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 metdata will change 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.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Connection Life Time

Data Type

string

Default Value

"0"

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.

 

Connect On Open

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

 

Firewall Password

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.

 

Firewall Port

Data Type

string

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.

 

Firewall Server

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.

 

Firewall Type

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.

 

 

Firewall User

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.

 

Location

Data Type

string

Default Value

""

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 Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

"20MB"

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). 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 20MB. Values lower than 100kB will use 100kB as the value instead.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to 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.

 

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

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

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.

 

Pool Min Size

Data Type

string

Default Value

"1"

Remarks

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

 

Pool Wait Time

Data Type

string

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.

 

Proxy Auth Scheme

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.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

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

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

 

Proxy Password

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.

 

Proxy Port

Data Type

string

Default Value

"80"

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.

 

Proxy Server

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.

 

Proxy SSL Type

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.

 

 

Proxy User

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 username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

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; i.e., "*=*".

 

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. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

SSL Server Cert

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 will be rejected.

This property can take the 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 will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to 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 is set to 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.

 

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. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

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

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

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 described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

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. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. Accounts
  2. Applications
  3. Calls
  4. Feedback
  5. FeedbackSummary
  6. IncomingPhoneNumbers
  7. Media
  8. Messages
  9. OutgoingCallerIds
  10. Recordings
  11. Transcriptions
  12. Triggers

Accounts

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

 

Select

 

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

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

 

To add an Account, specify the Name field.

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

 

Twilio allows updates for the Name and Status columns.

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

 

Twilio does not allow Accounts to be deleted.

Columns

 

 

 

   
Name Type ReadOnly References Description
Sid [KEY] String True  

The Id of the account.

DateCreated Datetime True  

The creation date of the account.

DateUpdated Datetime True  

The modification date of the account.

Name String False  

The friendly name of the account.

OwnerAccountSid String True  

The master account of the account.

AuthToken String True  

The authentication token of the account.

Status String False  

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

The allowed values are closed, suspended, active.

The default value is active.

Type String True  

The type of the account. Either Trial or Full.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Applications

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

 

Select

 

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

SELECT * FROM Applications WHERE Sid = 'X123456789'
Insert

 

To add an Application, specify at least the Name.

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

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Feedback

Create and query Feedback on a Call in Twilio.

 

Select

 

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

SELECT * FROM Feedback WHERE Sid = 'F123456789'
Insert

 

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

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

 

Twilio does not allow Feedback records to be updated.

Delete

 

Twilio does not allow Feedback records to be deleted.

Columns

 

 

 

   
Name Type ReadOnly References Description
Sid [KEY] String False  

The Id of the call.

AccountSid String True  

The account Id associated with the feedback.

QualityScore Integer False  

The quality score, represented on a scale of 1 (very poor) to 5 (perfect).

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

Issues String False  

Any issues experienced during the call. Allowed values are imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, and one-way-audio.

The allowed values are imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, one-way-audio.

DateCreated Datetime True  

The creation date of the feedback.

DateUpdated Datetime True  

The modification date of the feedback.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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

INSERT INTO Messages(To,From,Body) VALUES ('+12345678965','+12019493653','Hi!') 
 
INSERT INTO Messages(To,From,MediaUrl) VALUES ('+12345678965','+12019493653','http://www.mycompany.com/ui/img/logo.png') 
 
INSERT INTO Messages(To,From,Body,MediaUrl#1,MediaUrl#2) 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 Double 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.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

OutgoingCallerIds

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

 

Select

 

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

SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'
Insert

 

To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.

EXEC AddOutgoingCallerIds PhoneNumber='+15105555555'
Update

 

Twilio allows the Name column to be updated.

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

 

Twilio does not allow OutgoingCallerIds to be deleted.

Columns

 

 

 

   
Name Type ReadOnly References Description
Sid [KEY] String True  

The Id of the outgoing caller Id.

AccountSid String True  

The account Id of the outgoing caller Id.

DateCreated Datetime True  

The creation date of the outgoing caller Id.

DateUpdated Datetime True  

The modfication date of the outgoing caller Id.

Name String False  

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

PhoneNumber String False  

The phone number of the outgoing caller Id.

Uri String True  

The URI of the outgoing caller Id.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Transcriptions

Query the available Transcriptions in Twilio.

 

Select

 

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

SELECT * FROM Transcriptions WHERE Sid='T12345564' 
Insert

 

Twilio does not allow Transcriptions to be added.

Update

 

Twilio does not allow Transcriptions to be updated.

Columns

 

 

 

   
Name Type ReadOnly References Description
Sid [KEY] String False  

The Id of the transcription.

AccountSid String False  

The account Id of the transcription.

ApiVersion String False  

The API version of the transcription.

DateCreated Datetime False  

The creation date of the transcription.

DateUpdated Datetime False  

The modification date of the transcription.

Duration Integer False  

The duration of the transcription in seconds.

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

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

 

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
Rows@Next String

This is used to page through multiple pages of results and should not be set manually.

 

 




 

Views

  1. AvailablePhoneNumbers
  2. IncomingPhoneNumbersCategory
  3. 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.
Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

IncomingPhoneNumbersCategory

Query Twilio Incoming Phone Numbers and filter by Category.

 

Select

 

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

SELECT * FROM IncomingPhoneNumbersCategory WHERE Category='Local'
Columns

 

 

 

   
Name Type References Description
Sid [KEY] String   The Id of the phone number.
AccountSid String   The account Id of the phone number.
Name String   The friendly name of the phone number. By default, this is a formatted phone number.
PhoneNumber String   The phone number in E.164 format.
VoiceUrl String   The URL Twilio will request when the phone number receives a call.
VoiceMethod String   The HTTP method Twilio will use to request the voice URL.
VoiceFallbackUrl String   The URL Twilio will request when an error occurs requesting the voice URL.
VoiceFallbackMethod String   The HTTP method Twilio will use to request the fallback voice URL.
VoiceCallerIdLookup Boolean   Whether to look up the caller Id of the caller in the CNAM database.
DateCreated Datetime   The creation date of the phone number.
DateUpdated Datetime   The modification date of the phone number.
SmsUrl String   The URL Twilio will request when someone sends an SMS message to the phone number.
SmsMethod String   The HTTP method Twilio will use to request the SMS URL of the phone number.
SmsFallbackUrl String   The URL Twilio will request when an error occurs requesting the SMS URL.
SmsFallbackMethod String   The HTTP method Twilio will use to request the fallback SMS URL.
AddressRequirements String   The address requirements of the phone number.
Beta Boolean   Whether the phone number is a beta phone number new to Twilio.
CapabilitiesVoice Boolean   Whether the phone number has voice capabilities.
CapabilitiesSms Boolean   Whether the phone number has SMS capabilities.
CapabilitiesMms Boolean   Whether the phone number has MMS capabilities.
StatusCallback String   The URL that Twilio pass status parameters to.
StatusCallbackMethod String   The HTTP method Twilio will use to make requests to the status callback URL.
ApiVersion String   The API version of the phone number.
VoiceApplicationSid String   The voice application Id of the phone number. This can be used in place of the voice URLs.
SmsApplicationSid String   The SMS application Id of the phone number. This can be used in place of the SMS URLs.
TrunkSid String   The trunk Id of the phone number. This overrides the Voice_Application_Sid.
Uri String   The URI of the phone number.

 

Pseudo-Columns

 

 

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

 

 

   
Name Type Description
Category String   The category of the phone number. Possible values are local,mobile and tollfree.

The allowed values are Local, Mobile, Tollfree.

Rows@Next String   This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

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

Rows@Next String   This is used to page through multiple pages of results and should not be set manually.