WhatsApp API deprecateFlow - nxtele/http-api-document GitHub Wiki
废弃已发布的流
废弃已发布的流,流状态由DRAFT转换为DEPRECATED
- URL:
/v1/wa/m/flows/deprecateFlow
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权机制
鉴权规则请参考地址:API接口调用约定
请求参数
header参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
accessKey |
String |
是 |
fmexxx3ki |
用户身份标识 |
ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType |
String |
是 |
2 |
WhatsApp业务类型,取固定值“2” |
action |
String |
是 |
deprecateFlow |
WhatsApp业务操作,取固定值“deprecateFlow” |
sign |
String |
是 |
6e95xxx826 |
API入参参数签名,签名算法 |
body参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
appkey |
String |
是 |
|
牛信云WhatsApp应用的appkey |
flow_id |
String |
是 |
1071188310687739 |
查询流JSON |
messaging_product |
String |
是 |
whatsapp |
发送消息的通道,应用于WhatsApp消息的发送时,值必须为“whatsapp” |
请求示例
body(application/json) 参数:
{
"flow_id": "1071188310687739 ",
"appkey": "jh42xxxd434",
"messaging_product": "whatsapp"
}
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
结果编码 |
data |
JsonObject |
请求结果 |
message |
String |
请求结果说明 |
参数名 |
类型 |
说明 |
data |
resultInfo object |
响应消息 |
参数名 |
类型 |
说明 |
success |
boolean |
操作状态,操作成功返回true |
响应示例
成功示例
{
"code": 0,
"message": "Success",
"data": {
"success": true
}
}
失败示例
{
"code": 400,
"message": "deprecateFlow error",
"data": {
"error": {
"message": "Deprecating attempt failed",
"type": "OAuthException",
"code": 139003.0,
"error_subcode": 4016007.0,
"is_transient": false,
"error_user_title": "Can't deprecate flow",
"error_user_msg": "Flow was never published, it cannot be deprecated",
"fbtrace_id": "A0-AIrqILhNGdCAwv5H46TD"
}
},
"traceId": "7def087810954771a2ba07b331f346d7"
}
响应码说明
code |
message |
解决办法 |
0 |
请求成功 |
|
400 |
请求失败 |
请联系技术人员排除问题 |