消息

/v1/messages

使用 messages 节点向您的客户发送文本、媒体、联系人、位置、互动消息及消息模板。

如需了解您可以发送的特定消息类型的信息，请参阅以下指南：文本消息、媒体消息、联系人和位置消息、互动消息、消息模板、媒体消息模板和互动消息模板。

准备工作

您需要：

• 验证自己的身份并接收支持您访问此项服务的身份验证口令。如需有关操作方法的更多信息，请参阅登录和身份验证文档。
• 验证您希望会接收自己消息的 WhatsApp 帐户，并获取其 WhatsApp 用户编号。如需有关操作方法的更多信息，请参阅联系人文档。
• 符合消息阻断控制服务要求。

限制

• 支持以下类型的消息：文本、消息模板、图片、文件和音频。
• 文本消息的最大长度为 4,096 个字符。

创建

无论使用何种消息类型，系统均通过向 /messages 节点发出 POST 调用来发送消息。JSON 消息正文内容因消息类型（文本、图片等）而异。

参数

以下是 /messages POST 请求中使用的主要参数：

文本对象

媒体对象

在本地 API 中，媒体对象编号是使用 media 端点将媒体成功上传至 WhatsApp Business API（详情请参见“本地 API”>“参考文档”）客户端时所返回的编号。

联系人对象

在 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。以下是按钮参数：

sub_type 为 quick_reply 的 button 类型示例：

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

sub_type 为 copy_code 的 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 状态代码（“本地 API”>“参考文档”）。

如果请求因要接受质量评估而被暂停发送，响应中将包含 message_status 属性和一条消息，表明该请求未立即发送，并且将在质量验证后发送或弃用。仅在消息被暂停发送时，此属性才会出现。

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

在文本消息中设置格式

WhatsApp 支持在消息中设置一些格式。要对消息的全部或部分内容设置格式，请使用下列格式符号：

表现

在此上下文中，“表现”代表在指定秒数内使用 WhatsApp Business API（详情请参见“本地 API”>“参考文档”）客户端可以发送的消息数量。可实现的最佳表现程度取决于不同因素，最重要的因素是您的客户端设置选项以及消息是发送给新用户还是现有用户——在向新用户发送消息时，加密会话设置需要的时间较长一些。

常见问题

详细了解

• 登录和身份验证文档
• 联系人文档
• WhatsApp Business API（详情请参见“本地 API”>“参考文档”）客户端错误代码
• HTTP 状态代码