WhatsApp API createFlow

创建流

创建新流，新流以DRAFT状态存在，此时您可以通过上传更新的JSON文件来更改流。

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

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是		牛信云WhatsApp应用的appkey
phone	String	是	86158xxx1795	商户的WhatsApp号码列表，需要带国码,如185xxx99
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
name	String	是	这是流的名称	流名称
categories	Array[String]	是	["SIGN_UP"]	流类别列表。可以有多个值，但至少需要一个。值列表：SIGN_UP,SIGN_IN,APPOINTMENT_BOOKING,LEAD_GENERATION,CONTACT_US,CUSTOMER_SUPPORT,SURVEY,OTHER
clone_flow_id	String	否	1071188310687739	要克隆的源流的 ID
endpoint_uri	String	否	https://www.xxx.com/endpoint	WA流端点的URL,由用户自定义

请求示例

• 普通文本模板 body（application/json） 参数：

{
    "appkey": "8eoxxxos",
    "messaging_product": "whatsapp",
    "phone": "86185xxx99",
    "name": "这是流的名称",
    "categories": ["SIGN_UP"]
}

响应参数

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

响应示例

成功示例

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

失败示例

{
  "code": 400,
  "message": "CreateFlow error",
  "data": {
    "error": {
      "message": "(#100) The parameter categories is required.",
      "type": "OAuthException",
      "code": 100.0,
      "fbtrace_id": "AvGNk1HJnGvsdnG7WpZsICE"
    }
  }
}

响应码说明

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