REST API: Commands

Commandsリソースを使用すると、SMS機能を持つ機器からマシンからマシンへ簡単なメッセージを交換することができます。たとえば、コマンドを使用してデバイスに自身のAPNを変更するよう指示できます。

SMSは転送手段として使用されますが、コマンドを受け取るためにSIM側でのアドレス指定可能な電話番号は必要ありません。これは、会話メッセージングに使用されるTwilioのMessagesリソースとの主な相違点です。

SIMから確定済み電話番号へ送信されたメッセージ（SIMからコマンドを受信するを参照してください）はコマンドとして解釈され、SIMのコマンドコールバックURLに送信が行われます。

コマンドは、SMSテキストモード、またはバイナリー（PDU）モードで送受信できます。テキストモードコマンドの最大文字数は160文字（シングルバイト文字）／70文字（ダブルバイト文字）です。バイナリーモードコマンド最大長は140バイトです。

デバイスに送信されたコマンドを受信、処理するには、おそらく「ATコマンド」を使用してモデムと直接やりとりする必要があります。 SMSメッセージの受信には、GSM/LTEモジュールの製造元のドキュメントを確認してください。

非同期のリソース

Commandリソースは非同期オペレーションを実行します。 Commandリソースの更新終了時に非同期の通知を受信するには、最初のHTTPリクエストにコールバックURLと、オプションでコールバックメソッドパラメーターを指定するすることが必要です。下記に、これを行う例を示します。

HTTPリソースとメソッド

Commandインスタンスリソース

リソースURL

https://wireless.twilio.com/v1/Commands/{CommandSid}

リソースのプロパティ

Commandインスタンスリソースは以下のプロパティーによって構成されています。

Names in PHP format
`sid`	sid<DC> Not PII The unique string that we created to identify the Command resource.
`accountSid`	sid<AC> Not PII The SID of the Account that created the Command resource.
`simSid`	sid<DE> Not PII The SID of the Sim resource that the Command was sent to or from.
`command`	文字列 PII MTL: 30 DAYS メッセージがSIMに、またはSIMから送信されます。テキストモードのメッセージでは、半角ASCII文字160字以内に収めることが必要です。バイナリーモードのメッセージでは、base64を使用してエンコーディングされる、最大140バイトの一連のデータです。
`commandMode`	enum:command_mode Not PII The mode used to send the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.
`transport`	enum:transport Not PII The type of transport used. Can be: `sms` or `ip`.
`deliveryReceiptRequested`	boolean Not PII Whether to request a delivery receipt.
`status`	enum:status Not PII The status of the Command. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`. See Status Values for a description of each state.
`direction`	enum:direction Not PII The direction of the Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
`dateCreated`	date_time<iso8601> Not PII The date and time in GMT when the resource was created specified in ISO 8601 format.
`dateUpdated`	date_time<iso8601> Not PII The date and time in GMT when the resource was last updated specified in ISO 8601 format.
`url`	url Not PII The absolute URL of the resource.

ステータス値

下表は、Commandインスタンスで利用可能なstatus値について説明しています。

Status	概要
queued	コマンドはTwilioのネットワーク中でSIMへの送信の待機のため、待ち行列に入れられます。
sent	コマンドがSIMに送信されました。
delivered	コマンドがSIMに配信されました。（`to_sim`コマンド向け）
received	コマンドがSIMから受信されました。（`from_sim`コマンド向け）
failed	コマンドに失敗しました。

HTTP GET

コマンドの表現を返します。

例

JSONで表現されるSidを使用してCommandインスタンスをリクエストします。

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

コマンドの一覧リソース

リソース URL

https://wireless.twilio.com/v1/Commands

HTTP GET

アカウント内のCommandsリソースを一覧します。このリストにはページング情報が含まれます。

例 1

アカウントの全Commandを一覧します。

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

全コマンドを一覧する

リストフィルター

下記のGETのクエリー文字列パラメーターを使用すると、返される一覧を制限することができます。パラメーターは大文字と小文字を区別することに注意してください:

Names in PHP format
`sim` オプション	GET 文字列 Not PII The `sid` or `unique_name` of the Sim resources to read.
`status` オプション	GET enum:status Not PII The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.
`direction` オプション	GET enum:direction Not PII この方向のコマンドのみを返します。
`transport` オプション	GET enum:transport Not PII Only return Commands with this transport value. Can be: `sms` or `ip`.

HTTP POST

CommandリストリソースにPOSTリクエストを発行することで、新規Commandリストリソースを作成できます。これはSIMにコマンドを送ることと同義です。

パラメーター

Names in PHP format
`command` 必須	post 文字列 PII MTL: 30 DAYS The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode.
`sim` オプション	post 文字列 Not PII The `sid` or `unique_name` of the SIM to send the Command to.
`callbackMethod` オプション	post http_method Not PII The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`.
`callbackUrl` オプション	post url Not PII The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed.
`commandMode` オプション	post enum:command_mode Not PII The mode to use when sending the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.
`includeSid` オプション	post 文字列 Not PII Whether to include the SID of the command in the message body. Can be: `none`, `start`, or `end`, and the default behavior is `none`. When sending a Command to a SIM in text mode, we can automatically include the SID of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. A value of `start` will prepend the message with the Command SID, and `end` will append it to the end, separating the Command SID from the message body with a space. The length of the Command SID is included in the 160 character limit so the SMS body must be 128 characters or less before the Command SID is included.
`deliveryReceiptRequested` オプション	post boolean Not PII Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is `true`.

コールバック値

送信におけるコマンド配信は非同期で行われるため、コマンド送信の試行が完了した時点で呼び出されるコールバックURLを渡すことが推奨されます。コールバックには下記のパラメーターが含まれます。

パラメーター	概要
CommandSid	このコールバックが参照しているコマンドです。
CommandStatus	コマンドの現在のステータスです。
SimSid	このコマンの送信先のSIMです。
SimUniqueName	存在する場合、受信側のSIMのUniqueName（一意な名前）です。
ErrorCode	エラーの発生時、エラーコードが提供されます。
ErrorMessage	エラーの発生時、エラーメッセージが提供されます。
ApiVersion	最初のリクエストが発行されたAPIのバージョンです。
AccountSid	このコマンドの属するアカウントの一意なIDです。
CommandMode	SMSの送信にどのモードが使用されたかを表す文字列です。 `text` あるいは `binary` のいずれかです。

コールバックメソッドがPOSTに設定されるか指定されなかった場合、コールバックパラメーターはHTMLフォームパラメーターとして渡されます。コールバックメソッドがGETであった場合、コールバックパラメーターはクエリー文字列として渡されます。

例

SIMにコマンドを送信します。コマンドの配信の試行が完了した際に非同期で通知されるコールバックURLとコールバックメソッドを指定します。この例では、受信側のSIMを識別するため、「AliceSmithSmartMeter」というSIMのUniqueName（一意な名前）を使用します。

Commands sent from SIMs in `ready` status

A Command can be sent from a SIM in the ready status. Following the fifth Command sent to_sim or from_sim the device will automatically transition to the active status. Visit the SIM Status Values to learn more.

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Create a text Command

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Create a binary Command

HTTP PUT

サポートされていません。

HTTP DELETE

サポートされていません。

SIMからコマンドを受信する

SIMからコマンドを受信する（モバイルオリジネーション）には、CommandsCallbackUrlプロパティーと、オプションでCommandsCallbackMethodプロパティー（既定値はPOST）を使用して、既存のSIMインスタンスを更新することが必要です。

SIMがSMSメッセージを予約済み電話番号である「2936」に送信する際、Commandリソースが作成され、CommandsコールバックURLが呼び出されます。コールバックリクエストには下記のパラメーターが含まれます。

パラメーター	概要
CommandSid	このコマンドのSidです。
SimSid	このコマンドの送信元のSIMです。
SimUniqueName	存在する場合、送信側のSIMのUniqueName（一意な名前）です。
Command	コマンドメッセージの本文です。 `text`モードでは、この値は160文字以内（日本語を含む場合70文字以内）のテキストです。 `binary`モードの場合、この値は最大サイズが140バイトの、Base64でエンコーディングされた文字列です。
Status	常に「received」という文字列です。
ApiVersion	最初のリクエストが発行されたAPIのバージョンです。
AccountSid	このコマンドの属するアカウントの一意なIDです。
CommandMode	どのモードでSMSが受信されたかを表す文字列です。 `text` あるいは `binary` のいずれかです。

ヘルプが必要ですか？

誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。

Thanks for rating this page!

ヘルプが必要ですか？