REST API: Application

Application インスタンスリソースは、ユーザーが Twilio で作成したアプリケーションを表現します。 Twilio 内部のアプリケーションは、ユーザーの Twilio 番号に通話や SMS が着信した時に Twilio がどのように振る舞うかを指示するための、URL とその他のコンフィグレーションデータのセットです。このコンフィグレーションデータは、IncomingPhoneNumber リソースのコンフィグレーションデータと同じです。つまり、VoiceUrl、VoiceMethod、VoiceFallbackUrl、VoiceFallbackMethod、StatusCallback、 StatusCallbackMethod、VoiceCallerIdLookup、SmsUrl、SmsMethod、SmsFallbackUrl、SmsFallbackMethod、SmsStatusCallback がこれに当たります。

Application のリストリソースは、あるアカウントの Twilio アプリケーションのセットを表現します。新しいアプリケーションを作成するには、このリストリソースに POST します。アカウントには最大 1000 個のアプリケーションを作成できます。

アプリケーションは、複数の電話番号にまたがって使用するコンフィグレーション情報をカプセル化する際に使えます。 ApplicationSid を IncomingPhoneNumber に割り当てることで、Twilio に対して、IncomingPhoneNumber に設定された URL の代わりに、アプリケーションの URL を使用するよう指示できます。アプリケーションを作成し、VoiceUrl をhttp://myapp.com/answer にセットします。このアプリケーションをすべての自分の電話番号に割り当てると、通話が着信するたびに、Twilio はこの URL へリクエストを送信します。

Application properties

`account_sid`	sid<AC> Not PII このアプリケーションを作成した Account のユニーク ID です。
`api_version`	文字列 Not PII このアプリケーションへのリクエストが送信されると、この API バージョンを使って新しい TwiML セッションを開始します。
`date_created`	date_time<rfc2822> Not PII このリソースが生成された日付の GMT 表記です。 RFC 2822 フォーマットを使用します。
`date_updated`	date_time<rfc2822> Not PII このリソースが最後に更新された日付の GMT 表記です。RFC 2822フォーマットを使用します。
`friendly_name`	文字列 Not PII このリソースの、人間が読みやすい形式の説明です。64 文字まで設定できます。
`message_status_callback`	url Not PII `/Messages`エンドポイントを使い、メッセージ送信、アプリケーションの`Sid`をSMS送信リクエストの際`ApplicationSid`として特定した場合、Twilioは`POST`リクエストをこのURLにステータスパラメーター（Sentもしくはfailed)を渡すために発行します。
`sid`	sid<AP> Not PII このリソースを一意に識別する 34 文字の文字列です。
`sms_fallback_method`	http_method Not PII 上述の URL へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`sms_fallback_url`	url Not PII `SmsUrl` から TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する URL です。
`sms_method`	http_method Not PII `SmsUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`sms_status_callback`	url Not PII このアプリケーションの`Sid`がSMS送信リクエストで特定された場合、`/SMS/Messages`エンドポイントにメッセージが送信された時、Twilioが`POST`するURL。
`sms_url`	url Not PII このアプリケーションに割り当てられた番号への着信 SMS メッセージを受信した時に、Twilio がリクエストを送信する URL です。
`status_callback`	url Not PII ステータスパラメーター (通話の終了など) をアプリケーションへ渡すために、Twilio がリクエストを送信する URL です。
`status_callback_method`	http_method Not PII `StatusCallback` URL へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`uri`	uri Not PII このリソースの URI です。`https://api.twilio.com` からの相対パスです。
`voice_caller_id_lookup`	boolean Not PII 発信者の発信者 ID 名を、CNAM データベースから検索します (追加料金が発生します)。`true` または `false` のいずれかです。
`voice_fallback_method`	http_method Not PII `VoiceFallbackUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`voice_fallback_url`	url Not PII VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する `Url` です。
`voice_method`	http_method Not PII 上述の `Url` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`voice_url`	url Not PII このアプリケーションに割り当てられた電話番号への通話を受けた時に、Twilio がリクエストを送信する URL です。

Create an Application resource

post

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications.json

アカウント内で新しいアプリケーションを作成します。

リクエストが成功すると、Twilio は新しいアプリケーションの表現を返します。

パラメーター

`FriendlyName` 必須	post 文字列 Not PII A human readable description of the new application, maximum of 64 characters.
`ApiVersion` オプション	post 文字列 Not PII このアプリケーションの URL へのリクエストが送信されると、この API バージョンを使って新しい TwiML セッションを開始します。`2010-04-01` または `2008-08-01`のいずれかです。初期値は、このアカウントのデフォルト API バージョンです。
`MessageStatusCallback` オプション	post url Not PII `/Messages`エンドポイントを使い、メッセージ送信、アプリケーションの`Sid`をSMS送信リクエストの際`ApplicationSid`として特定した場合、Twilioは`POST`リクエストをこのURLにステータスパラメーター（Sentもしくはfailed)を渡すために発行します。
`SmsFallbackMethod` オプション	post http_method Not PII `SmsFallbackUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。必ず `GET` または `POST` のいずれかとします。初期値は `POST` です。
`SmsFallbackUrl` オプション	post url Not PII 上述の `SmsUrl` で指定された TwiML のリクエストまたは実行時にエラーが発生した場合、Twilio がリクエストを送信する URL です。
`SmsMethod` オプション	post http_method Not PII `SmsUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。必ず `GET` または `POST` のいずれかとします。初期値は `POST` です。
`SmsStatusCallback` オプション	post url Not PII このアプリケーションの`Sid`をSMS送信リクエストの際`ApplicationSid`として特定した場合、Twilioは`POST`リクエストをこのURLにステータスパラメーター（Sentもしくはfailed)を渡すために発行します。
`SmsUrl` オプション	post url Not PII このアプリケーションに割り当てられた番号への着信 SMS メッセージを受信した時に、Twilio がリクエストを送信する URL です。
`StatusCallback` オプション	post url Not PII ステータスパラメーター (通話の終了など) をアプリケーションへ渡すために、Twilio がリクエストを送信する URL です。
`StatusCallbackMethod` オプション	post http_method Not PII `StatusCallback` URL へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。初期値は `POST` です。
`VoiceCallerIdLookup` オプション	post boolean Not PII 発信者の名前を CNAM データベースから検索し、アプリケーションへ通知します。`true` または `false` のいずれかです。初期値は `false` です。
`VoiceFallbackMethod` オプション	post http_method Not PII `VoiceFallbackUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。初期値は `POST` です。
`VoiceFallbackUrl` オプション	post url Not PII VoiceUrl でリクエストされた TwiML の取得または実行時にエラーが発生した場合、Twilio がリクエストを送信する `Url` です。
`VoiceMethod` オプション	post http_method Not PII `VoiceUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。必ず `GET` または `POST` のいずれかとします。初期値は `POST` です。
`VoiceUrl` オプション	post url Not PII このアプリケーションに割り当てられた番号がダイヤルされた時に、Twilio がリクエストを送信する URL です。

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

アカウント内で新しいアプリケーションを作成

Fetch an Application resource

GET

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json

パラメーター

Sid

必須

GET sid<AP> Not PII

The application Sid that that uniquely identifies this resource

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Fetch an Application

Read multiple Application resources

GET

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications.json

Application リソース表現のリストを返します。各項目は、アカウント内のアプリケーションを表現します。このリストはページ情報を含みます。

パラメーター

FriendlyName

オプション

GET 文字列 Not PII

Only return application resources with friendly names that match exactly with this name

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

すべての Application リソース表現のリストの取得

例 2

Loading Code Sample...

Next Sample

出力を表示

出力

Return the Application named "MyApp"

Update an Application resource

post

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json

アプリケーションのプロパティを更新します。更新に成功すると、更新されたリソース表現を返します。返却されるレスポンスは、GET リクエストを送信した場合と同じです。

パラメーター

`ApiVersion` オプション	post 文字列 Not PII このアプリケーションの URL へのリクエストが送信されると、この API バージョンを使って新しい TwiML セッションを開始します。`2010-04-01` または `2008-08-01`のいずれかです。
`FriendlyName` オプション	post 文字列 Not PII このアプリケーションの、人間が読みやすい形式の説明です。64 文字まで設定できます。
`MessageStatusCallback` オプション	post url Not PII `/Messages`エンドポイントを使い、メッセージ送信、アプリケーションの`Sid`をSMS送信リクエストの際`ApplicationSid`として特定した場合、Twilioは`POST`リクエストをこのURLにステータスパラメーター（Sentもしくはfailed)を渡すために発行します。
`SmsFallbackMethod` オプション	post http_method Not PII `SmsFallbackUrl` へリクエストを送信する際に、Twilioが使用するHTTPのメソッドです。`GET` または `POST` のいずれかです。
`SmsFallbackUrl` オプション	post url Not PII 上述の `SmsUrl` で指定された TwiML のリクエストまたは実行時にエラーが発生した場合、Twilio がリクエストを送信する URL です。
`SmsMethod` オプション	post http_method Not PII `SmsUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`SmsStatusCallback` オプション	post url Not PII このアプリケーションの`Sid`がSMS送信リクエストで特定された場合、`/SMS/Messages`エンドポイントにメッセージが送信された時、Twilioが`POST`するURL。
`SmsUrl` オプション	post url Not PII このアプリケーションに割り当てられた番号への着信 SMS メッセージを受信した時に、Twilio がリクエストを送信する URL です。
`StatusCallback` オプション	post url Not PII ステータスパラメーター (通話の終了など) をアプリケーションへ渡すために、Twilio がリクエストを送信する URL です。
`StatusCallbackMethod` オプション	post http_method Not PII `StatusCallback` URL へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`VoiceCallerIdLookup` オプション	post boolean Not PII 発信者の発信者 ID 名を、CNAM データベースから検索します (追加料金が発生します)。`true` または `false` のいずれかです。
`VoiceFallbackMethod` オプション	post http_method Not PII `VoiceFallbackUrl` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`VoiceFallbackUrl` オプション	post url Not PII 上述の `VoiceUrl` で指定された TwiML のリクエストまたは実行時にエラーが発生した場合、Twilio がリクエストを送信する URL です。
`VoiceMethod` オプション	post http_method Not PII 上述の `Url` へリクエストを送信する際に、Twilio が使用する HTTP のメソッドです。`GET` または `POST` のいずれかです。
`VoiceUrl` オプション	post url Not PII このアプリケーションに割り当てられた番号がダイヤルされた時に、Twilio がリクエストを送信する URL です。