坐席API调用接口说明(V1.0) - nxtele/http-api-document GitHub Wiki
简要描述:
- 用户需使用NXPhone注册登录,然后通过NXcloud API调用,系统首先拨通坐席的NXPhone,坐席人员需要先接听, 然后系统拨打被叫电话,在被叫接通之后,双方开始通话。
获取token
简要描述:
获取调用token,每次API调用需要带上token 过期时间默认1200秒
请求URL:
https://as01.nxcloud.com/v1/call/token
请求方式:
- POST
- Content-Type: application/x-www-form-urlencoded
请求参数说明:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appkey | 是 | string | 审批单appkey,可以在审批单列表中获取 |
secretkey | 是 | string | 审批单secretkey,可以在审批单列表中获取 |
返回结果示例:
成功返回
{"code":0,"token":"05804537D2A6693DC7E6CC5E0ADA09B9","expireinterval":1200}
失败返回
{"code":1101,"info":"appkey or secretkey invalid."}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态id,0:成功;1:失败 |
token | string | 验证token |
expireinterval | int | 过期时长 |
info | string | 失败说明 |
发起呼叫
简要描述:
调用nxcloud api拨打电话
请求URL:
https://as01.nxcloud.com/v1/call/makecall
请求方式:
- POST
- Content-Type: application/x-www-form-urlencoded
请求参数说明:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | string | 获取的token |
username | 是 | string | 话机账号 |
phone | 是 | string | 被叫号码 |
showphone | 否 | string | 话机显示号码,默认:nxcloud |
orderid | 否 | string | 订单ID 每次调用需要保证唯一,4-32位,数字和字母组合 |
返回结果示例:
成功返回
{
"code": 0,
"orderid": "xxx1234",
"sessionid": "484ffc35-c59e-79c9-27a2-751cc1b52740",
"info": "success"
}
失败返回
{"code":1101,"info":"appkey or secretkey invalid."}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
code | int | 状态id,0:成功;1-10000:失败 |
info | string | 失败说明 |
info说明:
code | info | 说明 |
---|---|---|
0 | success | 成功 |
1000 | data error,please reload token | 数据错误 |
1101 | appkey or secretkey invalid. | appkey or secretkey错误 |
1201 | This token is not available | token不可用 |
1201 | This token has expired | token过期 |
1001 | Username no exist! | 话机账号不存在 |
1002 | Username lock,please contact the administrator! | 话机账号被锁定 |
1003 | User is not registered! please reload | 话机账号没登陆 |
1004 | User is not registered! please reload | 话机账号没登陆 |
1005 | User is not registered! please reload | 话机账号没登陆 |
1006 | Username no exist | 话机账号不存在 |
1007 | orderid format error | orderid格式错误(只能为数字和字母组合) |
1008 | orderid length is too long | orderid长度超长 |
1100 | Data error! | 数据错误 |
1200 | Parameter error! | 参数错误 |
10000 | unknown error | 未知错误 |