訊息

/v1/messages

使用 messages 節點傳送文字訊息、媒體、聯絡人、地點、互動式訊息以及訊息範本給顧客。

如需瞭解可傳送的特定訊息類型，請參閱下列指南：文字訊息、媒體訊息、聯絡人和地點訊息、互動式訊息、訊息範本、媒體訊息範本，以及互動式訊息範本。

準備工作

必備資料：

• 驗證身分並接收可供存取服務的驗證權杖。如需操作方法的詳細資訊，請參閱登入與驗證文件。
• 若要驗證您想要傳送訊息的目標 WhatsApp 帳號，並取得其 WhatsApp 用戶編號，請參閱「聯絡人」文件，瞭解操作方法。
• 訊息應符合截斷控制服務要求。

限制

• 支援以下訊息類型：文字、訊息範本、圖像、文件和音訊。
• 一則簡訊的長度最多可以有 4096 個字元。

建立

無論是哪種訊息類型，您都會透過向 /messages 節點發出 POST 呼叫來傳送訊息。每個訊息類型（文字、影像等）的 JSON 訊息內文各不相同。

參數

以下是用於 /messages POST 要求的主要參數：

文字物件

媒體物件

若使用內部部署 API，當媒體成功透過 media 端點上傳至 WhatsApp Business 內部部署／參考資料用戶端時，系統會傳回媒體物件編號。

聯絡人物件

在 contacts 內部，您可以巢狀方式包含下列物件：addresses、emails、name、org、phone 和 urls。陣列中會包含複數物件，如以下範例所示。

內部以巢狀方式包含複數物件的 contacts 物件範例：

"contacts": [
    {
        "addresses": [
            {
                "city": "city name",
                "country": "country name",
                "country_code": "code",
                "state": "Contact's State",
                "street": "Contact's Street",
                "type": "Contact's Address Type",
                "zip": "Contact's Zip Code"
            }
        ],
        "birthday": "birthday",
        "emails": [
            {
                "email": "email",
                "type": "HOME"
            },
            {
                "email": "email",
                "type": "WORK"
            }
        ],
        "name": {
            "first_name": "first name value",
            "formatted_name": "formatted name value",
            "last_name": "last name value",
            "suffix": "suffix value"
        },
        "org": {
            "company": "company name",
            "department": "dep name",
            "title": "title"
        },
        "phones": [
            {
                "phone": "Phone number",
                "wa-id": "WA-ID value",
                "type": "MAIN"
            },
            {
                "phone": "Phone number",
                "type": "HOME"
            },
            {
                "phone": "Phone number",
                "type": "WORK"
            }
        ],
        "urls": [{
            "url": "some url",
            "type": "WORK"
        }]
    }
]

地點物件

範本物件

在 template 內，您可以巢狀方式包含 components 和 language 物件。

元件物件

在 components 內部，您可以巢狀方式包含 parameters 物件。此外，您可以將 type 設為 button。

參數物件

按鈕類型

在 components 物件內部，您可以將 type 設為 button。以下為按鈕參數：

使用 quick_reply sub_type 的 button 類型範例：

 {
    "type": "button",
    "sub_type": "quick_reply",
    "index": 0,
    "parameters": 
     [{
    	"type": "payload",
    	"payload": "Yes-Button-Payload"
     }]
 } 

使用 copy_code sub_type 的 button 類型範例

    
 { 
    "type": "button", 
    "sub_type": "copy_code", 
    "index": 0, 
    "parameters": 
    [{ 
     "type": "coupon_code", 
     "coupon_code": "DISCOUNT20" 
    }] 
 }

Hsm 物件

互動式物件

動作物件

範例

音訊訊息：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio",
  "audio": {
      "id": "your-media-id",
  }
}

文件訊息，使用 filename：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "id": "your-media-id",
      "filename": "your-document-filename"
  }
}

文件訊息，使用 link：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "document",
  "document": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }     
    }
}

影片訊息，使用 link：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "video",  
  "video": {
      "link": "http(s)://the-url"
      "provider": {
          "name" : "provider-name"
      }
    }
  }
}

文字訊息：

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

互動式訊息（清單）：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive":{
    "type": "list",
    "header": {
      "type": "text",
      "text": "your-header-content-here"
    },
    "body": {
      "text": "your-text-message-content-here"
    },
    "footer": {
      "text": "your-footer-content-here"
    },
    "action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }
  }

}

互動式訊息（回覆按鈕）：

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "interactive",
  "interactive": {
    "type": "button",
    "header": { # optional
      "type": "text" | "image" | "video" | "document",
      "text": "your text"
      # OR
      "document": {
        "id": "your-media-id",
        "filename": "some-file-name"
      }
      # OR
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name",
        },
        "filename": "some-file-name"
      },
      # OR
      "video": {
        "id": "your-media-id"
      }
      # OR
      "video": {
        "link": "the-provider-name/protocol://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
      # OR
      "image": {
        "id": "your-media-id"
      }
      # OR
      "image": {
        "link": "http(s)://the-url",
        "provider": {
          "name": "provider-name"
        }
      }
    }, # end header
    "body": {
      "text": "your-text-body-content"
    },
    "footer": { # optional
      "text": "your-text-footer-content"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    } # end action   
  } # end interactive

}

互動式訊息（多個和單一產品訊息）：

{ 
  "recipient_type": "individual",
  "to" : "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "product",
    "body": {
      "text": "body text"
    },
    "footer": {
      "text": "footer text"
    },
    "action": {
      "
      
      _id": "catalog-ID",
      "product_retailer_id": "product-ID"
    }
  }
}

互動式訊息（多個產品訊息）：

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "product_list",
    "Header":{
       "type": "text",
        "text": "text-header-content"
     },
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "catalog_id":"catalog-id",
        "sections": [
             {
             "title": "section-title",             
             "product_items": [
                  { "product_retailer_id": "product-SKU-in-catalog" },
                  { "product_retailer_id": "product-SKU-in-catalog" },
                            ...
              ]},
              {
              "title": "the-section-title",
              "product_items": [
                 { "product_retailer_id": "product-SKU-in-catalog" }
                           ...
              ]},
               ...
       ]
     },  
    }
}

互動式訊息（目錄訊息）：

{ 
  "recipient_type": "individual",
  "to" : "whatsapp-id",
  "type": "interactive",
  "interactive": 
    {
    "type": "catalog_message",
     "body":{
        "text": "text-body-content"
      },
     "footer":{
        "text":"text-footer-content"
     },
     "action":{
        "name": "catalog_message",
      	"parameters":{ 
      	  "thumbnail_product_retailer_id": "product-SKU-in-catalog"
      	}
     },  
    }
}

互動式訊息（流程）：

{
  "recipient_type": "individual",
  "to": "{{Recipient-WA-ID}}",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }
  }
}

以下顯示回應中 payload 的範例；為求簡潔，省略了中繼和錯誤物件。

{
  "messages": [{ 
    "id": "message-id" 
  }]    
}

若要求成功，您會收到具有訊息編號的回應。若要求傳回 errors 區段，請檢查來源訊息並更正錯誤之後，再重新傳送要求。如需錯誤的詳細資訊，請參閱 WhatsApp Business API 內部部署／參考資料用戶端錯誤代碼和 HTTP 狀態代碼。

如果系統保留要求以進行品質評估，則回應將包含 message_status 屬性並附加一則訊息，指示系統未立即傳送訊息，將在驗證品質後傳送或將其刪除。只有當系統保留訊息時，此屬性才會存在。

    {
      "messages": [{ 
        "id": "message-id",
        "message_status": "Message has been held because quality assessment is pending",
      }]    
    }
    

在文字訊息中加入格式

WhatsApp 允許在訊息中加入一些格式若要對訊息進行全部或部分格式化，請使用以下格式符號：

成效

在本文中，成效代表使用 WhatsApp Business 內部部署／參考資料用戶端在任何指定秒數內可以傳送的訊息數量。可達成的最大成效取決於多種因素，最重要的因素是用戶端設定選擇，以及訊息是傳送給新用戶還是現有用戶。若是傳送訊息給新用戶，加密工作階段設定需要較長的時間。

常見問題

瞭解詳情

• 登入與驗證說明文件
• 聯絡人文件
• WhatsApp Business 內部部署／參考資料用戶端錯誤代碼
• HTTP 狀態代碼