Dispatch API 技術詳細

Vonage Dispatch APIを使用すると、開発者はマルチチャネル戦略を使用してユーザーにメッセージを送信することができます。

ワークフローの例としては、Facebookメッセンジャーでメッセージを送り、そのメッセージが読まれなかった場合、Viberでメッセージを送るように指定することができる。そのメッセージも読まれなければ、SMSでメッセージを送る。

Dispatch API は、メッセージの順序付けや、メッセージの指定に使う仕組みを提供します。 成功条件.Dispatch APIはMessages APIを使って実際にメッセージを送信する。

次の図は、Dispatch APIとMessages APIの関係を示している：

ベータ

このAPIは現在ベータ版です。

このリリースでは、Vonageはフェイルオーバー・テンプレートを提供します。フェイルオーバー・テンプレートは Messages API で、指定されたチャネルにメッセージを送信する。そのメッセージがすぐに失敗したり condition_status が指定された時間内に到達しなかった場合、次のメッセージが送信される。

Vonageは常にお客様のフィードバックをお待ちしております。お客様のご意見は製品の改善に役立ちます。サポートが必要な場合は、Eメール サポート を明記の上、件名に「Workflow API」とご記入ください。ベータ期間中、サポートは月曜日から金曜日までとさせていただきます。

対応機能

このリリースでは、次のことができる：

• 送信 SMS、Facebookメッセンジャー、WhatsApp、Viberビジネスメッセージの上に構築されたDispatchで Messages API.
• フェイルオーバー 時間内に条件ステータスが満たされない場合、またはメッセージが即座に失敗した場合、次のメッセージに移行する。

条件ステータスは、メッセージが返すステータスです。FacebookメッセンジャーとViberビジネスメッセージでは、次のように使用できます。 delivered そして read ステータスをコンディション・ステータスとして使用します。SMSで使用できるのは delivered.

外部アカウントAPI

について 外部アカウントAPI は、Viber Business Messages、Facebook Messenger、WhatsAppのアカウントを管理するために使用され、これらのチャンネルでMessages APIとDispatch APIを使用します。

スタート

この例では、以下の変数を便利な方法で実際の値に置き換える必要がある：

以下のコードは、Facebookのメッセンジャーでメッセージを送信し、制限時間内に読まれなかった場合、SMSでメッセージを送信するワークフローの作成方法を示しています：

curl -X POST https://api.nexmo.com/v0.1/dispatch \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "template":"failover",
    "workflow": [
      {
        "from": { "type": "messenger", "id": '$FB_SENDER_ID' },
        "to": { "type": "messenger", "id": '$FB_RECIPIENT_ID' },
        "message": {
          "content": {
            "type": "text",
            "text": "This is a Facebook Messenger Message sent from the Dispatch API"
          }
        },
        "failover":{
          "expiry_time": 600,
          "condition_status": "read"
        }
      },
      {
        "from": {"type": "sms", "number": '$FROM_NUMBER'},
        "to": { "type": "sms", "number": '$TO_NUMBER'},
        "message": {
          "content": {
            "type": "text",
            "text": "This is an SMS sent from the Dispatch API"
          }
        }
      }
    ]
  }'

Concepts

• 派遣ワークフローとは？: ディスパッチワークフローは、セカンダリチャネルへのフェイルオーバーを組み込んだ強固なメッセージングプランの構築に役立ちます。
• ディスパッチからメッセージ・フェイルオーバーへの移行: Dispatch APIとMessages APIのフェイルオーバー機能の違いについて説明します。

コード・スニペット

• Vonageメッセージとディスパッチアプリケーションの作成
• サーバーSDK
• フェイルオーバーでFacebookメッセージを送信
• フェイルオーバーでMMSを送信する
• フェイルオーバーでSMSを送信する
• フェイルオーバーでViberメッセージを送信する
• フェイルオーバーでWhatsAppメッセージを送信
• 始める前に

チュートリアル

• フェイルオーバーでFacebook Messengerメッセージを送信

使用例

• Dispatch APIを使用したマルチユーザー、マルチチャネルのフェイルオーバー

参考

• Dispatch API リファレンス
• 外部アカウント API リファレンス