:メッセージテンプレートのパラメーター

パラメーター

必須

説明

longitude

はい

座標の経度。

latitude

はい

座標の緯度。

name

いいえ

座標の名前。

address

いいえ

座標によって識別される住所。このパラメーターは、name パラメーターが設定されている場合にのみ表示されます。

パラメーター

必須

説明

addresses

いいえ

連絡先の住所。

連絡先の完全な住所には、次のパラメーターが含まれます。

• street (オプション): 番地と通りの名前。値は文字列です。

• city (オプション): 市の名前。値は文字列です。

• state (オプション): 区、市、郡、または州の名前の略語。値は文字列です。

• zip (オプション): 郵便番号。値は文字列です。

• country (オプション): 国の名前。値は文字列です。

• country_code (オプション): 2 文字の国コード。値は文字列です。

• type (オプション): 住所のタイプ。有効な値: HOME および WORK。値は文字列です。

birthday

いいえ

連絡先の誕生日。値は YYYY-MM-DD 形式です。

emails

いいえ

連絡先のメールアドレス。

連絡先の完全なメールアドレス情報には、次のパラメーターが含まれます。

• email (オプション): メールアドレス。値は文字列です。

• type (オプション): メールアドレスのタイプ。有効な値: HOME および WORK。値は文字列です。

name

はい

連絡先の名前。

連絡先の完全な名前情報には、次のパラメーターが含まれます。

• formatted_name (必須): 通常、フルネームが使用されます。値は文字列です。

• first_name (オプション): 連絡先の姓名。値は文字列です。

• last_name (オプション): 連絡先の氏名。値は文字列です。

• middle_name (オプション): 連絡先のミドルネーム。値は文字列です。

• suffix (オプション): 名前の接尾辞。値は文字列です。

• prefix (オプション): 名前の接頭辞。値は文字列です。

org

いいえ

連絡先の組織情報。

完全な組織情報には、次のパラメーターが含まれます。

• company (オプション): 連絡先が所属する会社の名前。値は文字列です。

• department (オプション): 連絡先が所属する部署の名前。値は文字列です。

• title (オプション): 連絡先の役職。値は文字列です。

phones

いいえ

連絡先の電話番号。

連絡先の完全な電話番号情報には、次のパラメーターが含まれます。

• phone (オプション): フォーマットされた電話番号。phone の値は、wa_id の値に自動的に設定されます。

• type (オプション): 電話番号のタイプ。有効な値: CELL、MAIN、IPHONE、HOME、および WORK。値は文字列です。

• wa_id (オプション): WhatsApp ID。値は文字列です。

urls

いいえ

連絡先の個人ホームページ。

完全な URL 情報には、次のパラメーターが含まれます。

• url (オプション): URL。値は文字列です。

• type (オプション): URL のタイプ。有効な値: HOME および WORK。値は文字列です。

パラメーター

必須

説明

link

はい

送信するメディアリソースのプロトコルと URL。HTTP または HTTPS URL のみ使用されます。

• MessageType が text に設定されている場合、このパラメーターは指定されません。

• MessageType が audio、document、image、または video に設定されていて、URL が使用されていない場合、このパラメーターは必須です。

caption

いいえ

メディアリソースの説明。説明は最大 1,024 文字まで入力できます。

filename

いいえ

ファイルの名前。このパラメーターは、MessageType が document に設定されている場合にのみ必須です。

パラメーター

必須

説明

text

はい

メッセージのテキストコンテンツ。フォーマットされた URL を含めることができます。

previewUrl

いいえ

URL をプレビューするかどうかを指定します。値は文字列です。デフォルト値: false。有効な値:

• true: URL をプレビューします。

• false: URL をプレビューしません。

パラメーター

必須

説明

type

はい

送信するインタラクティブメッセージのタイプ。有効な値:

• list: リストメッセージに使用されます。

• button: 返信ボタンに使用されます。

• product: 単一商品メッセージに使用されます。

• product_list: 複数商品メッセージに使用されます。

• catalog_message: 商品カタログメッセージに使用されます。

• cta_url: コールトゥアクション (CTA) ボタン付きのメッセージに使用されます。

• flow: WhatsApp Flows メッセージに使用されます。

• address_message: 住所メッセージに使用されます。

• location_request_message: 位置情報リクエストメッセージに使用されます。

header

-

メッセージの上部に表示されるタイトル。type パラメーターが product に設定されている場合、このパラメーターは指定されません。

header オブジェクトには、次のパラメーターが含まれます。

• document: ドキュメントのメディアオブジェクト。MessageType が document に設定されている場合は必須です。値はオブジェクトです。

• image: 画像のメディアオブジェクト。MessageType が image に設定されている場合は必須です。値はオブジェクトです。

• video: ビデオのメディアオブジェクト。MessageType が video に設定されている場合は必須です。値はオブジェクトです。

• text: このパラメーターは、MessageType が text に設定されている場合に必須です。ヘッダーのテキストでは絵文字を使用できます。Markdown 構文はサポートされていません。値は最大 60 文字まで入力できます。値は文字列です。

• type (必須): 値は文字列です。次のタイプがサポートされています。

  • text: リストメッセージ、返信ボタン、および複数商品メッセージに使用されます。

  • video: 返信ボタンに使用されます。

  • image: 返信ボタンに使用されます。

  • document: 返信ボタンに使用されます。

body

-

メッセージ本文を指定するオブジェクト。

body オブジェクトには、text パラメーターが含まれます。このパラメーターは、表示する必要がある場合に必須です。text パラメーターの値は文字列です。値は最大 1,024 文字まで入力でき、絵文字と Markdown 構文がサポートされています。

footer

いいえ

メッセージフッターを指定するオブジェクト。

footer オブジェクトには、text パラメーターが含まれます。このパラメーターは、表示する必要がある場合に必須です。text パラメーターの値は文字列です。値は最大 60 文字まで入力でき、絵文字と Markdown 構文がサポートされています。

action

はい

action オブジェクト。ユーザーがメッセージを読んだ後に行ってほしいアクションが含まれています。

適切なメッセージタイプ

パラメーター

説明

リストメッセージ

button

ボタンのコンテンツ。type パラメーターが list に設定されている場合は必須です。

値を空の文字列にすることはできず、メッセージ内で一意である必要があります。最大 20 文字まで入力できます。絵文字がサポートされています。Markdown 構文はサポートされていません。

返信ボタンメッセージ

buttons

ボタンオブジェクト。type パラメーターが button に設定されている場合は必須です。

例

{
 "type":"reply",
 "reply":{
       "id":"********231211",
       "title":"Click"
  }
}

リストメッセージまたは複数商品メッセージ

sections

このパラメーターは、type パラメーターが list または product_list に設定されている場合に必須です。

セクションオブジェクトの配列。有効な値: 1 ～ 10。

単一商品メッセージまたは複数商品メッセージ

catalog_id

このパラメーターは、type パラメーターが product または product_list に設定されている場合に必須です。

WhatsApp Business アカウントにリンクされている Facebook カタログの一意の識別子。コマースマネージャを使用して ID を検索できます。

product_retailer_id

このパラメーターは、type パラメーターが product または product_list に設定されている場合に必須です。

カタログ内の商品の一意の識別子。単一商品メッセージまたは複数商品メッセージの場合、値は最大 100 文字まで入力できます。

CTA ボタン付きのメッセージ

name

値は文字列です。このパラメーターは必須です。

name を cta_url に設定します。

parameters

object

display_text

値は文字列です。このパラメーターは必須です。

このパラメーターは、ボタンのテキストを示します。

url

値は文字列です。このパラメーターは必須です。

このパラメーターは、WhatsApp ユーザーがデバイス上のボタンをタップした後に、デバイスのデフォルトブラウザーでリダイレクトされる URL を示します。

WhatsApp Flows メッセージ

name

値は文字列です。このパラメーターは必須です。

パラメーターを flow に設定します。

parameters

Object

mode

値は文字列です。このパラメーターはオプションです。

このパラメーターは、フローのモードを示します。

有効な値: draft および published。

デフォルト値: published。

flow_message_version

値は文字列です。このパラメーターは必須です。

パラメーターを 3 に設定します。

flow_token

値は文字列です。このパラメーターは必須です。

このパラメーターは、識別子として機能するために企業が生成するトークンを示します。

flow_id

値は文字列です。このパラメーターは必須です。

このパラメーターは、WhatsApp が提供するフローの一意の識別子を示します。

flow_cta

値は文字列です。このパラメーターは必須です。

このパラメーターは、CTA ボタンのテキストを示します。例: Signup。

値は最大 20 文字まで入力できます。値に絵文字を含めることはできません。

flow_action

値は文字列です。このパラメーターはオプションです。

有効な値: navigate および data_exchange。

デフォルト値: navigate。

flow_action_payload

値は文字列です。このパラメーターはオプションです。flow_action が navigate に設定されている場合、このパラメーターは必須です。

オブジェクトには、次のパラメーターを含めることができます。

• screen: 値は文字列です。このパラメーターは必須です。このパラメーターは、フローの最初の画面の ID を示します。

• data: 値はオブジェクトです。このパラメーターはオプションです。このパラメーターは、フローの最初の画面の入力データを示します。値は空でないオブジェクトです。このパラメーターはオプションです。

住所メッセージ

name

値は文字列です。このパラメーターは必須です。

パラメーターを address_message に設定します。

parameters

object

country

値は文字列です。このパラメーターは必須です。

このパラメーターは、国または地域コードを示します。例: SG および IN。

values

値はオブジェクトの配列です。このパラメーターは必須です。

次のパラメーターが含まれます。

• name: ユーザーの名前。

• phone_number: ユーザーの電話番号。

validation_errors

値は文字列です。このパラメーターはオプションです。

住所フィールドでエラーをスローすると、WhatsApp は問題が解決されるまでユーザーが住所を送信できないようにします。

saved_addresses

ユーザーに関連付けられている保存済み住所。

次のパラメーターが含まれます。

• id: 保存済み住所の ID。値は文字列です。このパラメーターは必須です。

• value: オブジェクトの配列。このパラメーターは必須です。

  • name: ユーザーの名前。値はテキストです。このパラメーターは、インドとシンガポールの顧客が利用できます。

  • phone_number: 有効な電話番号。このパラメーターは、インドとシンガポールの顧客が利用できます。

  • in_pin_code: 個人識別番号 (PIN) コード。値はテキストです。PIN コードは最大 6 文字まで入力でき、インドの顧客のみが利用できます。

  • sg_post_code: 郵便番号。値は数字で、最大 6 文字まで入力できます。このパラメーターは、シンガポールの顧客のみが利用できます。

  • house_number: 家屋番号。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

  • floor_number: 階数。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

  • tower_number: タワー番号。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

  • building_name: 建物またはアパートの名前。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

  • address: 住所。値はテキストです。このパラメーターは、インドとシンガポールの顧客が利用できます。

  • landmark_area: ランドマークまたはエリア。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

  • unit_number: ユニット番号。値はテキストです。このパラメーターは、シンガポールの顧客のみが利用できます。

  • city: 市。値はテキストです。このパラメーターは、インドとシンガポールの顧客が利用できます。

  • state: 州、県、自治区、または市町村。値はテキストです。このパラメーターは、インドの顧客のみが利用できます。

位置情報リクエストメッセージ

name

値は文字列です。このパラメーターは必須です。

パラメーターを send_location に設定します。

パラメーター

説明

title

セクションのタイトル。メッセージに複数のセクションがある場合、このパラメーターは必須です。値は最大 24 文字まで入力できます。

rows

このパラメーターは、リストメッセージに必須です。値には、行オブジェクトのリストが含まれています。すべてのセクションに最大 10 行あります。

各行オブジェクトには、次のパラメーターが含まれます。

• title (必須): 値は文字列です。値は最大 24 文字まで入力できます。

• ID (必須): 値は文字列です。値は最大 200 文字まで入力できます。

• description (オプション): 値は文字列です。値は最大 72 文字まで入力できます。

product_items

このパラメーターは、複数商品メッセージに必須です。値には、商品オブジェクトのリストが含まれています。各セクションには少なくとも 1 つの商品があり、すべてのセクションに最大 30 の商品があります。

各商品オブジェクトには、product_retailer_id パラメーターが含まれています。このパラメーターは、カタログ内の商品の一意の識別子を指定します。これは、複数商品メッセージに必須です。

パラメーター

必須

説明

messageId

はい

メッセージ ID。値は文字列です。例: 2022129384888829****。

emoji

はい

絵文字。値は文字列です。

パラメーター

必須

説明

type

はい

ピン留め/ピン留め解除、フィールドには以下が含まれます:

• pin: ピン留め

• unpin: ピン留め解除

expirationDays

いいえ

メッセージをピン留めする日数。このパラメーターは type=pin の場合に必須です。有効な値: 1～30。

messageId

はい

メッセージ ID。

パラメーター

必須

説明

text

はい

テキスト。

パラメーター

必須

説明

link

はい

画像の URL。

パラメーター

必須

説明

link

はい

ビデオの URL。

thumbnail

はい

サムネイルの URL。

fileSize

はい

ファイルのサイズ。単位: MB。

duration

はい

ファイルの長さ。単位: 秒。

パラメーター

必須

説明

link

はい

ファイルの URL。

fileName

はい

ファイルの名前。名前は最大 25 文字まで入力できます。

fileType

はい

ファイルタイプ。

パラメーター

必須

説明

text

はい

テキスト。

caption

はい

ボタンのテキスト。

action

はい

ボタンにリンクされている URL。

パラメーター

必須

説明

text

はい

テキスト。

link

はい

画像の URL。

caption

はい

ボタンのテキスト。

action

はい

ボタンにリンクされている URL。

パラメーター

必須

説明

text

はい

テキスト。

link

はい

ビデオの URL。

thumbnail

はい

サムネイルの URL。

fileSize

はい

ファイルのサイズ。単位: MB。

duration

はい

ビデオの長さ。単位: 秒。

パラメーター

必須

説明

text

はい

テキスト。

link

はい

ビデオの URL。

thumbnail

はい

サムネイルの URL。

fileSize

はい

ファイルのサイズ。単位: MB。

duration

はい

ビデオの長さ。単位: 秒。

caption

はい

ボタンのテキスト。

メディア

サポートされているタイプ

サイズ制限

音声

ACC、MP4、MPEG、および AMR

16 MB

ドキュメント

TXT、PDF、PPT、DOC、XLS、DOCX、PPTX、および XLSX

100 MB

画像

JPEG および PNG

5 MB

ビデオ

MP4 および 3GP

説明

• H.264 ビデオコーデックと AAC オーディオコーデックのみがサポートされています。

• 単一のオーディオストリームまたはオーディオストリームがないビデオがサポートされています。

16 MB

ステッカー

WebP

静的スタンプ: 100 KB

動的スタンプ: 500 KB

メディア

サポートされているタイプ

サイズ制限

テキスト

UTF-8

スペースと特殊文字を含む 1,000 文字

ドキュメント

DOC、DOCX、RTF、DOT、DOTX、ODT、ODF、FODT、TXT、INFO、PDF、XPS、PDAX、EPS、XLS、XLSX、ODS、FODS、CSV、XLSM、および XLTX

200 MB

ビデオ

MP4、M4V、MOV、および 3GP

画像

JPG、JPEG、PNG、GIF、および WebP

GIF: 20 MB。他のタイプの画像の推奨サイズは 50 MB 未満です。

画像の推奨解像度: 800 × 800。カバーの推奨解像度: 400 × 400。