WhatsApp テンプレート管理API

WhatsApp Template Management API では、既存の WhatsApp テンプレートの一覧表示、新規テンプレートの作成、テンプレートの削除、テンプレート内で使用するメディアのアップロードが可能です。WhatsAppテンプレートは WhatsApp ビジネスマネージャー UI, Vonage WhatsApp Template Management APIにより、WhatsApp Business APIを通じてテンプレートをプログラムで管理できるようになりました。

WhatsApp Template Management API では現在以下の操作が可能です：

現在、WhatsAppはメッセージテンプレート内での「連絡先&位置情報」の送信をサポートしていません。これらのメッセージは受信メッセージに反応してのみ送信できます。

WhatsApp Template Management API のレート上限は 40rps です。

テンプレート一覧の取得

WhatsApp Template Management API を使用すると、WhatsApp ビジネスアカウントが所有するテンプレートの一覧を取得できます。API にはページネーションやフィルタリング機能があります。例えば、テンプレート毎にリクエストを絞り込むことができます。 status, languageそして name_or_content.

テンプレートの作成

様々なタイプやカテゴリのテンプレートを作成したり、テンプレートの複数の言語バリエーションを作成することができます。複数の言語バージョンのテンプレートを作成する場合は、バージョン間で翻訳の一貫性を保つようにしてください。

テンプレートが以下のようになっていることを確認してください。 WhatsAppメッセージテンプレートガイドライン.ガイドラインに正しく従わないと、テンプレートに影響を与える可能性があります。 承認済み.

テンプレートの内容と構成に関する要件は、テンプレートによって異なることに注意してください。 カテゴリー認証テンプレートが最も制限され、マーケティングテンプレートが最も柔軟である。そして メタ・ドキュメント には、異なるテンプレート・カテゴリーで何が許可されているかについての詳細情報があります。

承認プロセス

テンプレートはWhatsAppメッセージで使用する前にMetaの承認が必要です。テンプレートは初期状態で status の PENDING.承認されると status の APPROVEDそして使用することができる。

メディア・メッセージ・テンプレート

メディアメッセージテンプレートを作成する場合、まず使用するメディアをWhatsAppプラットフォームにアップロードする必要があります( メディアのアップロード).アップロードされたメディアには、テンプレート作成時に指定できる一意のハンドルが付けられます。

言語バリエーション

異なる言語に対応するために、テンプレートの複数のバリエーションを作成することができます。これを行うには、同じ name そして category を既存のテンプレートとして設定し language プロパティと、新しい言語バリアントに適切なすべてのテキストコンテンツを追加します。サポートされている言語のリストは WhatsApp ドキュメント.

テンプレートカテゴリー

2023年6月1日より、WhatsAppは企業向けメッセージ送信に新しい会話カテゴリーを導入します。 これ.ビジネス主導の会話タイプごとに3つのテンプレート・カテゴリーがサポートされるようになった：

  • UTILITY:購入後の通知や定期的な請求明細書など、特定の合意された要求や取引の完了を可能にしたり、進行中の取引に関する最新情報を顧客に提供したりする。
  • AUTHENTICATION:ワンタイムパスコードを利用し、様々なログイン段階（Account verification、Account recovery、Integrity challengesなど）でユーザーを確認することができます。
  • MARKETING:オプトインした顧客に適切なオファーを送信するなど、顧客に商品やサービスを販売するためのビジネス主導の会話。また、認証や実用的な会話ではない、ビジネスに関連した対話も含まれます。

これらのカテゴリのいずれかにある既存のテンプレートはすべて、新しいテンプレートカテゴリのいずれかに移行されます： TRANSACTIONAL, MARKETING, OTP, ACCOUNT_UPDATE, PAYMENT_UPDATE, PERSONAL_FINANCE_UPDATE, SHIPPING_UPDATE, RESERVATION_UPDATE, ISSUE_RESOLUTION, APPOINTMENT_UPDATE, TRANSPORTATION_UPDATE, TICKET_UPDATE, ALERT_UPDATE または AUTO_REPLY.

注意: 未認証のWhatsAppビジネスアカウントは最大250のメッセージテンプレートを持つことができます。 Verifyビジネスアカウント は最大6000のメッセージテンプレートを持つことができます。各言語のバリアントは1つのテンプレートとしてカウントされます。 hello_world 2つの言語に翻訳されたテンプレートは、この制限に関して2つのメッセージテンプレートとしてカウントされます。

WhatsApp ビジネスアカウントでは1時間に最大100メッセージテンプレートを作成できます。

テンプレートの削除

特定のWhatsAppビジネスアカウントに関連付けられたテンプレートを削除するには、テンプレートの名前またはIDを指定します。同じ名前のテンプレートに複数の言語バージョンがある場合、そのテンプレートを削除することができます、 すべて そのテンプレート名のバージョンは削除される。

一度削除された（承認された）テンプレート名は、30日間は再度使用できません。

削除されたテンプレートに対して送信されたメッセージは、まだ配信される可能性があります。 内 発送済みで未着の場合は30日。

テンプレートの更新

テンプレートIDによって特定される既存のテンプレートを更新することができます。テンプレートを編集する際には、いくつかの注意点があります：

  1. メッセージテンプレートの編集は Approved, Rejectedあるいは Paused の状態だ。
  2. ライブテンプレートを編集すると、テンプレートは自動承認の対象となります。書式設定およびビジネス・商取引ポリシーのチェックに合格したテンプレートは、そのテンプレートを使用してすでに送信しているメッセージの送信を継続するために必要な追加操作なしで、すぐに再びライブになります。
  3. を編集する。 Paused テンプレートは、自動承認の対象となります。フォーマット・チェックとビジネス・ポリシー・チェックに合格したテンプレートは、再び本番運用が可能になる。これらのテンプレートを使ってメッセージの送信を開始するには、企業はMessaging APIをAPIコールする必要がある。
  4. 更新エンドポイントでは、テンプレートのカテゴリーを変更することができます。リクエストが正常に送信されると、"previous_category" と更新された "category" の両方を見ることができます。
  5. 承認状態のメッセージテンプレートは、30日間に10回まで、または24時間以内に1回まで編集できます。Rejected（却下）またはPaused（一時停止）状態のメッセージは、回数に制限なく編集できます。

メディアのアップロード

メディアメッセージテンプレートで使用する画像、動画、PDFファイルなどのメディアをWhatsAppプラットフォームにアップロードできます。メディアメッセージテンプレートで使用するには、事前にメディアをアップロードする必要があります。

注意: 大容量メディアファイル(例:25MB以上)をアップロードしようとすると、タイムアウトが発生する場合があります。その場合、WhatsApp Business Manager UIを使用してファイルをアップロードすることをお勧めします。

cURLリクエスト例

curl --location 'https://api.nexmo.com/v2/whatsapp-manager/media/uploads?file_type=image%2Fjpg' \
--header 'Authorization: Basic NTE1...g==' \
--form 'mediafile=@"Directory/WhatsApp_Image.jpeg"'