インバウンドSMS
受信SMSを受信するには ウェブフックエンドポイント のAPI設定タブでそれを使用するようにアカウントを設定する。 Vonage開発者ダッシュボード.
Vonage バーチャル番号のいずれかに送信されたメッセージは、
GET
または POST
リクエストを使用して Webhook に送信されます。Webhookでメッセージを受信するときは、GET
またはPOST
リクエストを使って 200 OK または 204 No Content の応答を返します。返信がない場合、Vonageはあなたがメッセージを受け取っていないとみなし、その後24時間再送信を続けます。 連結されたメッセージには特別な注意が必要です。参照 連結された受信メッセージ.
インバウンド・メッセージの解剖
メッセージは、以下のプロパティを持つJSONオブジェクトとしてWebhookエンドポイントに送信されます:
| キー | 価値 | 必須 |
|---|---|---|
type | 可能な値は以下の通り:
| はい |
to | メッセージが送信された電話番号 への. これがあなたのバーチャルナンバーです。. | はい |
msisdn | この受信メッセージが送信された電話番号 より. | はい |
messageId | このメッセージに対するVonage独自の識別子。 | はい |
message-timestamp | について UTC±00:00 VonageがこのインバウンドメッセージをあなたのWebhookエンドポイントにプッシュし始めた時間: YYYY-MM-DD HH:MM:SS. | はい |
timestamp | について ユニックスタイムスタンプ 表現 message-timestamp. | いいえ |
nonce | リクエストの署名に予測不可能な要素を追加するランダム文字列。あなたは nonce そして timestamp パラメータと共有シークレットを使用して、受信メッセージの署名を計算し、検証します。 | あなたのメッセージが サイン入り |
タイプのメッセージの場合 text または unicode
もし type は text または unicodeこの場合、ウェブフック・エンドポイントへのリクエストには以下のプロパティが表示されます。
| キー | 価値 |
|---|---|
text | この受信メッセージのメッセージ・ボディ。 |
keyword | メッセージ本文の最初の単語。これは通常ショートコードで使われる。 |
タイプのメッセージの場合 binary
もし type は binaryこの場合、ウェブフック・エンドポイントへのリクエストには以下のプロパティが表示されます。
| キー | 価値 |
|---|---|
data | このメッセージの内容 |
udh | 16進エンコードされた ユーザーデータヘッダー |
連結された受信メッセージの場合
仮想番号に送信されたメッセージが、1つのメッセージの最大許容長に収まる場合、以下のプロパティはWebhookエンドポイントへのリクエストに表示されません。
メッセージが1つのメッセージで許可される最大文字数より長い場合、メッセージを分割して受信し、以下のプロパティがリクエストに表示されます。
を使用する。 concat-ref, concat-total そして concat-part プロパティを使って、個々のパーツからメッセージを構成する。
すべてのキャリアが連結メッセージをサポートしているわけではない。キャリアが連結をサポートしていない場合は concat フィールドはペイロードには存在しない。
| キー | 価値 |
|---|---|
concat | true |
concat-ref | トランザクションリファレンス。このメッセージのすべての部分はこれを共有する。 concat-ref. |
concat-total | 連結されたメッセージの Numbers。 |
concat-part | メッセージのこの部分の番号。メッセージの最初の部分は 1. |