WhatsApp API queryFlowsById

根据流ID查询流信息

根据流ID查询流信息

• URL：/v1/wa/m/flows/queryFlowsById
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是		牛信云WhatsApp应用的appkey
flow_id	String	是	3603023670018850	流ID
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”

请求示例

body（application/json） 参数：

{
    "flow_id": "3603023670018850",
    "appkey": "jh42xxxd434",
    "messaging_product": "whatsapp"
}

响应参数

参数名	类型	说明
code	Integer	结果编码
data	JsonObject	请求结果
message	String	请求结果说明

• data JsonObject参数：

参数名	类型	说明
data	flowInfo object	流对象

• flowInfo object参数：

参数名	类型	说明
id	string	流的唯一ID
name	string	用户定义的流名称，用户不可见
status	string	DRAFT：这是初始状态，Flow仍在开发中，该流程只能通过"mode":"draft"发送以进行测试。PUBLISHED：该流程已被标记为由开发人员发布，因此现在可以将其发送给客户，该流程此后无法删除或更新。DEPRECATED：开发者已将流程标记为已弃用（因为发布后无法删除），这可以防止发送和打开流程，从而允许开发人员停用其端点，已弃用的流无法删除或取消弃用。BLOCKED：监控检测到端点不健康，将状态设置为“已阻止”，该状态下无法发送或打开Flow；开发人员需要修复端点以使其恢复到已发布状态。THROTTLED：监控检测到端点运行状况不佳，并将状态设置为 Throttled，处于节流状态的流可以打开，但每小时只能发送 10 条流消息，开发人员需要修复端点以使其恢复到PUBLISHED 状态。
categories	Array[String]	流类别列表
validation_errors	Array[String]	流程中的错误列表，在发布流程之前必须修复所有错误
json_version	String	开发者在上传的 Flow JSON 资产中指定的版本
data_api_version	String	开发人员在上传的 Flow JSON 资产中指定的数据API版本,仅适用于具有端点的流
data_channel_uri	String	[API v19.0 中已弃用] 请改用 endpoint_uri 字段,开发人员通过 API 或在 Builder UI 中指定的 WA Flow Endpoint 的 URL
endpoint_uri	String	开发人员通过API或在Builder UI中指定的WA Flow Endpoint的URL
preview	previewInfo object	用于可视化流及其到期时间的Web预览页面的URL
application	applicationInfo object	Facebook开发者应用程序最初用于创建Flow

• previewInfo object参数:

参数名	类型	说明
preview_url	string	预览视图的URL
expires_at	string	URL过期时间

• applicationInfo object参数:

参数名	类型	说明
category	string	应用程序的分类
link	string	应用程序的链接URL
name	string	应用程序的名称
id	string	应用程序的唯一标识符

响应示例

成功示例

{
  "code": 0,
  "message": "Success",
  "data": {
    "id": "3603023670018851",
    "name": "flows_hqq_008",
    "categories": [
      "OTHER"
    ],
    "preview": {
      "preview_url": "https://business.facebook.com/wa/manage/flows/3603023670018850/preview/?token=44639eab-3848-4b7c-86d6-10a8f23d022d",
      "expires_at": "2024-01-13T10:03:53+0000"
    },
    "status": "PUBLISHED",
    "validation_errors": [],
    "json_version": "3.0",
    "application": {
      "category": "实用类",
      "link": "https://testnxlink.nxcloud.com/admin/#/login",
      "name": "NXLink",
      "id": "1407008009801816"
    }
  }
}

失败示例

{
  "code": 400,
  "message": "queryFlowDetailByFlowId Result error",
  "data": {
    "error": {
      "message": "Unsupported get request. Object with ID '36030236700188502' 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": "ANEoVNpSo03Xl9Ju08OStnY"
    }
  }
}

响应码说明

code	message	解决办法
0	请求成功
400	请求失败	请联系技术人员排除问题