メッセージの種類

このセクションでは、様々な種類のメッセージとチャネルに対してメッセージAPIリクエストを構成する方法の概要を、いくつかの出力例を交えながら説明します。

メッセージの構造は、コミュニケーションに使用するメッセージの種類に応じて、ヘッダー、本文、フッター、ボタンなど、いくつかのセクションに分かれています。この構造は、ユーザーの電話でメッセージがどのようにレンダリングされるかに直感的に従います。例えば、画像またはWhatsAppテンプレートの一部をヘッダーテキストに含めることができます。メッセージAPI はこうしたことをすべて可能にします。

すべてのメッセージングチャネルが全種類のメッセージをサポートしているわけではありません。各チャネルでサポートされているメッセージの種類の詳細については、各チャネルについて詳しく記載しているドキュメントのページをご参照ください。

テキスト

メッセージAPIを使用して簡単なテキストのメッセージを送信します。

テキストメッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
LINE (LON)
Messenger
MMS
RCS
SMS
Viber Bots
Viber Business Messages
Whatsapp

例

json

2 "messages": [

3 {

4 "channel": "SMS",

5 "content": {

6 "body": {

7 "text": "Follow the link athleete.com/event-details for more details. See you next week!",

8 "type": "TEXT"

9 }

10 },

11 "sender": "441234567890",

12 "destinations": [

13 {

14 "to": "440987654321"

15 }

16 ]

17 }

18 ]

19}

出力

画像

メッセージで画像を送信します。

画像は、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
LINE (LON)
Messenger
MMS
RCS
Viber Bots
Viber Business Messages
Whatsapp

備考

画像付きのSMSを送信すると、画像のURLがレンダリングされます。

画像例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "type": "IMAGE",

8 "url": "http://homestore/image.png",

9 "text": "Spring is around the corner! Check out what we have in store for you."

10 }

11 },

12 "options": {

13 "adaptationMode": true

14 },

15 "sender": "441234567890",

16 "destinations": [

17 {

18 "to": "440987654321"

19 }

20 ]

21 }

22 ]

23}

出力

ヘッダー付き画像

メッセージヘッダー内にキャプション用テキストなどのデータを追加します。

ヘッダー付きの画像は、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
LINE (LON)
MMS

ヘッダー付きの画像例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "header": {

7 "text": "Spring is around the corner!"

8 },

9 "body": {

10 "type": "IMAGE",

11 "url": "http://homestore/image.png",

12 "text": "Check out what we have in store for you."

13 }

14 },

15 "options": {

16 "adaptationMode": true

17 },

18 "sender": "441234567890",

19 "destinations": [

20 {

21 "to": "440987654321"

22 }

23 ]

24 }

25 ]

26}

出力

Message API Unified API image with header example

ドキュメント

選択したメッセージングチャネルを介してファイルを送信します。

ドキュメントメッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
LINE (LON)
Messenger
MMS
Viber Bots
Viber Business Messages
Whatsapp

備考

チャネルの可用性と出力は、リクエストに含めるメッセージのエレメントによって異なります。例えば、Viber Business Messagesはファイル名が付いているドキュメントをサポートしていません。

備考

メッセージの種類としてドキュメントをネイティブにサポートしていないチャネルを使用している場合は、APIリクエストの一部として adaptationMode パラメーターを使用して、サポートされていないエレメントを削除し、エラーをスローせずにメッセージを配信できます。

ドキュメントの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "type": "DOCUMENT",

8 "url": "http://my.domain/document.pdf"

9 }

10 },

11 "options": {

12 "adaptationMode": true

13 },

14 "sender": "441234567890",

15 "destinations": [

16 {

17 "to": "440987654321"

18 }

19 ]

20 }

21 ]

22}

出力

ビデオ

コミュニケーションの一環としてビデオを送信します。

ビデオメッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
Messenger
MMS
RCS
Viber Bots
Viber Business Messages
Whatsapp

備考

動画をメッセージの種類としてネイティブにサポートしていないチャネルを使用している場合は、APIリクエストの一部として adaptationMode パラメーターを使用すると、サポートされていないエレメントを削除し、エラーをスローせずにメッセージを配信できます。

ビデオの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "type": "VIDEO",

8 "url": "http://my.domain/video.mp4"

9 }

10 },

11 "options": {

12 "adaptationMode": true

13 },

14 "sender": "441234567890",

15 "destinations": [

16 {

17 "to": "440987654321"

18 }

19 ]

20 }

21 ]

22}

出力

ボタン

コミュニケーションにボタンを追加すると、インタラクションを容易にします。

ボタンは、以下のチャネルでネイティブにサポートされています：

Apple Messages for Business
Instagram DM
LINE (LON)
Messenger
RCS
Viber Bots
Viber Business Messages
Whatsapp

備考

Viber Business Messagesは、メッセージ内の単一のボタンのみをサポートします。従って、このチャネルを使う時は、複数のボタンブロックではなく、1つのボタンブロックをリクエストに含めるようにする必要があります。

備考

ボタンをメッセージの種類としてサポートしていないチャネルを使用している場合は、APIリクエストの一部として adaptationMode パラメーターを使用すると、サポートされていないエレメントを削除し、エラーをスローせずにメッセージを配信できます。

ボタンの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "text": "Thank you for joining us on Athleete Unlocked! Would you like to subscribe for future Athleete events?",

8 "type": "TEXT"

9 },

10 "buttons": [

11 {

12 "type": "REPLY",

13 "text": "Yes",

14 "postbackData": "true"

15 },

16 {

17 "type": "REPLY",

18 "text": "No",

19 "postbackData": "false"

20 }

21 ]

22 },

23 "options": {

24 "adaptationMode": true

25 },

26 "sender": "441234567890",

27 "destinations": [

28 {

29 "to": "440987654321"

30 }

31 ]

32 }

33 ]

34}

出力

Message API Unified API Deliver anyway example

連絡先メッセージ

連絡先メッセージ の種類を使用すると、ユーザーは連絡先の詳細を受信者に直接送信して、アプリ内で連絡先情報を表示、連絡先メッセージを送信、または連絡先情報を保存できます。この機能は、ユーザーがアクション可能な連絡先の詳細を提供できるようにすることで、シームレスな情報共有をサポートし、受信者はそれを保存したり、インスタントコミュニケーションを開始するために使用したりできるようにします。

連絡先メッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています：

Viber Bots
Whatsapp

カルーセル

カルーセルメッセージを使用すると、顧客は1つのメッセージ内で複数のリッチカードを送信できます。ユーザーは、リッチカードを水平方向にスクロールしたり、様々なアイテムを比較したり、特定のアクションを実行して個々のカードを操作したりできます。

カルーセルメッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています：

Instagram DM
Messenger
RCS
Viber Bots

WhatsApp Flows

インタラクティブなWhatsApp Flowsを送信して、チャット内で直接構造化されたマルチステップタスクをユーザーに案内します。ユースケースには、予定のスケジュール設定、イベントへの登録、フィードバックの送信などがあります。フローは、標準のメッセージや単純なボタンと比較して、アプリのようなエクスペリエンスをより豊富に提供します。

メッセージAPIを使用してWhatsAppフローを送信するには、フローの送信セクションを参照してください。

備考

メッセージ API を使用する場合、フローは、ユーザーによって開始された 24 時間のセッションウィンドウ内に 自由形式のメッセージ として送信できます。

ウィンドウ外でフローを開始するには、フローテンプレートを使用し、テンプレートメッセージ として送信します。詳細については、WhatsApp フローおよび WhatApp フロー over API を参照してください。

フローは、以下のチャネルでネイティブにサポートされています：

メッセージAPI経由のフロー例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "sender": "YourWhatsAppSender", // required

6 "destinations": [

7 {

8 "to": "CustomerPhoneNumber" // required

9 }

10 ],

11 "content": {

12 "body": {

13 "type": "FLOWS",

14 // ... Flow-specific parameters required here ...

15 }

16 // Optional: header, footer, options

17 }

18 }

19 ]

20}

テンプレート

事前定義されたテンプレートを使ってメッセージを送信します。

テンプレートメッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています。

LINE (LON)
Viber Business Messages
Whatsapp

メッセージテンプレートには、ヘッダー、本文、フッター、ボタンなど、様々なセクションが含まれています。メッセージAPIを使用してテンプレートメッセージを送信する場合、コミュニケーションにヘッダーやボタンといったエレメントを含めるかどうかは任意です。

ヘッダー付きのテンプレートは、テンプレート化されたメッセージでメディアを送信することを表します。リクエストの例については、以下のヘッダー付きテンプレートをご参照ください。

テンプレートの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "1": "Jane",

8 "2": "Doe",

9 "type": "TEXT"

10 }

11 },

12 "sender": "441234567890",

13 "destinations": [

14 {

15 "to": "440987654321"

16 }

17 ],

18 "template": {

19 "templateName": "account_update",

20 "language": "en_GB"

21 }

22 }

23 ]

24}

出力

ヘッダー付きのテンプレート [#templates-with-headers-templates]

ヘッダー内にデータが含まれているテンプレートメッセージを送信したい時は、メッセージAPIを使用します。

テキスト
画像
ドキュメント
ビデオ
Location (位置情報)

以下の例は、メッセージAPIを使用したドキュメントヘッダー付きのWhatsAppテンプレートを示しています。

また、コミュニケーションシナリオの必要に応じて、画像、位置情報、ビデオを含むようにヘッダーコンテンツを調整することもできます。

ヘッダー付きのテンプレートの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "header": {

7 "url": "https://mydocument.com",

8 "filename": "Filename.doc",

9 "type": "DOCUMENT"

10 },

11 "body": {

12 "1": "Jane",

13 "2": "Doe",

14 "type": "TEXT"

15 }

16 },

17 "sender": "441234567890",

18 "destinations": [

19 {

20 "to": "440987654321"

21 }

22 ],

23 "template": {

24 "templateName": "receipt",

25 "language": "en_GB"

26 }

27 }

28 ]

29}

出力

unified-api-template-with-headers-combined

ボタン付きテンプレート [#templates-with-buttons-templates]

テンプレートにはボタンを含めることもできます。次の例は、メッセージAPI を使用してボタン付きのテンプレートをレンダリングする方法を示しています。

次の種類のボタンをレンダリングできます：

URL - クリックすると、指定したURLにユーザーをリダイレクトします。
Quick reply (クイック返信) - ユーザーが選択できる事前定義されたクイック返信オプションを提供します。
Flow (フロー) - 事前定義されたインタラクティブなフローにユーザーを誘導します。
Copy code (コードのコピー) - ユーザーは、クーポンなどの特定のコードをメッセージから直接コピーできます。
Catalog (カタログ) - 商品カタログを表示し、ユーザーがインターフェイス内で商品を閲覧できるようにします。
Multi-product (複数商品) - 1つのテンプレートで複数の商品を紹介し、複数の商品アイテムの概要を同時に表示します。

ボタン付きのテンプレートの例

json

2 "messages": [

3 {

4 "channel": "WHATSAPP",

5 "content": {

6 "body": {

7 "1": "Jane",

8 "2": "Doe",

9 "type": "TEXT"

10 },

11 "buttons": [

12 {

13 "suffix": "search?q=123456",

14 "type": "OPEN_URL"

15 }

16 ]

17 },

18 "sender": "441234567890",

19 "destinations": [

20 {

21 "to": "440987654321"

22 }

23 ],

24 "template": {

25 "templateName": "appointment_update",

26 "language": "en_GB"

27 }

28 }

29 ]

30}

出力

unified-api-template-with-buttons-combined

RCSテンプレート (インドのみ) [#rcs-templates-india-only-templates]

インドの顧客と通信する場合、RCS メッセージテンプレートの利用が不可欠です。この要件は、スパム対策規制の悪用を防ぐことを目的としていますが、顧客との通信に RCS を活用することは可能です。インドでテンプレートを使用して RCS メッセージを送信する方法については、詳細をご覧ください。

Viberビジネスメッセージテンプレート [#viber-bm-templates-templates]

NOTE

メッセージAPIを使用してViber BMテンプレートを送信する前に、ViberトランザクションテンプレートAPIを使用してテンプレートを作成し、承認する必要があります。手順は、テンプレートの作成と送信を参照してください。

テンプレート作成時に返される templateId UUID を template.templateName の値として使用します。フィールド名は誤解を招きます:人間が読める名前ではなく、UUIDを取ります。

content.body オブジェクトにパラメーター値を "type": "TEXT" で渡します。中括弧なしでプレースホルダー名をキーとして使用します: {{1}} は "1" になり、{{2}} は "2" になります。OTP（ワンタイムパスワード）テンプレートの場合は、キーとして「pin」を使用します。

例

json

2 "messages": [

3 {

4 "channel": "VIBER_BM",

5 "sender": "InfobipDemo",

6 "destinations": [

7 {

8 "to": "385981234568"

9 }

10 ],

11 "template": {

12 "templateName": "a1b2c3d4-0000-0000-0000-000000000000",

13 "language": "en"

14 },

15 "content": {

16 "body": {

17 "1": "John",

18 "2": "ORD-12345",

19 "type": "TEXT"

20 }

21 }

22 }

23 ]

24}

ステッカー

ステッカー画像は、会話にパーソナリティやエンゲージメントを加えたい時に送信します。ステッカーは通常、ユーザーのインタラクションを強化したり、感情を伝えたり、楽しく視覚的な形式でブランディングを強調したりできる静止画像またはアニメーション画像です。

ステッカーは、以下のチャネルでネイティブにサポートされています：

Viber Bots
Whatsapp

Location (位置情報)

位置情報メッセージを使用すると、緯度と経度の座標をシームレスに共有し、ユーザーとのモードのコンテキストに応じたリアルタイムコミュニケーションを提供できます。これにより、他のメッセージングコンテンツと共に位置データを送信する機能が強化されます。

位置情報メッセージの種類に分類されるメッセージは、以下のチャネルでネイティブにサポートされています。

Viber Bots
Whatsapp

備考

WhatsAppの位置情報メッセージは、受信者が過去24時間以内にビジネスに連絡した場合にのみ正常に配信されます。それ以外の場合は、テンプレートメッセージを使用することをお勧めします。

位置情報リクエストボタン

Request location (位置情報リクエスト) ボタンは、メッセージインターフェイスから位置情報を直接共有するようユーザーに依頼したい時に使用します。この機能は、配送の調整や位置情報ベースのサポートでユーザーを支援する場合など、位置情報を必要とするケースに最適です。ユーザーがこのボタンを選択すると、住所や座標を手動で入力しなくても現在地を共有できます。

Request location (位置情報リクエスト) ボタンは、以下のチャネルでネイティブにサポートされています：