WhatsApp API queryFlowsByPhone

通过whatsapp号码查询所有的流

通过whatsapp号码查询所有的流。

• URL：https://api2.nxcloud.com/api/wa/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
business_phone	String	是	86158xxx1795	商户的WhatsApp号码列表，需要带国码,如185xxx99
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
after	String	否		向后分页游标值
before	String	否		向前分页游标值
limit	integer	否		每页模板数量 (为空 limit则默认值为20)

请求示例

body（application/json） 参数：

{
    "appkey": "8eoxxxos",
    "messaging_product": "whatsapp",
    "business_phone": "86185xxx99"
}

响应参数

参数名	类型	说明
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] | 流程中的错误列表，在发布流程之前必须修复所有错误 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| String | 用于可视化流及其到期时间的 Web 预览页面的 URL whatsapp_business_account| String | 拥有 Flow 的 WhatsApp Business 帐户 application| String | Facebook 开发者应用程序最初用于创建 Flow

• paging object参数:

参数名	类型	说明
score	string	模板质量枚举 枚举值: GREEN: 高 YELLOW: 中 RED: 低 UNKNOWN: 质量待定

• component object参数:

参数名	类型	说明
type	string	组件类型,取值包括：HEADER, BODY, FOOTER, BUTTONS
format	string	仅type= HEADER时有此项，描述HEADER里内容的类型，类型包括TEXT，DOCUMENT，IMAGE， VIDEO
text	string	type= HEADER且format=text时，为HEADER文本内容； type=BODY时，为BODY的文本内容； type=FOOTER时，为FOOTER的文本内容。
example	object	变量示例，当HEADER或者BODY内容中配置了变量及示例值时，有此项
buttons	array[button object]	仅type=BUTTONS时有此项，描述模板按钮的配置信息

响应示例

成功示例

{
    "code": 0,
    "data": {
        "id": "1071188310687739 "
    },
    "message": "请求成功"
}

失败示例

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

响应码说明

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