wa calling disable - nxtele/http-api-document GitHub Wiki

禁用商户号码的calling能力

使用此接口启用禁用号码的calling能力。

接口

URL：https://api2.nxcloud.com/api/wa/calling/disable
Method：POST
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入参参数签名，签名算法

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
business_phone	String	是	86133xxx	商户的WhatsApp号码，需要带国码。如86158xxxx1795

请求示例1

{
    "appkey": "xxx",
    "business_phone": "xxx"
}

响应参数

参数名	类型	示例值
code	String	0
message	String	Success
data	Object

data Object

参数名	类型	示例值	说明
disabled	Boolean	true	true禁用成功/ false禁用失败
business_phone	String	xxx	商户号

响应示例1 禁用配置成功

{
    "code": 0,
    "message": "Success",
    "data": {
        "disabled": true,
        "business_phone": "xxx"
    },
    "traceId": "97176a1d20494c9380c218b202d56282"
}

响应示例2 号码未绑定应用

{
    "code": 10003,
    "message": "WhatsApp business phone is not bind app",
    "traceId": "dfc3f3a9be3d4b089aadf5e8374c0a9b"
}

响应码说明

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	系统业务错误，请联系技术人员排除问题
9002	Phone number error	非法号码，请检查号码正确性
9003	Customer APP does not exist / Status is unavailable	应用状态异常（不存在/禁用），联系业务人员处理云平台应用创建/禁用问题
10003	WhatsApp business phone is not bind app	该whatsapp号码未绑定应用，请联系业务人员处理应用和手机号绑定操作
10009	Calling line setting not exist	calling线路配置出现异常
10010	Business phone no calling quotation	商户号未配置calling报价
10011	Get business phone sip password fail	获取商户号sip信息异常
10012	Calling setting fail {0}	Calling配置出现异常
10013	Calling setting not exist	Calling配置不存在
10015	{0} not in (0, 1)	参数不正确
10016	{0} has error	参数不合法