SMSの送信

messagesノードを使って顧客にSMSを送信します。

開始する前に

メッセージのドキュメントの「開始する前に」セクションにリストされているすべての前提条件を満たす必要があります。

制約:

• SMSの長さは最大で4096文字です。

ステップ1: /messagesにPOSTリクエストを送信する

メッセージを送りたいユーザーのWhatsApp IDが用意できたら、それを使用してSMSを送信します。typeフィールドにtextを指定します。

POST /v1/messages
{
    "preview_url": false | true,
    "recipient_type": "individual",
    "to": "whatsapp-id",
    "type": "text",
    "text": {
        "body": "your-text-message-content"
    }
}

パラメーターに関する詳細については、以下を参照してください。

• すべてのメッセージリクエストに共通するパラメーター
• SMSのパラメーター

メッセージをフォーマットしたい場合は、SMSのフォーマットをご覧ください。

SMSによるURLの送信

WhatsAppモバイルアプリはデフォルトでURLを認識し、クリック可能にします。URLプレビューを含めるには、メッセージ本文に"preview_url": trueを入れます。URLは必ずhttp://またはhttps://で始まるものにしてください。ホスト名は必須です。IPアドレスの照合は行われません。

ここでのpreview_urlの使用はクラウドAPIとは異なることに注意してください。メッセージクラウドAPIのドキュメントをご覧ください。

例

{
    "preview_url": true,
    "to": "whatsapp-id",
    "text": {
        "body": "You have to check out this amazing messaging service https://www.whatsapp.com/"
     }

URLを送信すると大抵は、プレビューが含まれているかどうかにかかわらず、メッセージの受信者にクリック可能なURLが表示されます。

URLプレビューは、次のいずれかのイベントが発生した場合にのみレンダリングされます。

1. ビジネスがユーザーにメッセージテンプレートを送信した場合。
2. ユーザーが「クリックしてチャット」リンクを使用してスレッドを開始した場合。
3. ユーザーがビジネスの電話番号をアドレス帳に追加して、スレッドを開始した場合。

ステップ2: 応答を確認する

成功した場合の応答には、新たに作成されたメッセージのIDを格納するmessagesオブジェクトが含まれます。

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}  

失敗した場合の応答には、エラーメッセージが含まれます。詳しくは、エラーコードとステータスコードをご覧ください。