模板消息API
简要描述
请求URL
{{host}}/external/messages/whatsapp
请求方式
请求参数
参数名 |
必选 |
类型 |
说明 |
certification_code |
是 |
string |
请求凭证 |
to |
是 |
string |
发送对象手机号,必须是带国家码的纯数字格式,如 85265418xxx |
template_name |
是 |
string |
在 INCS 创建的模板名称 |
parameters |
否 |
object |
模板参数,不带参数的模板可以不传,带模板的参数需要传对应参数,参考请求示例 |
请求示例
{
"certification_code": "f484bd42-4a0c-39d....",
"to": "8526841...",
"template_name": "order_notification...",
"parameters": {
"body": ["123456"] // 参数放在body中,按顺序排列
}
}
成功返回示例
{
"status": "success",
"code": 200,
"message": "",
"data": {
"msg_id": "wamid.HBgLODUyNjg0MTUwMjYVAgARGBIyMUQ4RjA5MTY1NUJERjE3NjYA"
}
}
失败返回示例
·
返回参数说明
参数名 |
类型 |
说明 |
msg_id |
string |
whatsapp 消息id,如需消息状态通知,请保存该 id |