CData Sync App は、Twilio データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Twilio コネクタはCData Sync アプリケーションから使用可能で、Twilio からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Twilio への接続を作成します。Twilio アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからTwilio コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
AccountSID およびAuthToken 接続プロパティを使ってアカウントのデータにアクセスします。Twilio アカウントダッシュボードからクレデンシャルを取得します。[アカウント]->[アカウント設定]をクリックして、クレデンシャルを取得します。
このセクションでは、Twilio Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Twilio にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Twilio API をリレーショナルテーブルおよびビューとしてモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
Sync App は、データをテーブルにモデル化し、標準SQL でのクエリおよび更新を容易にします。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
Sync App はTwilio のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Twilio テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Accounts | Create, update, and query Twilio Accounts belonging to the authenticated Account. |
Applications | Create, update, delete, and query the available Applications in Twilio. |
Calls | Delete and query connections between phones and Twilio. |
Feedback | Create and query Feedback on a Call in Twilio. |
FeedbackSummary | Create, delete, and query Feedback Summaries in Twilio. |
IncomingPhoneNumbers | Create, update, delete, and query phone numbers purchased from Twilio. |
Media | Delete and query Media in Twilio. |
Messages | Create, update, delete, and query SMS and MMS Messages in Twilio. |
OutgoingCallerIds | Insert, update, and query the verified numbers that may be used as a caller Id when making outgoing calls in Twilio. |
Recordings | Delete and query the available Recordings in Twilio. |
ServiceLists | Create, update, delete, and query the available Lists for a specific Service in Twilio Sync. |
Transcriptions | Query the available Transcriptions in Twilio. |
Triggers | Create, update, delete, and query usage Triggers in Twilio. |
Create, update, and query Twilio Accounts belonging to the authenticated Account.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Accounts are Name, Status, and Sid.
SELECT * FROM Accounts WHERE Name ='test' AND Status='suspended'
To add an Account, specify the Name field.
INSERT INTO Accounts (Name) VALUES ('test1')
Twilio allows updates for the Name and Status columns.
UPDATE Accounts SET Status='closed' WHERE Sid='X123456789'
Twilio does not allow Accounts to be deleted.
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the account. | |
DateCreated | Datetime | True |
The creation date of the account. | |
DateUpdated | Datetime | True |
The modification date of the account. | |
Name | String | False |
The friendly name of the account. | |
OwnerAccountSid | String | True |
The master account of the account. | |
AuthToken | String | True |
The authentication token of the account. | |
Status | String | False |
The status of the account. Allowed values are closed, suspended, and active. 使用できる値は次のとおりです。closed, suspended, active デフォルト値はactiveです。 | |
Type | String | True |
The type of the account. Either Trial or Full. |
Create, update, delete, and query the available Applications in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Applications are Name and Sid.
SELECT * FROM Applications WHERE Sid = 'X123456789'
To add an Application, specify at least the Name.
INSERT INTO Applications (Name,VoiceUrl, VoiceFallbackUrl,VoiceFallbackMethod,StatusCallback,StatusCallbackMethod,VoiceCallerIdLookup, SmsUrl,SmsMethod,SmsFallbackUrl,SmsStatusCallback,MessageStatusCallback) VALUES ('app7','http://demo.twilio.com/docs/voiceUrl.xml','http://demo.twilio.com/docs/voiceFallback.xml','POST','http://demo.twilio.com/docs/statusCallback.xml','POST',true,'http://demo.twilio.com/docs/smsFallback.xml', 'POST','http://demo.twilio.com/docs/smsFallback.xml','http://demo.twilio.com/docs/smsStatusCallback.xml','http://demo.twilio.com/docs/voiceUrl.xml')
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the application. | |
DateCreated | Datetime | True |
The creation date of the application. | |
DateUpdated | Datetime | True |
The modification date of the application. | |
AccountSid | String | True |
The account Id of the application. | |
Name | String | False |
The friendly name of the application. | |
ApiVersion | String | True |
The API version of the application. | |
VoiceUrl | String | False |
The URL Twilio will request when a phone number assigned to the application receives a call. | |
VoiceFallbackUrl | String | False |
The URL Twilio will request when an error occurs requesting the voice URL of the application. | |
VoiceFallbackMethod | String | False |
The HTTP method to use to request the fallback voice URL of the application. | |
StatusCallback | String | False |
The URL where Twilio will pass status parameters about calls received by phone numbers assigned to the application. | |
StatusCallbackMethod | String | False |
The HTTP method that Twilio will use to make requests to the status callback URL of the application. | |
VoiceCallerIdLookup | String | False |
Whether to look up the voice caller Id from the CNAM database for phone numbers assigned to this application. | |
VoiceMethod | String | False |
The HTTP method Twilio will use to request the voice URL. | |
SmsUrl | String | False |
The URL Twilio will request when a phone number assigned to the application receives an SMS message. | |
SmsMethod | String | False |
The HTTP method Twilio will use to request the SMS URL of the application. | |
SmsFallbackUrl | String | False |
The URL Twilio will request if an error occurs requesting the SMS URL. | |
SmsFallbackMethod | String | False |
The HTTP method Twilio will use to request the fallback SMS URL of the application. | |
SmsStatusCallback | String | False |
The URL where Twilio will POST to when an outgoing SMS request uses the Sid of the application. | |
MessageStatusCallback | String | False |
The URL where status parameters are sent when you insert to the Messages table and specify the Sid of the application. | |
Uri | String | True |
The URI of the application. |
Delete and query connections between phones and Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Sid are From, To, StartTime, EndTime, ParentCallSid, and Sid. StartTime and EndTime can be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Calls WHERE StartTime <='2014-10-10' AND EndTime >='2015-10-10'
Twilio does not allow Calls to be added.
Twilio does not allow Calls to be updated.
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. 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。inbound, outbound-api, outbound-dial | |
AnsweredBy | String | True |
One of the following values if the call was initiated with answering machine detection: human or machine. Empty otherwise. | |
ApiVersion | String | True |
The API version of the call. | |
ForwardedFrom | String | True |
The phone number that forwarded an incoming call. Note that the carrier must support forwarding. | |
CallerName | String | True |
The caller name to a phone number that has Caller Id Lookup enabled. | |
Uri | String | True |
The URI for the call. |
Create and query Feedback on a Call in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available column for Feedback is only Sid and it is required in WHERE clause.
SELECT * FROM Feedback WHERE Sid = 'F123456789'
To add a CallFeedback, specify at least QualityScore and Sid. Column Issues is optional.
INSERT INTO Feedback (Sid,QualityScore) VALUES ('X95487143505',1)
Twilio does not allow Feedback records to be updated.
Twilio does not allow Feedback records to be deleted.
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | False |
The Id of the call. | |
AccountSid | String | True |
The account Id associated with the feedback. | |
QualityScore | Integer | False |
The quality score, represented on a scale of 1 (very poor) to 5 (perfect). 使用できる値は次のとおりです。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. 使用できる値は次のとおりです。imperfect-audio, dropped-call, incorrect-caller-id, post-dial-delay, digits-not-captured, audio-latency, one-way-audio | |
DateCreated | Datetime | True |
The creation date of the feedback. | |
DateUpdated | Datetime | True |
The modification date of the feedback. |
Create, delete, and query Feedback Summaries in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. Only Sid is supported in the WHERE clause and it is required.
SELECT * FROM FeedbackSummary WHERE Sid = 'FS123456789'
To add a FeedbackSummary, specify at least these parameters: StartDate, EndDate, and IncludeSubaccounts.
INSERT INTO FeedbackSummary (StartDate, EndDate,IncludeSubaccounts) VALUES ('2014-06-01','2014-06-30',true)
Twilio does not allow FeedbackSummary to be updated.
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | False |
The Id of the feedback summary. | |
StartDate | Date | False |
The start date of the feedback summary. | |
EndDate | Date | False |
The end date of the feedback summary. | |
AccountSid | String | True |
The account Id of the feedback summary. | |
IncludeSubaccounts | Boolean | False |
Whether to include subaccounts in feedback summary. | |
Status | String | True |
The status of the feedback summary. One of the following values: queued, in-progress, completed, or failed. | |
CallCount | Integer | True |
The total call count. | |
CallFeedbackCount | Integer | True |
The count of calls associated with the feedback summary. | |
QSAverage | Double | True |
The quality score average of the feedback summary. | |
QSMedian | Double | True |
The quality score median of the feedback avarage. | |
QSStandardDeviation | Double | True |
The quality score standard deviation of the feedback summary. | |
IssuesDescription | String | True |
The issues description of the feedback summary. | |
IssuesCount | Integer | True |
The issues count of the feedback summary. | |
IssuesPercentageOfTotalCalls | Double | True |
The percentage of calls that experienced this issue. | |
DateCreated | Datetime | True |
The creation date of the feedback summary. | |
DateUpdated | Datetime | True |
The modification date of the feedback summary. |
Create, update, delete, and query phone numbers purchased from Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbers are PhoneNumber, Name, Beta, and Sid.
SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'
To add an IncomingPhoneNumber, specify exactly one of the following parameters: PhoneNumber or AreaCode. If you include both parameters, Twilio will use the AreaCode parameter and ignore the PhoneNumber provided.
INSERT INTO IncomingPhoneNumbers (PhoneNumber) VALUES ('+15105555555')
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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. |
Delete and query Media in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The 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'
Twilio does not allow Media to be added.
Twilio does not allow Media to be updated.
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
MessageSid | String |
The message Id of the media. |
Create, update, delete, and query SMS and MMS Messages in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Messages are Sender, To, DateSent, and Sid. DateSent may be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Messages WHERE Sid = 'MS123456789' AND DateSent > '2015-10-10'
To add a Message, specify Body, MediaUrl, or both, and To. At least one of the following conditional parameters must also be included: MessagingServiceSid or Sender.
INSERT INTO Messages(To,Sender,Body) VALUES ('+12345678965','+12019493653','Hi!')
INSERT INTO Messages(To,Sender,MediaUrl) VALUES ('+12345678965','+12019493653','http://www.mycompany.com/ui/img/logo.png')Note: Up to 10 MediaUrl can be added per message as comma-separated-values.
INSERT INTO Messages(To, Sender, Body, MediaUrl) VALUES ('+12345678965', '+12019493653', 'Hi again!', 'http://www.mycompany.com/ui/img/logo.png,http://www.mycompany.com/ui/img/logo2.png')
To update a Message record, the Body column must be empty.
UPDATE Messages SET Body = "" WHERE Sid='M1233455'
DELETE FROM Messages WHERE Sid = 'M123456789'
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the messages. | |
DateCreated | Datetime | True |
The creation date of the message. | |
DateUpdated | Datetime | True |
The modification date of the message. | |
DateSent | 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. |
Insert, update, and query the verified numbers that may be used as a caller Id when making outgoing calls in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for OutgoingCallerIds are PhoneNumber, Name, and Sid.
SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'
To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.
EXEC AddOutgoingCallerIds PhoneNumber='+15105555555'
Twilio allows the Name column to be updated.
UPDATE OutgoingCallerIds SET Name='test' WHERE Sid='O123456789'
Twilio does not allow OutgoingCallerIds to be deleted.
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the outgoing caller Id. | |
AccountSid | String | True |
The account Id of the outgoing caller Id. | |
DateCreated | Datetime | True |
The creation date of the outgoing caller Id. | |
DateUpdated | Datetime | True |
The modfication date of the outgoing caller Id. | |
Name | String | False |
The friendly name of the outgoing caller Id. By default, this is a formatted phone number. | |
PhoneNumber | String | False |
The phone number of the outgoing caller Id. | |
Uri | String | True |
The URI of the outgoing caller Id. |
Delete and query the available Recordings in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Recordings are CallSid, DateCreated, and Sid. DateCreated may be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Recordings WHERE DateCreated > '2011-10-10'
Twilio does not allow Recordings to be added.
Twilio does not allow Recordings to be updated.
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. |
Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.
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. |
Query the available Transcriptions in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Transcriptions are RecordingSid and Sid.
SELECT * FROM Transcriptions WHERE Sid='T12345564'
Twilio does not allow Transcriptions to be added.
Twilio does not allow Transcriptions to be updated.
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | False |
The Id of the transcription. | |
AccountSid | String | False |
The account Id of the transcription. | |
ApiVersion | String | False |
The API version of the transcription. | |
DateCreated | Datetime | False |
The creation date of the transcription. | |
DateUpdated | Datetime | False |
The modification date of the transcription. | |
Duration | Integer | False |
The duration of the transcription in seconds. | |
Price | Decimal | False |
The price of the transcription. | |
RecordingSid | String | False |
The recording Id of the transcription. | |
Status | String | False |
The status of the transcription. One of the following values: in-progress, completed, or failed. | |
TranscriptionText | String | False |
The transcription text. | |
Type | String | False |
The type of the transcription. | |
Uri | String | False |
The URI of the transcription. |
Create, update, delete, and query usage Triggers in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Triggers are Category, TriggerBy, UsageCategory, and Sid.
SELECT * FROM Triggers WHERE Sid = 'X123456789'
To add a Trigger specify the UsageCategory, TriggerValue, and CallbackUrl. Other optional columns are Name, TriggerBy, Recurring, and CallbackMethod.
INSERT INTO Triggers(UsageCategory,TriggerValue,CallbackUrl,CallbackMethod,Name,Recurring,TriggerBy) VALUES('sms', 100, 'http://twilio.com/test', 'POST', 'trigger test', 'monthly', 'price')
Triggers allows updates for the Name, CallbackUrl, and CallbackMethod columns.
UPDATE Triggers SET Name='updated' WHERE Sid='X123456789'
Name | Type | ReadOnly | References | Description |
Sid [KEY] | String | True |
The Id of the trigger. | |
AccountSid | String | True |
The account Id of the trigger. | |
DateCreated | Datetime | True |
The creation date of the trigger. | |
DateUpdated | Datetime | True |
The modification date of the trigger. | |
DateFired | Datetime | True |
The fired date of the trigger. | |
Name | String | False |
The friendly name of the trigger. | |
UsageCategory | String | False |
The usage category the trigger watches. For example: calls, sms, phonenumbers, recordings, transcriptions, totalprice. | |
TriggerBy | String | False |
The usage record field that the trigger is watching. Allowed values: count, usage, and price. 使用できる値は次のとおりです。count, usage, price | |
Recurring | String | False |
The recurring interval of the trigger. Allowed values: daily, monthly, and yearly. 使用できる値は次のとおりです。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. |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
Name | Description |
AvailablePhoneNumbers | Query the local, mobile, and toll-free phone numbers available in Twilio. |
CallEvents | The call events resource provides programmatic access to call progress and SDK events for a provided call SID. |
CallMetrics | The call metrics resource provides an overview of metadata and quality metrics for a provided call. |
CallSummary | This resource provides an overview of metadata and quality metrics for a single call. |
ConversationMessages | ConversationMessage includes metadata of the Messages sent over a conversation. |
ConversationParticipants | Each participant in a Conversation represents one real (probably human) participant in a Conversation. it joins Participants with the conversation, and the connected person will receive all subsequent messages. |
Conversations | Conversation includes a list of current Participants and the Messages that they have sent amongst each other. |
IncomingPhoneNumbersCategory | Query Twilio Incoming Phone Numbers and filter by Category. |
Services | A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists. |
UsageRecords | Query Usage Records in Twilio. |
Query the local, mobile, and toll-free phone numbers available in Twilio.
You can use this table to search for local, toll-free, and mobile phone numbers that are available for you to purchase. You can search for phone numbers by specifying a pattern, country, area code (NPA) or exchange (NXX), or geography.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. IsoCountry and Category are required columns in the WHERE clause.
Optional columns are AreaCode, CapabilitiesSms, CapabilitiesVoice, Beta, RateCenter, Lata, PostalCode, Distance, and PhoneNumber. PhoneNumber can be used with the LIKE condition.
SELECT * FROM AvailablePhoneNumbers WHERE IsoCountry='US' AND Category='Local'
Name | Type | References | Description |
PhoneNumber [KEY] | String | The phone number available to purchase. It may be used as a pattern to match phone numbers on. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. | |
Name | String | The friendly name of the available phone number. | |
Lata | String | The LATA of the available phone number. | |
RateCenter | String | The rate center of the available phone number. | |
Latitude | Double | The latitude of the available phone number. | |
Longitude | Double | The longitude of the available phone number. | |
Region | String | The region of the available phone number. | |
PostalCode | String | The postal code of the available phone number. | |
IsoCountry | String | The ISO country code in ISO 3166-1 alpha-2 format ('US' for United States, 'CA' for Canada, 'GB' for United Kingdom). | |
AddressRequirements | String | The address requirements of the available phone number. Eligible values are: none, any, local, or foreign.
使用できる値は次のとおりです。none, any, local, foreign | |
Beta | Boolean | Whether the phone number is a beta number new to the Twilio platform. | |
CapabilitiesVoice | Boolean | Whether the phone number has voice capabilities. | |
CapabilitiesSms | Boolean | Whether the phone number has SMS capabilities. | |
CapabilitiesMms | Boolean | Whether the phone number has MMS capabilities. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
ExcludeAllAddressRequired | Boolean | Indicates whether the response includes phone numbers which require any Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with an Address required. | |
ExcludeLocalAddressRequired | Boolean | Indicates whether the response includes phone numbers which require a local Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a local Address required. | |
ExcludeForeignAddressRequired | Boolean | Indicates whether the response includes phone numbers which require a foreign Address. Possible values are true or false. If not specified, the default is false, and results could include phone numbers with a foreign Address required. | |
AreaCode | String | The area code of the available phone number. | |
Category | String | The category of the available phone number. Possible values are: Local,Mobile,Tollfree.
使用できる値は次のとおりです。Local, Mobile, Tollfree | |
NearNumber | String | Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles. | |
NearLatLong | String | Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles. | |
Distance | String | The search radius for available phone numbers. Default is 25 miles. Max is 500 miles. |
The call events resource provides programmatic access to call progress and SDK events for a provided call SID.
The call events resource provides metadata on SDK events for specific user over a call.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
Note: CallSid is required in order to query CallEvents.
SELECT * FROM CallEvents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM Callevents WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Edge = 'sdk_edge'
Name | Type | References | Description |
CallSid | String |
Calls.Sid | Call SID for the call the events are associated with |
AccountSid | String | The account SID this call belongs to | |
CarrierEdge | String | Represents the connection between Twilio and our immediate carrier partners. | |
ClientEdgeMetadataEdgeLocation | String | Represents the edge location value for Twilio media gateway for Client calls. | |
ClientEdgeMetadataRegion | String | Represents the edge location value for Twilio media gateway for Client calls. | |
Edge | String | The edge reporting the event | |
Group | String | Event group | |
Level | String | Detail level | |
Name | String | Event name | |
SdkEdgeMetadataClientName | String | The Voice SDK client name running locally in the browser or in the application. | |
SdkEdgeMetadataCountryCode | String | The Voice SDK country_code running locally in the browser or in the application. | |
SdkEdgeMetadataIpAddress | String | The Voice SDK ip_address running locally in the browser or in the application. | |
SdkEdgeMetadataLocationLat | Double | The Voice SDK lattitude of location running locally in the browser or in the application. | |
SdkEdgeMetadataLocationLon | Double | The Voice SDK longitude value of location client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceArch | String | The Voice SDK device arch of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceModel | String | The Voice SDK device model of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceType | String | The Voice SDK device type of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkDeviceVendor | String | The Voice SDK device vendor of client running locally in the browser or in the application. | |
SdkEdgeMetadataSdkEdgeLocation | String | The Voice SDK edge_location running locally in the browser or in the application. | |
SdkEdgeMetadataSdkOSName | String | The Voice SDK OS name running locally in the browser or in the application. | |
SdkEdgeMetadataSdkOSVersion | String | The Voice SDK OS version running locally in the browser or in the application. | |
SdkEdgeMetadataSdkPlatform | String | The Voice SDK platform of the application. | |
SdkEdgeMetadataSdkSelectedRegion | String | The Voice SDK selected_region of client in the application. | |
SdkEdgeMetadataSdkType | String | The Voice SDK of the application. | |
SdkEdgeMetadataSdkVersion | String | The Voice SDK version of the application. | |
SipEdge | String | Represents the Twilio media gateway for SIP interface and SIP trunking calls. | |
Timestamp | Datetime | Event time |
The call metrics resource provides an overview of metadata and quality metrics for a provided call.
The call metrics resource provides an overview of metadata and quality metrics for a provided call.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallMetrics.
SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM CallMetrics WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND edge = 'carrier_edge'
Name | Type | References | Description |
CallSid | String |
Calls.Sid | SID for the call |
AccountSid | String | The account SID this call belongs to | |
CarrierEdgecodec | Integer | Contains Carrier edge codec value for the Twilio media gateway of a PSTN call | |
CarrierEdgecodec_name | String | Contains Carrier edge codec_name value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativeJitterAvg | Double | Contains Carrier edge jitter average value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativeJitterMax | Double | Contains Carrier edge jitter max value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD300 | Integer | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD50 | Integer | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketDelayVariationD70 | Integer | Contains Carrier edge packet_delay_variation value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketsLost | Integer | Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call | |
CarrierEdgecumulativePacketsReceived | Integer | Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsLossPercentage | Integer | Contains Carrier edge packets_loss_percentage value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsLost | Integer | Contains Carrier edge packets_lost value for the Twilio media gateway of a PSTN call | |
CarrierEdgeintervalPacketsReceived | Integer | Contains Carrier edge packets_received value for the Twilio media gateway of a PSTN call | |
CarrierEdgemetadataEdgeLocation | String | Contains Carrier edge location info for the Twilio media gateway of a PSTN call | |
CarrierEdgemetadataRegion | String | Contains Carrier edge region info for the Twilio media gateway of a PSTN call | |
ClientEdge | String | Contains metrics and properties for the Twilio media gateway of a Client call | |
Direction | String | Defines media stream direction from the perspective of the Twilio Media edge. | |
Edge | String | Represents the Twilio Media Edge the metric was captured on | |
SdkEdge | String | Contains metrics and properties for the SDK sensor library for Client calls | |
SipEdge | String | Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call | |
Timestamp | Datetime | Timestamp of metric sample. |
This resource provides an overview of metadata and quality metrics for a single call.
The call summary resource provides an overview of metadata and quality metrics for a single call, which contains all the metadata information related to that call.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: CallSid is required in order to query CallSummary.
SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM CallSummary WHERE CallSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND ProcessingState = 'Partial'
Name | Type | References | Description |
CallSid | String |
Calls.Sid | SID for the call |
AccountSid | String | The account SID this call belongs to | |
AttributesConferenceParticipant | Boolean | Contains call-flow specific details | |
CallState | String | Status of the call | |
CallType | String | Describes the call type | |
CarrierEdgeMetricsInboundCodec | Integer | RTP profile number for the media codec for inbound stream | |
CarrierEdgeMetricsInboundCodecName | String | Name of the media codec for inbound stream | |
CarrierEdgeMetricsInboundJitterAvg | Double | Average jitter detected for inbound stream | |
CarrierEdgeMetricsInboundJitterMax | Double | Max jitter detected for inbound stream | |
CarrierEdgeMetricsInboundPacketsLossPercentage | Double | Percentage of packets lost for inbound stream | |
CarrierEdgeMetricsInboundPacketsLost | Integer | Count of packets lost for inbound stream | |
CarrierEdgeMetricsInboundPacketsReceived | Integer | Count of packets received; inbound container only | |
CarrierEdgeMetricsOutBoundCodec | Integer | RTP profile number for the media codec for outbound stream | |
CarrierEdgeMetricsOutBoundCodecName | String | Name of the media codec for outbound stream | |
CarrierEdgeMetricsOutBoundJitterAvg | Double | Average jitter detected for outbound stream | |
CarrierEdgeMetricsOutBoundJitterMax | Double | Max jitter detected for outbound stream | |
CarrierEdgeMetricsOutBoundPacketDelayVariation | Integer | Distribution of packets delayed by a certain value | |
CarrierEdgeMetricsOutBoundPacketsLossPercentage | Double | Percentage of packets lost for outbound stream | |
CarrierEdgeMetricsOutBoundPacketsLost | Integer | Count of packets lost for outbound stream | |
CarrierEdgeMetricsOutBoundPacketsSent | Integer | Count of packets sent | |
CarrierEdgePropertiesDirection | String | Direction of media flow from the perspective of the edge. Inbound or outbound. | |
CarrierEdgePropertiesEdgeLocation | String | The Twilio edge location where media was handled. | |
CarrierEdgePropertiesMediaRegion | String | The Twilio region where media was handled. | |
CarrierEdgePropertiesSignalingRegion | String | The Twilio region where signaling was handled. | |
ClientEdge | String | Contains metrics and properties for the Twilio media gateway of a Client call | |
ConnectDuration | Integer | Duration between when the call was answered and when it ended | |
Duration | Integer | Duration between when the call was initiated and the call was ended | |
EndTime | Datetime | Call end time | |
FromCaller | String | The calling party | |
FromCarrier | String | Serving carrier of destination | |
FromConnection | String | landline, mobile, voip | |
FromCountryCode | String | Two-letter ISO country code | |
FromLocationLat | Double | Lat for number prefix | |
FromLocationLon | Double | long for number prefix | |
FromNumberPrefix | String | E.164 country code + three digits | |
ProcessingState | String | Represents the summarization state of the resource. | |
PropertiesDirection | String | Contains edge-agnostic call-level details. | |
PropertiesDisconnectedBy | String | Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party | |
PropertiesQueueTime | String | Estimated time in milliseconds between when a Programmable Voice call is created and when the call actually begins. | |
PropertiesLastSipResponseNum | Integer | The numeric value of the last SIP response received for the call | |
PropertiesPddMs | Integer | Post-dial delay in milliseconds | |
SdkEdgeMetricsInboundAudioInAvg | Double | Avg level for microphone audio. | |
SdkEdgeMetricsInboundAudioInMax | Double | Max level for microphone audio. | |
SdkEdgeMetricsInboundAudioOutAvg | Double | Avg level for speaker audio | |
SdkEdgeMetricsInboundAudioOutMax | Double | Max level for speaker audio | |
SdkEdgeMetricsInboundJitterAvg | Double | Average jitter detected | |
SdkEdgeMetricsInboundJitterMax | Double | Max jitter detected | |
SdkEdgeMetricsInboundMosAvg | Double | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Average value returned. | |
SdkEdgeMetricsInboundMosMax | Double | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Max value returned. | |
SdkEdgeMetricsInboundMosMin | Double | Mean opinion score; a function of jitter, packet loss, and round-trip time. Scale of 0-5 where anything above 4 is considered acceptable. Min value returned. | |
SdkEdgeMetricsInboundPacketsLossPercentage | Double | Percentage of packets lost for inbound stream | |
SdkEdgeMetricsInboundPacketsLost | Integer | Count of packets lost for inbound stream | |
SdkEdgeMetricsInboundPacketsReceived | Integer | Count of packets received; inbound container only | |
SdkEdgeMetricsInboundRttAvg | Double | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. Average value returned. | |
SdkEdgeMetricsInboundRttMax | Double | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. maximum value returned. | |
SdkEdgeMetricsInboundRttMin | Double | Round-trip time; time in milliseconds for packets sent from Twilio's gateway to arrive at the SDK. NOTE: adaptive jitter buffers and dynamic packet loss concealment algorithms may delay actual play out of RTP beyond the RTT value. minimum value returned. | |
SdkEdgeMetricsOutBoundCodec | Integer | RTP profile number for the media codec for outbound stream | |
SdkEdgeMetricsOutBoundCodecName | String | Name of the media codec for outbound stream | |
SdkEdgeMetricsOutBoundPacketsSent | Integer | Count of packets sent | |
SdkEdgePropertiesAppBuildNumber | String | Twilio SDK build version | |
SdkEdgePropertiesAppCompileSdkVersion | String | Twilio SDK version | |
SdkEdgePropertiesAppId | String | App Id for the Twilio SDK | |
SdkEdgePropertiesAppMinOSVersion | String | Min Operating system version to the SDK | |
SdkEdgePropertiesAppName | String | App name for the SDK | |
SdkEdgePropertiesAppTargetOSVersion | String | Target Operating system version to the SDK | |
SdkEdgePropertiesAppVersion | String | App version for the SDK | |
SdkEdgePropertiesDirection | String | Direction of media flow from the perspective of the edge. Inbound or outbound. | |
SdkEdgePropertiesDisconnectedBy | String | Available for Client calls only. Identifies if Twilio.Device.disconnect() was called in the local application or if the call was ended by remote party | |
SdkEdgePropertiesEventsGroupsConnection | Integer | landline, mobile, voip | |
SdkEdgePropertiesEventsGroupsGetUserMedia | Integer | Get user media count | |
SdkEdgePropertiesEventsGroupsIceConnectionState | Integer | Event group ice connection state value | |
SdkEdgePropertiesEventsGroupsIceGatheringState | Integer | Event group ice connection gathering value | |
SdkEdgePropertiesEventsGroupsNetworkInformation | Integer | Event group network information | |
SdkEdgePropertiesEventsGroupsSignalingState | Integer | Signalling state of the Event groups | |
SdkEdgePropertiesEventsLevelsDEBUG | Integer | Count of events by severity-debug for the call. | |
SdkEdgePropertiesEventsLevelsINFO | Integer | Count of events by severity-info for the call. | |
SdkEdgePropertiesSettingsDscp | Boolean | Indicates whether DSCP was enabled. | |
SdkEdgePropertiesSettingsIceRestartEnabled | Boolean | Indicates if ICE restart was enabled. | |
SipEdge | String | Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call | |
StartTime | Datetime | Call start time | |
Tags | String | Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality. | |
ToCallee | String | The called party | |
ToCarrier | String | Serving carrier of destination | |
ToConnection | String | landline, mobile, voip | |
ToCountryCode | String | Two-letter ISO country code | |
ToLocationLat | Double | Lat for number prefix | |
ToLocationLon | Double | Long for number prefix | |
ToNumberPrefix | String | E.164 country code + three digits | |
TrustBrandedCallBrandSid | String | Contains trusted communications details including Branded Call and verified caller ID | |
TrustBrandedCallBranded | Boolean | Boolean. Indicates if branding details were successfully displayed on the destination device. | |
TrustBrandedCallBrandedChannelSid | String | Branded channel SID. | |
TrustBrandedCallCaller | String | Caller ID provided. | |
TrustBrandedCallUseCase | String | Use case for the call. | |
TrustVerifiedCallerVerified | Boolean | Boolean. Indicates if the caller ID provided has been verified; e.g. SHAKEN/STIR A attestation. | |
Url | String | The URL of the Voice Insights Summary for this call |
ConversationMessage includes metadata of the Messages sent over a conversation.
Each Conversation includes a list of the Messages that they have sent amongst each other and an array of objects that describe the Message's media.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationMessages.
SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM ConversationMessages WHERE ConversationSid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'MGd452e64de7dff2465702495ed6048e84'
Name | Type | References | Description |
Sid [KEY] | String | A 34 character string that uniquely identifies this resource. | |
AccountSid | String | The unique ID of the Account responsible for this message. | |
ConversationSid | String |
Conversations.Sid | The unique ID of the Conversation for this message. |
AttributesImportance | String | A string metadata field you can use to store any data you wish. | |
Author | String | The channel specific identifier of the message's author. | |
Body | String | The content of the message, can be up to 1,600 characters long. | |
DateCreated | Datetime | The date that this resource was created. | |
DateUpdated | Datetime | The date that this resource was last updated. | |
DeliveryDelivered | String | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryFailed | String | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryRead | String | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliverySent | String | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryTotal | Integer | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
DeliveryUndelivered | String | An object that contains the summary of delivery statuses for the message to non-chat participants. | |
Index | Integer | The index of the message within the Conversation. | |
LinksDeliveryReceipts | String | Contains an absolute API resource URL to access the delivery & read receipts of this message. | |
Media | String | An array of objects that describe the Message's media. | |
ParticipantSid | String | The unique ID of messages's author participant. | |
Url | String | An absolute API resource API URL for this message. |
Each participant in a Conversation represents one real (probably human) participant in a Conversation. it joins Participants with the conversation, and the connected person will receive all subsequent messages.
Each participant in a Conversation represents one real (probably human) participant in a Conversation. Participant joins with the conversation, and the connected person will receive all subsequent messages.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query ConversationPartiticipants.
SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195'
Name | Type | References | Description |
Sid [KEY] | String | A 34 character string that uniquely identifies this resource. | |
AccountSid | String | The unique ID of the Account responsible for this participant. | |
AttributesRole | String | An optional string metadata field you can use to store any data | |
ConversationSid | String |
Conversations.Sid | The unique ID of the Conversation for this participant. |
DateCreated | Datetime | The date that this resource was created. | |
DateUpdated | Datetime | The date that this resource was last updated. | |
Identity | String | A unique string identifier for the conversation participant as Conversation User. | |
MessagingBindingAddress | String | Information about how this participant exchanges messages with the conversation. | |
MessagingBindingProxyAddress | String | Information about how this participant exchanges messages with the conversation. | |
MessagingBindingType | String | Information about how this participant exchanges messages with the conversation. | |
RoleSid | String | The SID of a conversation-level Role to assign to the participant. | |
Url | String | An absolute API resource URL for this participant. |
Conversation includes a list of current Participants and the Messages that they have sent amongst each other.
A Conversation is a unique thread of a conversation. each Conversation includes a list of current Participants and the Messages that they have sent amongst each other.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query Conversations.
SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195'
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. |
Query Twilio Incoming Phone Numbers and filter by Category.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbersCategory are Category, PhoneNumber, Name, Beta, and Sid. The Category column must be specified in the WHERE clause.
SELECT * FROM IncomingPhoneNumbersCategory WHERE Category='Local'
Name | Type | References | Description |
Sid [KEY] | String | The Id of the phone number. | |
AccountSid | String | The account Id of the phone number. | |
Name | String | The friendly name of the phone number. By default, this is a formatted phone number. | |
PhoneNumber | String | The phone number in E.164 format. | |
VoiceUrl | String | The URL Twilio will request when the phone number receives a call. | |
VoiceMethod | String | The HTTP method Twilio will use to request the voice URL. | |
VoiceFallbackUrl | String | The URL Twilio will request when an error occurs requesting the voice URL. | |
VoiceFallbackMethod | String | The HTTP method Twilio will use to request the fallback voice URL. | |
VoiceCallerIdLookup | Boolean | Whether to look up the caller Id of the caller in the CNAM database. | |
DateCreated | Datetime | The creation date of the phone number. | |
DateUpdated | Datetime | The modification date of the phone number. | |
SmsUrl | String | The URL Twilio will request when someone sends an SMS message to the phone number. | |
SmsMethod | String | The HTTP method Twilio will use to request the SMS URL of the phone number. | |
SmsFallbackUrl | String | The URL Twilio will request when an error occurs requesting the SMS URL. | |
SmsFallbackMethod | String | The HTTP method Twilio will use to request the fallback SMS URL. | |
AddressRequirements | String | The address requirements of the phone number. | |
Beta | Boolean | Whether the phone number is a beta phone number new to Twilio. | |
CapabilitiesVoice | Boolean | Whether the phone number has voice capabilities. | |
CapabilitiesSms | Boolean | Whether the phone number has SMS capabilities. | |
CapabilitiesMms | Boolean | Whether the phone number has MMS capabilities. | |
StatusCallback | String | The URL that Twilio pass status parameters to. | |
StatusCallbackMethod | String | The HTTP method Twilio will use to make requests to the status callback URL. | |
ApiVersion | String | The API version of the phone number. | |
VoiceApplicationSid | String | The voice application Id of the phone number. This can be used in place of the voice URLs. | |
SmsApplicationSid | String | The SMS application Id of the phone number. This can be used in place of the SMS URLs. | |
TrunkSid | String | The trunk Id of the phone number. This overrides the Voice_Application_Sid. | |
Uri | String | The URI of the phone number. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
Category | String | The category of the phone number. Possible values are local,mobile and tollfree.
使用できる値は次のとおりです。Local, Mobile, Tollfree |
A Service (or Verification Service) is the set of common configurations used to create and check verifications. Services contain Lists.
Name | Type | References | Description |
Sid [KEY] | String | The unique string that Twilio's created to identify the Service resource. | |
AccountSid | String |
Accounts.Sid | The SID of the Account that created the Service resource. |
UniqueName | String | An application-defined string that uniquely identifies the resource. | |
FriendlyName | String | The string that you assigned to describe the resource. | |
DateCreated | Datetime | The date and time when the service was created. | |
DateUpdated | Datetime | The date and time when the service was last updated. | |
Url | String | The absolute URL of the service. | |
WebhookUrl | String | The URL that gets called when Sync objects are manipulated. | |
WebhooksFromRestEnabled | Boolean | Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false. | |
AclEnabled | Boolean | Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. | |
ReachabilityWebhooksEnabled | Boolean | Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false. | |
ReachabilityDebouncingEnabled | Boolean | Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event. | |
ReachabilityDebouncingWindow | Integer | The reachability event delay in milliseconds if ReachabilityDebouncingEnabled = true. Is between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before WebhookUrl is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring. | |
Links | String | The URLs of related resources. |
Query Usage Records in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Triggers are Category, StartDate, EndDate, and Interval. StartDate and EndDate may be used with the >, >=, <, <=, or = conditions. Interval should be used as an escaped string, i.e [Interval].
SELECT * FROM UsageRecords WHERE [Interval] = 'Today'
Name | Type | References | Description |
AccountSid | String | The account Id of the usage record. | |
Category | String | The category of the usage record. For example, calls, sms, phonenumbers, recordings, transcriptions, and totalprice. | |
Description | String | The description of the usage record. | |
StartDate | Date | The start date of the usage record. You can also specify an offset, such as -30days. | |
EndDate | Date | The end date of the usage record. You can also specify an offset, such as -1year. | |
Count | Integer | The number of usage events. For example: the number of calls. | |
CountUnit | String | The type of the usage events counted. For example: calls and messages. | |
Usage | Double | The amount of usage. | |
UsageUnit | String | The usage unit. For example: minutes and messages. | |
Price | Decimal | The total price of the usage. | |
PriceUnit | String | The currency of the price. | |
ApiVersion | String | The API version of the usage record. | |
Uri | String | The URI of the usage record. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
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
使用できる値は次のとおりです。Daily, Monthly, Yearly, AllTime, Today, Yesterday, LastMonth, ThisMonth |
プロパティ | 説明 |
AuthToken | Auth token of the currently authenticated user. |
AccountSID | Account SID of the currently authenticated user. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthToken | Auth token of the currently authenticated user. |
AccountSID | Account SID of the currently authenticated user. |
Auth token of the currently authenticated user.
Auth token of the currently authenticated user.
Account SID of the currently authenticated user.
Account SID of the currently authenticated user.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はTwilio への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Twilio Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Applications WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"