SAAS saas_plat openapi stat

获取模板消息列表

通过API获取模板消息列表

• URL：https://api.nxcloud.com/saas/wa/template/{phone}?page_number={page_number}&page_size={page_size}&name={name}&tenant_id={tenant_id}
• Method：GET
• Content-Type：application/json
• 需要鉴权：是

请求参数

header参数：

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

parameter 参数：

参数名	类型	必选	示例值	说明
phone	String	是	86158xxxx1795	消息发送方的WhatsApp号码，需要带国码。如86158xxxx1795
tenant_id	Long	是	1	租户ID
page_number	integer	是	1	页数
page_size	integer	是	10	每页个数
name	String	否	模板名称	模板名称

返回参数说明

参数名	类型	说明
data	array[data JsonObject]	请求结果
message	string	请求结果说明
code	integer	结果编码

data

参数名	类型	说明
id	Long	模板id
channel	integer	渠道类型 2：WhatsApp
name	String	模板名称
content	String	模板内容
created_at	String	模板创建时间
updated_at	String	模板修改时间
status	integer	模板状态
language	String	模板语言缩写
language_name	String	模板语言名称
unsubscribe	String	模板是否退订
quality	String	模板质量
category	String	模板类型名称 MARKETING、UTILITY
category_type	String	模板类型 1：MARKETING，2：UTILITY
waRejectedReason	String	模板被拒原因
is_close_auto_flow	integer	是否关闭未分配会话 0：不关闭 1:关闭

响应示例

{
    "code": 0,
    "message": "",
    "data": {
        "list": [
            {
                "id": 314,
                "channel": 2,
                "name": "buttontest22",
                "content": "Hello, I am the new virtual assistant. I can help you discover products or provide support. Please reach out if I can help!",
                "created_at": "2024-06-25 14:31:26",
                "updated_at": "2024-06-25 15:27:39",
                "status": 2,
                "language": "en_GB",
                "language_name": "English (UK)",
                "unsubscribe": "",
                "additional": null,
                "quality": "UNKNOWN",
                "category": "MARKETING",
                "category_type": 1,
                "waRejectedReason": "",
                "is_close_auto_flow": 0
            }   
        ],
        "total": 1,
        "has_next_page": false
    },
    "traceId": "16f9ca88e70844a8a088f9a4a3806e5e"
}

响应码说明

code	message	解决办法
0	请求成功
-1	请求失败	请联系技术人员排除问题
1000~100X	鉴权问题	详情查看API鉴权部分
21058	参数异常	tenant_id 必填
21060	参数异常	business_phone 必填
22041	业务异常	云平台发送失败
22042	业务异常	发送WhatsApp信息失败
22049	业务异常	business_phone={0}的商户不存在
22070	业务异常	按钮个数最多只能创建3个
22089	业务异常	号码不可用(No Core App)
22090	业务异常	非法的号码
22092	业务异常	不存在语言包: {0}
22216	业务异常	按钮名称不能为空