Skip to main content

发送模板消息API

域名

  • https://chat-api.incsapp.com

请求路由

  • /external/messages/whatsapp

请求方式

  • POST

请求头

  • Content-Type: application/json
  • certification-code: af92196e-0d07-3c1d-a631-a71c...

请求参数

请求参数列表

参数名 类型 必填 描述
certification_codestring从 INCS 获取的 API 凭证,和 WABA 账号对应
to string 收信人 WhatsApp 手机号,必须是国家码+手机号的纯数字格式,如 "8526841511234"
template_name string 从 INCS 创建的模板名称
parameters array 模板中包含参数时填写
parameters.body array 模板的body中包含参数时按参数顺序填写

请求参数示例

{
  "certification_code": "f484bd42-4a0c-39d....",
  "to": "8526841...",
  "template_name": "order_notification...",
  "parameters": {
    "body": [
      "123456"
    ]
  }
}

响应

成功响应示例

{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "msg_id": "wamid.HBgLODUyNjg0MTUwMjYVAgARGBIyMUQ4RjA5MTY1NUJERjE3NjYA" // WABA Msg ID
    }
}

失败响应示例

{
    "status": "error",
    "code": 422,
    "message": "The phone number is invalid.",
    "data": {}
}