WhatsApp API getFlowJson - nxtele/http-api-document GitHub Wiki
查询流JSON
根据flow_id查询流JSON
- URL:
/v1/wa/m/flows/getFlowJson
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权机制
鉴权规则请参考地址:API接口调用约定
请求参数
header参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
accessKey |
String |
是 |
fmexxx3ki |
用户身份标识 |
ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType |
String |
是 |
2 |
WhatsApp业务类型,取固定值“2” |
action |
String |
是 |
getFlowJson |
WhatsApp业务操作,取固定值“getFlowJson” |
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 |
jsonInfo object |
模板信息数组 |
paging |
object |
分页信息 |
参数名 |
类型 |
说明 |
name |
string |
流资产名称 |
asset_type |
string |
资产类型 |
download_url |
string |
流JSON下载地址 |
参数名 |
类型 |
说明 |
cursors |
object |
游标 |
next |
string |
next 不为空可向后翻页 |
previous |
string |
previous不为空可向前翻页 |
参数名 |
类型 |
说明 |
before |
string |
游标值(上一页) |
after |
string |
游标值(下一页) |
响应示例
成功示例
{
"code": 0,
"message": "Success",
"data": {
"data": [
{
"name": "flow.json",
"asset_type": "FLOW_JSON",
"download_url": "https://mmg.whatsapp.net/m1/v/t24/An9NKSmcfjQPCx89LSKc_bQzv2wbG6uuDaGNH5_gUvqe3bTnWoqIwLRrVg4OE0aLMM3ffWrPM1zC0ucCJELs3HkfuggL_PK51mqrqkBntaIFKis7OKsJyIifL4x34G51KQ?ccb=10-5&oh=01_AdQOMOq62E1ABWL10zJGfP1uoMteHprklXje1_JKLLGjIQ&oe=65A890D5&_nc_sid=471a72"
}
],
"paging": {
"cursors": {
"before": "QVFIUkd5aWk3X3pHRW50OTRaVHgwYnBwSWRJTTlad2JjZAUx5WW9LLVh5czBoam1hSnliREFwMzlVZA1dfenJ1NkhNVmRUdldvcjV1SUJoZAWNPZAGFHakZACZAVRR",
"after": "QVFIUkd5aWk3X3pHRW50OTRaVHgwYnBwSWRJTTlad2JjZAUx5WW9LLVh5czBoam1hSnliREFwMzlVZA1dfenJ1NkhNVmRUdldvcjV1SUJoZAWNPZAGFHakZACZAVRR"
}
}
}
}
失败示例
{
"code": 400,
"message": "queryFlowJsonByFlowId error",
"data": {
"error": {
"message": "Unsupported get request. Object with ID '10711883106877391' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api",
"type": "GraphMethodException",
"code": 100.0,
"error_subcode": 33.0,
"fbtrace_id": "Av089MdVWiSc6YLPwIwMu5W"
}
}
}
响应码说明
code |
message |
解决办法 |
0 |
请求成功 |
|
400 |
请求失败 |
请联系技术人员排除问题 |