WhatsApp API queryFlowsByPhone

根据whatsapp号码查询流列表

根据流ID查询流信息

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

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是		牛信云WhatsApp应用的appkey
phone	String	是	86158xxx1795	商户的WhatsApp号码列表，需要带国码,如185xxx99
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
after	String	否		向后分页游标值
before	String	否		向前分页游标值
limit	integer	否		每页模板数量 (为空 limit则默认值为20)

请求示例

body（application/json） 参数：

{
    "phone": "185xxx99",
    "appkey": "jh42xxxd434",
    "messaging_product": "whatsapp"
}

响应参数

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

• data JsonObject参数：

参数名	类型	说明
data	array[flowInfo object]	模板信息数组
paging	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]	流程中的错误列表，在发布流程之前必须修复所有错误

• previewInfo object参数:

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

• applicationInfo object参数:

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

• paging object参数:

参数名	类型	说明
cursors	object	游标
next	string	next 不为空可向后翻页
previous	string	previous不为空可向前翻页

• cursors object参数:

参数名	类型	说明
before	string	游标值(上一页)
after	string	游标值(下一页)

响应示例

成功示例

{
  "code": 0,
  "message": "Success",
  "data": {
    "data": [
      {
        "name": "Message templates_test_flow_demo_MARKETING_692f7",
        "status": "PUBLISHED",
        "categories": [
          "OTHER"
        ],
        "validation_errors": [],
        "id": "776102294276134"
      },
      {
        "name": "Message templates_test_flow_start_MARKETING_b26dd",
        "status": "PUBLISHED",
        "categories": [
          "SURVEY"
        ],
        "validation_errors": [],
        "id": "7524375840909375"
      }
    ],
    "paging": {
      "cursors": {
        "before": "QVFIUjRUamJQT3hSb1Q2WFhLTXdVbGJrd0ZAwalpqekFHR011aUJUcXVPM0pWcVduNGl0TEtEdk9ES1BsdzhMRVB5MXg2MGRPek9RYW5CN1ZAFWWhNU1JSWWtn",
        "after": "QVFIUjBHeGFzVHJCeW9MZA3l6NTUycjZAaRlFMelpNbHVyME1BNm9abEJjWkpfTVRwdlgtc0otQjZAPUWpWWW1GcWxrbGZA6NzJjTzVUc0lHaks2VDZAuRXRIcTJB"
      },
      "next": "https://graph.facebook.com/v18.0/109038475250925/flows?limit=25&after=QVFIUjBHeGFzVHJCeW9MZA3l6NTUycjZAaRlFMelpNbHVyME1BNm9abEJjWkpfTVRwdlgtc0otQjZAPUWpWWW1GcWxrbGZA6NzJjTzVUc0lHaks2VDZAuRXRIcTJB"
    }
  }
}

失败示例

{
  "code": 400,
  "message": "185060083991请先配置WhatsApp账号",
  "data": {}
}

响应码说明

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