WhatsApp API deleteTemplate - nxtele/http-api-document GitHub Wiki

删除消息模板

通过API删除WhatsApp的号码下指定名称的模板信息

  • URL:https://api2.nxcloud.com/api/wa/deleteTemplate
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:

鉴权机制

鉴权规则请参考地址:API接口调用约定

请求参数

header参数:

参数名 类型 必选 示例值 说明
accessKey String fmexxx3ki 用户身份标识
ts String 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒
bizType String 2 WhatsApp业务类型,取固定值“2”
action String deleteTemplate WhatsApp业务操作,取固定值“deleteTemplate”
sign String 6e95xxx826 API入参参数签名,签名算法

body参数:

参数名 类型 必选 示例值 说明
appkey String 牛信云WhatsApp应用的appkey
business_phone String 86158xxx1795 商户的WhatsApp号码列表,需要带国码,如185xxx99
messaging_product String whatsapp 发送消息的通道,应用于WhatsApp消息的发送时,值必须为“whatsapp”
name String test_name 模板名称(同名多语言模板一并删除)
id String 34358xxxxxx5268 模板id(携带了id则只删除单个模板)

请求示例

body(application/json) 参数:

{
    "business_phone": "185xxx99",
    "appkey": "jh42xxxd434",
    "messaging_product": "whatsapp",
    "name": "template"
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
message String 请求结果说明
  • data JsonObject 参数:
参数名 类型 说明
success boolean 操作成功状态,true为成功删除,false为删除失败。

响应示例

成功示例

{
    "code": 0,
    "data": {
        "success": true
    },
    "message": "请求成功"
}

失败示例

{
    "code": -1,
    "message": "请求失败",
    "data": null
}

响应码说明

code message 解决办法
0 请求成功
-1 请求失败 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看API鉴权部分
9000 参数异常 参数遗漏,请检查必须的参数
9001 系统业务错误 请联系技术人员排除问题
9002 商户手机号错误 请确认商户号码是否属于whatsapp号码
9006 该whatsapp号码未绑定应用 请联系业务人员处理应用和手机号绑定操作