Viberメッセージテンプレートを使用する
Viberメッセージテンプレートを使用すると、事前に承認されたトランザクション通知とワンタイムパスワード(OTP（ワンタイムパスワード）)をエンドユーザーに大規模に送信できます。
テンプレート管理エンドポイント (/viber/1/senders/{sender}/templates) は早期アクセスです。これらのエンドポイントを使用する前に、アカウントでviber-bm:manageスコープを有効にする必要があります。NTT CPaaS アカウント マネージャーに連絡して、スコープを有効にしてください。
Viber メッセージ テンプレートの作成と登録
Viber メッセージ テンプレートは、Web インターフェイスまたは Viber Business Messages API を使用して作成および登録できます。
テンプレートの承認を確実にするには、テンプレート body constraints および compliance guidelines に記載されている制約に従ってください。
Web インターフェイス経由のメッセージテンプレート
WebインターフェイスでViberメッセージ テンプレートを作成して登録するには:
- ログインして チャンネルと番号 > チャンネル > Viber for Business に移動します。
- 送信者 タブを選択します。
- 送信者を選択し、[テンプレートの作成] を選択します。
- テンプレートカテゴリ(トランザクションまたはOTP（ワンタイムパスワード）)を選択します。
- デザインタブで、メッセージの内容を入力し、中括弧アイコンを使用してパラメータを挿入します。
- テンプレートの登録 を選択し、生成されたテンプレート ID を保存します。
送信されたテンプレートを表示するには、送信者 タブで送信者に対して [テンプレートの表示] を選択します。
スクリーンショットを使用した詳細な手順は、テンプレートの作成と送信をご参照ください。
API 経由のメッセージテンプレート
Viber Business Messages APIを使用して、テンプレートを作成、取得、送信、削除できます。
| Method (メソッド) | パス | 成功 | 形容 |
|---|---|---|---|
| 投稿 | /viber/1/senders/{sender}/templates | 201 作成 | 送信者用に新しいトランザクション テンプレートまたは OTP（ワンタイムパスワード） テンプレートを登録します。 |
| 取得 | /viber/1/senders/{sender}/templates/{templateId} | 200 OK | テンプレートとその承認ステータスを取得します。 |
| 投稿 | /viber/2/messages | 200 OK | 承認済みのテンプレートを 1 人以上の受信者に送信します。 |
| 削除 | /viber/1/senders/{sender}/templates/{templateId} | 204 コンテンツなし | テンプレートを完全に削除します。 |
すべてのエンドポイントは、APIキーヘッダー(Authorization:App {api-key})、APIキークエリパラメーター、HTTP Basic、またはOAuth 2.0の認証方法を受け入れます。詳細は API 認証 を参照してください。
エンドポイントの完全な仕様については、 Viber Business Messages APIリファレンスを参照してください。
テンプレートのカテゴリ
ユースケースに応じて、2 つのメッセージ テンプレート カテゴリを使用できます。
トランザクション
注文確認、配送の更新、予約のリマインダーなど、非 OTP（ワンタイムパスワード） 通知を送信します。トランザクションテンプレートは、パーソナライゼーション用に最大 8 つの名前付きパラメーターをサポートします。
詳細な手順については、トランザクションテンプレートを参照してください。
OTP
認証フロー用のワンタイムパスワードと確認コードを送信します。OTP（ワンタイムパスワード）テンプレートには、テンプレート本文に{{pin}}プレースホルダを含める必要があります。
詳細な手順については、テンプレートの作成と送信を参照してください。
テンプレート ボディの制約
次の表に、すべてのテンプレート カテゴリに適用される制約を示します。
| 制約 | 価値 |
|---|---|
| 最大全長 | すべてのパラメータ値を含む 1000 文字。 |
| 最大パラメータ | 8 |
| 開始時の変数 | テンプレート本文は、少なくとも 1 つの非プレースホルダー文字で始まる必要があります。 |
| 変数の連続 | 連続するプレースホルダは、少なくとも 1 つのスペースで区切る必要があります。例: {{firstName}} {{lastName}} は許可されます。 |
| 末尾の変数 | 非 OTP（ワンタイムパスワード） テンプレートは、プレースホルダで終わることはできません。最後のプレースホルダの後にスペースを追加し、その後に少なくとも 1 つのスペース以外の文字を追加します。
NOTE プレースホルダーの後だけでなく、句読点の前にスペースを追加します。スペースがないと、Viber は句読点をプレースホルダ値の一部として扱い、テンプレートの最後にプレースホルダが配置され、テンプレートの作成が失敗します。このルールは、OTP（ワンタイムパスワード）テンプレートには適用されず、 |
| パラメータごとの値の長さ | 各パラメータ値は 125 文字を超えてはなりません。 |
| パラメーター内の URL | URL 全体をプレースホルダにすることはできません。承認済みテンプレートで URL ドメインを直接定義し、パス、スラッグ、識別子などの動的部分にのみプレースホルダを使用します。URL 内で使用されるプレースホルダは、URL が連続したままになるように、周囲にスペースを入れてはなりません。
NOTE Viberでは、URLドメインが承認済みテンプレートの一部である必要があるため、宛先をクライアントの検証済みブランドに関連付けることができます。 |
| OTP（ワンタイムパスワード） パラメーター | OTP（ワンタイムパスワード）テンプレートには{{pin}}という名前のプレースホルダを含める必要があり、同じプレースホルダで終わることができます。例: 確認コードは {{pin}} ですは許可されます。 |
テンプレートのステータス
作成後、テンプレートは承認プロセスを経ます。次のステータスは、テンプレートがそのプロセスのどこにあるかを示します。
| 地位 | 意味 | アクション |
|---|---|---|
| 保留 中 | 審査待ち | 待ってから再度ポーリングします。ステータスが [承認済み] に変わった後にのみ送信します。 |
| 承認 | 審査に合格し、すぐに使用できます | 送信に進みます。 |
| 減少 | 審査に合格しませんでした | テンプレートのテキストをコンプライアンスガイドライン(/viber/business-messages/compliance-guidelines)に照らして確認し、改訂されたテンプレートを作成します。 |
承認は通常数秒以内に完了しますが、最大 24 時間かかる場合があります。一般的な拒否の理由には、最後の単語がプレースホルダーであることや、宣伝資料を含むコンテンツが含まれます。
サポートされている言語
テンプレートは40の言語をサポートしています。テンプレートの作成時に言語コードを指定します。