WhatsApp Cdr query

查询cdr记录

通过API查询WhatsApp消息发送记录

• URL：https://api2.nxcloud.com/api/wa/query
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
cus_message_id	String	是	wamid.HBgLODUyNTUzMTE3MDUVAgARGBI	请求mt接口成功后返回的id

响应参数

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

发送成功

• data object参数：

参数名	类型	说明
app_id	String	通信通道类型
business_phone	String	商户手机号
cus_message_id	String	消息id
meta_message_id	String	meta消息id
wabaId	String	wabaId
recipient_id	String	用户手机号
status	String	回执状态. sent,delivered,read,failed,deleted
send_time	String	发送时间
template_name	String	模板名称
costs	Object[Array]	费用信息

• costs object参数：

参数名	类型	说明
cdr_type	Integer	cdr类型， 1（消息），4（营销会话），5（通知会话），6（验证会话），7（服务会话），8（免费会话），9（国际验证），10（MM Lite）
currency	String	币种
direction	Integer	1=DOWN 下行 2=UP 上行
price	Double	金额

响应示例

成功示例 产生费用

{
    "code": 0,
    "message": "Success",
    "data": {
        "app_id": "19",
        "business_phone": "xxx",
        "cus_message_id": "wamid.e275a873e47c4e5e999663889653ceb5",
        "meta_message_id": "wamid.HBgNODYxMzYwMzAxOTc1ORUCABEYEjVCNTYyNjJCQjVDODFFOTI5MgA=",
        "wabaId": "xxx",
        "costs": [
            {
                "cdr_type": 10,
                "currency": "CNY",
                "direction": 1,
                "price": 0.02
            }
        ],
        "recipient_id": "xxx",
        "status": "delivered",
         "template_name": "template_ok",
        "send_time": "2025-09-05 07:46:27"
    },
    "traceId": "57f2486a20d8468691d4857e5f3c91ed"
}

成功示例 未产生费用

{
    "code": 0,
    "message": "Success",
    "data": {
        "app_id": "19",
        "business_phone": "xxx",
        "cus_message_id": "wamid.07964ffe1e1e4c9a853480b38148e817",
        "meta_message_id": "",
        "wabaId": "xxx",
        "template_name": "",
        "costs": [],
        "recipient_id": "xxx",
        "status": "failed",
        "send_time": "2025-09-08 07:46:13"
    },
    "traceId": "fb7cc11ec0944fbd88c6f83083a206c8"
}

失败示例 appkey不存在

{
    "code": 9003,
    "message": "Customer APP does not exist / Status is unavailable",
    "traceId": "1f1903c490524ecd8740c2d998735450"
}

失败示例 记录不存在

{
    "code": 10006,
    "message": "WhatsApp Record does not exist",
    "traceId": "e422dbc41aa2447d83cc99beb6a4403c"
}

响应码说明

code	message	解决办法
0	Success
-1	Failure	请联系技术人员排除问题
1000~100X	Authentication failed	详情查看API鉴权部分
1100	Customer does not exist / Status is unavailable	账号状态异常，联系业务人员处理账号问题
1102	Insufficient balance	账号余额不足，请联系业务人员充值
9000	Request parameter error	参数缺失，请检查必须的参数
9001	System business error	系统业务错误，请联系技术人员排除问题
9003	Customer APP does not exist / Status is unavailable	应用状态异常（不存在/禁用），联系业务人员处理云平台应用创建/禁用问题
10006	WhatsApp Record does not exist	WhatsApp 模板不存在或者质量低