CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるTwilio へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してTwilio に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Twilio への接続を標準化し、構成することができます。
このページでは、CData Cloud でのTwilio への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのTwilio への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してTwilio からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Twilio に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
Auth Token およびAccount SID を使用して、Twilio に認証できます。
Twilio Console Dashboard を開き、Account Info セクションに移動して、以下の接続プロパティを設定します。
API キーを使用してTwilio に認証するには:
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Cloud は、Twilio API をリレーショナルテーブルおよびビューとしてモデル化します。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
Cloud は、Twilio API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。
Cloud は、データをテーブルにモデル化し、標準SQL でのクエリおよび更新を容易にします。
ビュー は変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。
Cloud はTwilio のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| 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. | |
| SubresourceUris | String | True |
A Map of various subresources available for the given Account Instance | |
| ItemURL | String | True |
The URI for this resource, relative to https://api.twilio.com |
Create, update, delete, and query the available Applications in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Applications are Name and Sid.
SELECT * FROM Applications WHERE Sid = 'X123456789'
To add an Application, specify at least the Name.
INSERT INTO Applications (Name, VoiceUrl, VoiceFallbackUrl, VoiceFallbackMethod, StatusCallback, StatusCallbackMethod, VoiceCallerIdLookup,
SmsUrl, SmsMethod, SmsFallbackUrl, SmsStatusCallback, MessageStatusCallback) VALUES ('app7', 'http://demo.twilio.com/docs/voiceUrl.xml', 'http://demo.twilio.com/docs/voiceFallback.xml', 'POST', 'http://demo.twilio.com/docs/statusCallback.xml', 'POST', true, 'http://demo.twilio.com/docs/smsFallback.xml', 'POST', 'http://demo.twilio.com/docs/smsFallback.xml', 'http://demo.twilio.com/docs/smsStatusCallback.xml', 'http://demo.twilio.com/docs/voiceUrl.xml')
UPDATE Applications SET Name='appp8' WHERE Sid= 'ACab6788889df1432ae'
DELETE FROM Applications WHERE Sid = 'ACab6788889df1432ae'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | True |
The Id of the application. | |
| DateCreated | Datetime | True |
The creation date of the application. | |
| DateUpdated | Datetime | True |
The modification date of the application. | |
| AccountSid | String | True |
The account Id of the application. | |
| Name | String | False |
The friendly name of the application. | |
| ApiVersion | String | True |
The API version of the application. | |
| VoiceUrl | String | False |
The URL Twilio will request when a phone number assigned to the application receives a call. | |
| VoiceFallbackUrl | String | False |
The URL Twilio will request when an error occurs requesting the voice URL of the application. | |
| VoiceFallbackMethod | String | False |
The HTTP method to use to request the fallback voice URL of the application. | |
| StatusCallback | String | False |
The URL where Twilio will pass status parameters about calls received by phone numbers assigned to the application. | |
| StatusCallbackMethod | String | False |
The HTTP method that Twilio will use to make requests to the status callback URL of the application. | |
| VoiceCallerIdLookup | String | False |
Whether to look up the voice caller Id from the CNAM database for phone numbers assigned to this application. | |
| VoiceMethod | String | False |
The HTTP method Twilio will use to request the voice URL. | |
| SmsUrl | String | False |
The URL Twilio will request when a phone number assigned to the application receives an SMS message. | |
| SmsMethod | String | False |
The HTTP method Twilio will use to request the SMS URL of the application. | |
| SmsFallbackUrl | String | False |
The URL Twilio will request if an error occurs requesting the SMS URL. | |
| SmsFallbackMethod | String | False |
The HTTP method Twilio will use to request the fallback SMS URL of the application. | |
| SmsStatusCallback | String | False |
The URL where Twilio will POST to when an outgoing SMS request uses the Sid of the application. | |
| MessageStatusCallback | String | False |
The URL where status parameters are sent when you insert to the Messages table and specify the Sid of the application. | |
| Uri | String | True |
The URI of the application. | |
| PublicApplicationConnectEnabled | Boolean | True |
Whether to allow other Twilio accounts to dial this application using Dial verb. Can be: true or false |
Delete and query connections between phones and Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Sid are From, To, StartTime, EndTime, ParentCallSid, and Sid. StartTime and EndTime can be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Calls WHERE StartTime <= '2014-10-10' AND EndTime >= '2015-10-10'
Twilio does not allow Calls to be added.
Twilio does not allow Calls to be updated.
DELETE FROM Calls WHERE Sid = 'CAcdc741bdcc2ae'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | True |
The Id of the call. | |
| DateCreated | Datetime | True |
The creation date of the call. | |
| DateUpdated | Datetime | True |
The modification date of the call. | |
| ParentCallSid | String | True |
The Id of the parent call. | |
| AccountSid | String | True |
The Id of the account that created the call. | |
| To | String | True |
The phone number, SIP address, or client identifier that is called. | |
| ToFormatted | String | True |
The formatted phone number, SIP address, or client identifier that is called. | |
| From | String | True |
The phone number, SIP address, or client identiifer that has made the call. | |
| FromFormatted | String | True |
The formatted number, SIP address, or client identifier that has made the call. | |
| PhoneNumberSid | String | True |
If the call was inbound, the Sid of the IncomingPhoneNumber that received the call. For an outbound call, the Sid of the OutgoingCallerId that made the call. | |
| Status | String | True |
The status of the call. One of the following values: queued, ringing, in-progress, canceled, completed, failed, busy, or no-answer. 使用できる値は次のとおりです。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.
DELETE FROM FeedbackSummary WHERE Sid = 'FS123456789'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | False |
The Id of the feedback summary. | |
| StartDate | Date | False |
The start date of the feedback summary. | |
| EndDate | Date | False |
The end date of the feedback summary. | |
| AccountSid | String | True |
The account Id of the feedback summary. | |
| IncludeSubaccounts | Boolean | False |
Whether to include subaccounts in feedback summary. | |
| Status | String | True |
The status of the feedback summary. One of the following values: queued, in-progress, completed, or failed. | |
| CallCount | Integer | True |
The total call count. | |
| CallFeedbackCount | Integer | True |
The count of calls associated with the feedback summary. | |
| QSAverage | Double | True |
The quality score average of the feedback summary. | |
| QSMedian | Double | True |
The quality score median of the feedback avarage. | |
| QSStandardDeviation | Double | True |
The quality score standard deviation of the feedback summary. | |
| IssuesDescription | String | True |
The issues description of the feedback summary. | |
| IssuesCount | Integer | True |
The issues count of the feedback summary. | |
| IssuesPercentageOfTotalCalls | Double | True |
The percentage of calls that experienced this issue. | |
| DateCreated | Datetime | True |
The creation date of the feedback summary. | |
| DateUpdated | Datetime | True |
The modification date of the feedback summary. |
Create, update, delete, and query phone numbers purchased from Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for IncomingPhoneNumbers are PhoneNumber, Name, Beta, and Sid.
SELECT * FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'
To add an IncomingPhoneNumber, specify exactly one of the following parameters: PhoneNumber or AreaCode. If you include both parameters, Twilio will use the AreaCode parameter and ignore the PhoneNumber provided.
INSERT INTO IncomingPhoneNumbers (PhoneNumber, AreaCode) VALUES ('+15105555555', '123')
UPDATE IncomingPhoneNumbers SET Name='appp8' WHERE Sid= 'X123456789'
DELETE FROM IncomingPhoneNumbers WHERE Sid = 'X123456789'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | True |
The Id of the phone number. | |
| AccountSid | String | False |
The account Id of the phone number. | |
| Name | String | False |
The friendly name of the phone number. By default, this is a formatted phone number. | |
| PhoneNumber | String | False |
The phone number. | |
| VoiceUrl | String | False |
The URL Twilio will request when the phone number receives a call. | |
| VoiceMethod | String | False |
The HTTP method Twilio will use to make the request to the voice URL. | |
| VoiceFallbackUrl | String | False |
The URL Twilio will request when an error occurs requesting the voice URL. | |
| VoiceFallbackMethod | String | False |
The HTTP method to use to request the fallback voice URL. | |
| VoiceCallerIdLookup | Boolean | False |
Whether to look up the caller Id from the CNAM database. | |
| DateCreated | Datetime | True |
The creation date of the phone number. | |
| DateUpdated | Datetime | True |
The modification date of the phone number. | |
| SmsUrl | String | False |
The URL Twilio will request when the phone number receives an SMS message. | |
| SmsMethod | String | False |
The HTTP method Twilio will use to make requests to the SMS URL. | |
| SmsFallbackUrl | String | False |
The URL Twilio will request when an error occurs requesting the SMS URL. | |
| SmsFallbackMethod | String | False |
The HTTP method Twilio will use to request the fallback SMS URL of the phone number. | |
| AddressRequirements | String | True |
The address requirements for the phone number. Eligible values are: none, any, local, or foreign. | |
| Beta | String | True |
Whether the phone number is a beta phone number new to Twilio. | |
| CapabilitiesVoice | Boolean | True |
Whether the phone number supports voice. | |
| CapabilitiesSms | Boolean | True |
Whether the phone number supports SMS. | |
| CapabilitiesMms | Boolean | True |
Whether the phone number supports MMS. | |
| StatusCallback | String | False |
The URL where Twilio will pass status parameters about calls received by the phone number. | |
| StatusCallbackMethod | String | False |
The HTTP method that Twilio will use to make requests to the status callback URL. | |
| ApiVersion | String | False |
The API version of the phone number. | |
| VoiceApplicationSid | String | False |
The voice application Id of the phone number. This can be used in place of the voice URLs. | |
| SmsApplicationSid | String | False |
The SMS application Id of the phone number. This can be used in place of the SMS URLs. | |
| TrunkSid | String | False |
The trunk Id of the phone number. This overrides VoiceApplicationId and the voice URLs. | |
| Uri | String | True |
The URI of the phone number. | |
| AddressSid | String | False |
The SID of the Address resource associated with the phone number. | |
| IdentitySid | String | False |
The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations. | |
| Origin | String | True |
The phone number's origin. twilio identifies Twilio-owned phone numbers and hosted identifies hosted phone numbers. | |
| VoiceReceiveMode | String | False |
Mode of Received voice 使用できる値は次のとおりです。voice, fax |
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. This column will work only with INSERT. |
Delete and query Media in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The MessageSid column is required in the WHERE clause; Sid can be used with the = conditions and DateCreated is optional and can be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Media WHERE MessageSid = 'SM53a7aeeed5ac474ea' SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea' SELECT * FROM Media WHERE Sid = 'MS123456789' AND MessageSid = 'SM53a7aeeed5ac474ea' AND DateCreated > '2015-10-10'
Twilio does not allow Media to be added.
Twilio does not allow Media to be updated.
DELETE FROM Media WHERE MessageSid='MM319a82ae6d7411407ef7dc7d78eb2081' AND Sid='MS123456789'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | False |
The Id of the media. | |
| AccountSid | String | False |
The Id of the account associated with the media. | |
| ParentSid | String | False |
The Id of the entity that created the media. | |
| ContentType | String | False |
The MIME type of the media. | |
| DateCreated | Datetime | False |
The creation date of the media. | |
| DateUpdated | Datetime | False |
The modification date of the media. | |
| Uri | String | False |
The URL of the media. |
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 | Datetime | True |
The sent date of the message. | |
| AccountSid | String | True |
The account Id of the message. | |
| To | String | False |
The phone number the message was sent to. | |
| Sender | String | False |
The phone number or sender Id that sent the message. | |
| MessagingServiceSid | String | True |
The messaging service Id of the message. | |
| Body | String | False |
The body of the message. | |
| MediaUrl | String | False |
The URL of the media you wish to send out with the message. | |
| Status | String | True |
The status of the message. One of the following values: accepted, queued, sending, sent, failed, delivered, undelivered, receiving, or received. | |
| NumSegments | Integer | True |
The number of segments that make up the message. | |
| NumMedia | Integer | True |
The number of media files associated with the message. The maximum is 10. | |
| Direction | String | True |
The direction of the message. One of the following values: inbound, outbound-api, outbound-call, or outbound-reply. | |
| ApiVersion | String | True |
The API version of the message. | |
| Price | Decimal | True |
The price of the message. | |
| PriceUnit | String | True |
The currency of the message. | |
| ErrorCode | String | True |
The error code of the message. | |
| ErrorMessage | String | True |
The error message. | |
| Uri | String | True |
The URI of the message. |
Insert, update, and query the verified numbers that may be used as a caller Id when making outgoing calls in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for OutgoingCallerIds are PhoneNumber, Name, and Sid.
SELECT * FROM OutgoingCallerIds WHERE Sid = 'X123456789'
To add an OutgoingCallerId use the AddOutgoingCallerIds stored procedure.
EXEC AddOutgoingCallerIds PhoneNumber = '+15105555555'
Twilio allows the Name column to be updated.
UPDATE OutgoingCallerIds SET Name = 'test' WHERE Sid = 'O123456789'
Twilio does not allow OutgoingCallerIds to be deleted.
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | True |
The Id of the outgoing caller Id. | |
| AccountSid | String | True |
The account Id of the outgoing caller Id. | |
| DateCreated | Datetime | True |
The creation date of the outgoing caller Id. | |
| DateUpdated | Datetime | True |
The modfication date of the outgoing caller Id. | |
| Name | String | False |
The friendly name of the outgoing caller Id. By default, this is a formatted phone number. | |
| PhoneNumber | String | False |
The phone number of the outgoing caller Id. | |
| Uri | String | True |
The URI of the outgoing caller Id. |
Delete and query the available Recordings in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Recordings are CallSid, DateCreated, and Sid. DateCreated may be used with the >, >=, <, <=, or = conditions.
SELECT * FROM Recordings WHERE DateCreated > '2011-10-10'
Twilio does not allow Recordings to be added.
Twilio does not allow Recordings to be updated.
DELETE FROM Recordings WHERE Sid='REfb1f22afc4f6243242'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | False |
The Id of the recording. | |
| ApiVersion | String | False |
The API version of the recording. | |
| CallSid | String | False |
The Id of the call for the recording. | |
| DateCreated | Datetime | False |
The creation date of the recording. | |
| DateUpdated | Datetime | False |
The modification date of the recording. | |
| Duration | Double | False |
The duration of the recording in seconds. | |
| AccountSid | String | False |
The account Id of the recording. | |
| Uri | String | False |
The URI of the recording. |
Create, update, delete, and query the available Lists for a specific Service in Twilio Sync.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for ServiceLists are Sid, and ServiceSid.
SELECT * FROM ServiceLists WHERE Sid = 'ES5efaf437f5274d89a79' AND ServiceSid = 'ISbd3a2af64' SELECT * FROM ServiceLists WHERE ServiceSid = 'ISbd3a2af64'
To add a ServiceList, specify at least the ServiceSid and UniqueName.
INSERT INTO ServiceLists (ServiceSid, UniqueName) VALUES ('ISbd3a2af64e5c39', 'Denis')
UPDATE ServiceLists SET TimeToLive = 10 WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'
DELETE FROM ServiceLists WHERE Sid='ES5efaf437f5274d89a79' AND ServiceSid='ISbd3a2af64'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | False |
The unique string that identifies the Sync List resource. | |
| ServiceSid | String | False |
Services.Sid |
The SID of the Sync Service the resource is associated with. |
| AccountSid | String | True |
Accounts.Sid |
The SID of the Account that created the Sync List resource. |
| UniqueName | String | False |
An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. This column will work only with INSERT. | |
| Url | String | True |
The absolute URL of the Sync List resource. | |
| Revision | String | True |
The current revision of the Sync List, represented as a string. | |
| DateCreated | Datetime | True |
The date and time when the resource was created. | |
| DateUpdated | Datetime | True |
The date and time when the resource was last updated. | |
| DateExpires | Datetime | True |
The date and time when the Sync List expires and will be deleted. If the Sync List does not expire, this value is null. The Sync List might not be deleted immediately after it expires. | |
| CreatedBy | String | True |
The identity of the Sync List's creator. If the Sync List was created from inserting into ServiceLists table, the value is system. | |
| TimeToLive | Integer | False |
This column is used only when updating. It specifies how long, in seconds, before the Sync List expires and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is 0, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion. | |
| Links | String | True |
The URLs of the Sync List's nested resources. |
Query the available Transcriptions in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Transcriptions are RecordingSid and Sid.
SELECT * FROM Transcriptions WHERE Sid = 'T12345564'
Twilio does not allow Transcriptions to be added.
Twilio does not allow Transcriptions to be updated.
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | False |
The Id of the transcription. | |
| AccountSid | String | False |
The account Id of the transcription. | |
| ApiVersion | String | False |
The API version of the transcription. | |
| DateCreated | Datetime | False |
The creation date of the transcription. | |
| DateUpdated | Datetime | False |
The modification date of the transcription. | |
| Duration | Integer | False |
The duration of the transcription in seconds. | |
| Price | Decimal | False |
The price of the transcription. | |
| RecordingSid | String | False |
The recording Id of the transcription. | |
| Status | String | False |
The status of the transcription. One of the following values: in-progress, completed, or failed. | |
| TranscriptionText | String | False |
The transcription text. | |
| Type | String | False |
The type of the transcription. | |
| Uri | String | False |
The URI of the transcription. | |
| PriceUnit | String | False |
The currency in which price is measured, in ISO 4127 format (e.g. usd, eur, jpy). |
Create, update, delete, and query usage Triggers in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Triggers are Category, TriggerBy, UsageCategory, and Sid.
SELECT * FROM Triggers WHERE Sid = 'X123456789'
To add a Trigger specify the UsageCategory, TriggerValue, and CallbackUrl. Other optional columns are Name, TriggerBy, Recurring, and CallbackMethod.
INSERT INTO Triggers (UsageCategory, TriggerValue, CallbackUrl, CallbackMethod, Name, Recurring, TriggerBy)
VALUES ('sms', 100, 'http://twilio.com/test', 'POST', 'trigger test', 'monthly', 'price')
Triggers allow UPDATEs for the Name, CallbackUrl, and CallbackMethod columns.
UPDATE Triggers SET Name = 'updated' WHERE Sid = 'X123456789'
| Name | Type | ReadOnly | References | Description |
| Sid [KEY] | String | True |
The Id of the trigger. | |
| AccountSid | String | True |
The account Id of the trigger. | |
| DateCreated | Datetime | True |
The creation date of the trigger. | |
| DateUpdated | Datetime | True |
The modification date of the trigger. | |
| DateFired | Datetime | True |
The fired date of the trigger. | |
| Name | String | False |
The friendly name of the trigger. | |
| UsageCategory | String | False |
The usage category the trigger watches. For example: calls, sms, phonenumbers, recordings, transcriptions, totalprice. | |
| TriggerBy | String | False |
The usage record field that the trigger is watching. Allowed values: count, usage, and price. 使用できる値は次のとおりです。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. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| 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. | |
| Locality | String | The locality/city of this phone number. |
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. | |
| ContentSid | String | The unique ID of the multi-channel Rich Content template. | |
| LinksChannelMetadata | String | Contains an absolute API resource URL to access the delivery & read receipts of 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. | |
| LastReadMessageIndex | Integer | Index of last “read” message in the Conversation for the Participant. | |
| LastReadTimestamp | Datetime | Timestamp of last “read” message in the Conversation for the Participant. |
Conversation includes a list of current Participants and the Messages that they have sent amongst each other.
A Conversation is a unique thread of a conversation. each Conversation includes a list of current Participants and the Messages that they have sent amongst each other.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison.
NOTE: ConversationSid is required in order to query Conversations.
SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' SELECT * FROM ConversationParticipants WHERE conversationsid = 'CH7040b87e3664410aa4c241a3d6c85f0b' AND Sid = 'IS62451554b2b349d6a0bee0b047ead195' SELECT * FROM Conversations where State = 'active' SELECT * FROM Conversations where DateCreated = '2015-12-16T22:18:37' and DateUpdated = '2015-12-16T22:18:38'
| Name | Type | References | Description |
| Sid [KEY] | String | A 34 character string that uniquely identifies this resource. | |
| AccountSid | String | The unique ID of the Account responsible for this conversation. | |
| AttributesTopic | String | An optional string metadata field you can use to store any data | |
| ChatServiceSid | String | The unique ID of the Conversation Service this conversation belongs to. | |
| DateCreated | Datetime | The date that this resource was created. | |
| DateUpdated | Datetime | The date that this resource was last updated. | |
| FriendlyName | String | The human-readable name of this conversation, limited to 256 characters. Optional. | |
| LinksMessages | String | Contains absolute URLs to access the participants of this conversation. | |
| LinksParticipants | String | Contains absolute URLs to access the participants of this conversation. | |
| MessagingServiceSid | String | The unique ID of the Messaging Service this conversation belongs to. | |
| State | String | Current state of this conversation.
使用できる値は次のとおりです。active, inactive, closed | |
| TimersDateClosed | Datetime | Timer date values representing state update for this conversation. | |
| TimersDateInactive | Datetime | Timer date values representing state update for this conversation. | |
| UniqueName | String | An application-defined string that uniquely identifies the resource. | |
| Url | String | An absolute API resource URL for this conversation. | |
| Bindings | String | Binding 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.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can be used with only the equals or = comparison. The available columns for Services is Sid.
SELECT * FROM Services SELECT * FROM Services WHERE Sid = 'IS5834ff94f011bc4e627a3'
| Name | Type | References | Description |
| Sid [KEY] | String | The unique string that Twilio's created to identify the Service resource. | |
| AccountSid | String |
Accounts.Sid | The SID of the Account that created the Service resource. |
| UniqueName | String | An application-defined string that uniquely identifies the resource. | |
| FriendlyName | String | The string that you assigned to describe the resource. | |
| DateCreated | Datetime | The date and time when the service was created. | |
| DateUpdated | Datetime | The date and time when the service was last updated. | |
| Url | String | The absolute URL of the service. | |
| WebhookUrl | String | The URL that gets called when Sync objects are manipulated. | |
| WebhooksFromRestEnabled | Boolean | Whether the Service instance calls the WebhookUrl when the REST API is used to update Sync objects. The default is false. | |
| AclEnabled | Boolean | Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. | |
| ReachabilityWebhooksEnabled | Boolean | Whether the service instance calls WebhookUrl when client endpoints connect to Sync. The default is false. | |
| ReachabilityDebouncingEnabled | Boolean | Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event. | |
| ReachabilityDebouncingWindow | Integer | The reachability event delay in milliseconds if ReachabilityDebouncingEnabled = true. Is between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before WebhookUrl is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring. | |
| Links | String | The URLs of related resources. |
Query Usage Records in Twilio.
Twilio allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Triggers are Category, StartDate, EndDate, and Interval. StartDate and EndDate may be used with the >, >=, <, <=, or = conditions. Interval should be used as an escaped string, i.e [Interval].
SELECT * FROM UsageRecords WHERE [Interval] = 'Today'
| Name | Type | References | Description |
| AccountSid | String | The account Id of the usage record. | |
| Category | String | The category of the usage record. For example, calls, sms, phonenumbers, recordings, transcriptions, and totalprice. | |
| Description | String | The description of the usage record. | |
| StartDate | Date | The start date of the usage record. You can also specify an offset, such as -30days. | |
| EndDate | Date | The end date of the usage record. You can also specify an offset, such as -1year. | |
| Count | Integer | The number of usage events. For example: the number of calls. | |
| CountUnit | String | The type of the usage events counted. For example: calls and messages. | |
| Usage | Double | The amount of usage. | |
| UsageUnit | String | The usage unit. For example: minutes and messages. | |
| Price | Decimal | The total price of the usage. | |
| PriceUnit | String | The currency of the price. | |
| ApiVersion | String | The API version of the usage record. | |
| Uri | String | The URI of the usage record. | |
| AsOf | Datetime | Usage records up to date as of this timestamp, formatted as YYYY-MM-DDTHH:MM:SS+00:00 | |
| SubresourceUris | String | A list of related resources identified by their URIs. For more information, see List Subresources. |
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 |
ストアドプロシージャはファンクションライクなインターフェースで、Twilio の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにTwilio から関連するレスポンスデータを返します。
| Name | Description |
| AddOutgoingCallerIds | Adds a new CallerId to your account. |
| SendMessage | Send outgoing SMS messages from your Twilio phone number to mobile phones around the globe. |
Adds a new CallerId to your account.
| Name | Type | Required | Description |
| PhoneNumber | String | True | The phone number to verify. Should be formatted with a + and country code; e.g., +16175551212 (E.164 format). Twilio will also accept unformatted US numbers; e.g., (415) 555-1212, 415-555-1212. |
| CallDelay | String | False | The number of seconds between 0 and 60 to delay before initiating the verification call. |
| Extension | String | False | Digits to dial after connecting the verification call. |
| StatusCallback | String | False | The URL that Twilio will pass status parameters to. |
| StatusCallbackMethod | String | False | The HTTP method Twilio should use to make requests to the status callback URL. |
| Name | String | False | The name of the outgoing caller Id. By default, this is a formatted phone number. |
| Name | Type | Description |
| AccountSid | String | The unique Id of the Account to which the validation request belongs. |
| PhoneNumber | String | The incoming phone number being validated, formatted with a + and country code; e.g., +16175551212. |
| Name | String | The name you provided, if any. |
| ValidationCode | String | The 6-digit validation code that must be entered via the phone to validate this phone number for caller Id. |
| CallSid | String | The unique Id of the call created for this validation attempt. |
Send outgoing SMS messages from your Twilio phone number to mobile phones around the globe.
| Name | Type | Required | Description |
| From | String | True | The phone number or sender Id that sent the message. |
| Body | String | True | The body of the message. |
| To | String | True | The phone number the message was sent to. |
| StatusCallback | String | False | By including a StatusCallback URL in your API call, you can tell Twilio where to POST information about your message. |
| Name | Type | Description |
| Status | String | Sucess Message that represents message is sent. |
| AccountSid | String | Account Sid. |
| APIVersion | String | Version of the API. |
| Body | String | Message body. |
| DateCreated | String | Date created. |
| DateSent | String | Sent message date. |
| DateUpdated | String | Message updated date. |
| Direction | String | Direction. |
| ErrorCode | String | Error code in case message is not sent. |
| ErrorMessage | String | Error message in case message is not sent. |
| From | String | Twilio phone number or messaging service that sends this message. |
| MessagingServiceSid | String | Messaging service sid. |
| NumMedia | String | Num media. |
| NumSegments | String | Num segments. |
| Price | String | Price. |
| PriceUnit | String | Price Unit. |
| Sid | String | Sid. |
| SubresourceUrisMedia | String | Subresource media urls. |
| To | String | PhoneNumber on which messaging is sent. |
| Uri | String | Uri. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Twilio のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Applications テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Applications'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのTwilio プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Applications テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Applications'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Twilio. |
| AccountSID | Account SID of the currently authenticated user. |
| AuthToken | Auth token of the currently authenticated user. |
| APIKeySID | API Key SID of the currently authenticated user. |
| APIKeySecret | API key secret of the currently authenticated user. |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to Twilio. |
| AccountSID | Account SID of the currently authenticated user. |
| AuthToken | Auth token of the currently authenticated user. |
| APIKeySID | API Key SID of the currently authenticated user. |
| APIKeySecret | API key secret of the currently authenticated user. |
The type of authentication to use when connecting to Twilio.
string
"AuthToken"
Account SID of the currently authenticated user.
string
""
Account SID of the currently authenticated user.
Auth token of the currently authenticated user.
string
""
Auth token of the currently authenticated user.
API Key SID of the currently authenticated user.
string
""
API Key SID of the currently authenticated user.
API key secret of the currently authenticated user.
string
""
API key secret of the currently authenticated user.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
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 |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.