-
Notifications
You must be signed in to change notification settings - Fork 6
NXCC API agentInfo
aofei edited this page Mar 22, 2024
·
2 revisions
查询坐席列表
- URL:
https://api2.nxcloud.com/saas/cc/openapi/agent/page
- Method:
POST
- Content-Type:
application/json
- Required:
yes
鉴权规则请参考地址:API 接口调用约定
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
accessKey | String | Y | fme2na3kdi3ki | 用户身份标识 |
ts | String | Y | 1655710885431 | 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为 60 秒 |
bizType | String | Y | 8 | 业务类型,取固定值“8” |
action | String | Y | cc | 业务操作,取固定值“cc” |
sign | String | Y | 6e9506557d1f289501d333ee2c365826 | API 入参参数签名,签名算法 |
参数名 | 类型 | 必选 | 示例值 | 说明 |
---|---|---|---|---|
tenantId | Integer | Y | 144 | 团队ID, 从牛信页面查询到并配置 |
userName | String | N | 用户账号(邮箱或者NX开头的账号) | |
size | Integer | Y | 200 | Page Size (最大200) |
page | Integer | Y | 1 | Page Number (从 1开始) |
body(application/json):
{
"userName": "[email protected]",
"tenantId": 144,
"size": 100,
"page": 1
}
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 结果编码 |
data | Object | 请求结果 |
msg | String | 请求结果说明 |
total | Integer | 总条数 |
- data 参数:
参数名 | 类型 | 说明 |
---|---|---|
allowCountry | list | 允许的国家 iso_2,可以有多个允许的国家 |
endPointName | string | 接入点名称 |
gmtCreate | string(date-time) | none |
gmtModified | string(date-time) | none |
queueName | list | 坐席组名称,坐席可以属于多个坐席组 |
nickName | string | 坐席昵称 |
recording | boolean | 是否录音: 0 关闭, 1 开启. |
recordingStorageDays | integer(int32) | 录音保留天数 |
sipNumber | string | SIP 分机号(唯一值,不能被修改) |
status | integer(int32) | 坐席状态:0 关闭,1 开启 |
userName | string | 坐席账号 |
{
"reqId": "a23738fb613d889026fa2c8f4e4378f1",
"code": 0,
"msg": "Success",
"data": [
{
"allowCountry": ["US, SG"],
"endPointName": "HONGKONG",
"enableStatusLog": false,
"gmtCreate": "2019-08-24 14:15:22",
"gmtModified": "2019-08-24 14:15:22",
"queueName": ["groupName"],
"nickName": "string",
"recording": false,
"recordingStorageDays": 0,
"sipNumber": "NX00001",
"status": 0,
"userName": "[email protected]"
},
{
"allowCountry": ["US, SG"],
"endPointName": "HONGKONG",
"enableStatusLog": false,
"gmtCreate": "2019-08-24 14:15:22",
"gmtModified": "2019-08-24 14:15:22",
"queueName": ["groupName1", "groupName2"],
"nickName": "string",
"recording": false,
"recordingStorageDays": 0,
"sipNumber": "NX00002",
"status": 0,
"userName": "[email protected]"
}
],
"total": 2
}
{
"reqId": "FFDD1791E22F4D9DBA967C245C58E544",
"code": 1001,
"msg": "Authorization Failed",
"data": {},
"total": 0
}
code | message | Resolution |
---|---|---|
0 | 请求成功 | |
88 | 请求失败 | 请联系技术人员排除问题 |
99 | 系统错误 | 请联系技术人员排除问题 |
1000~100X | 鉴权失败 | 详情查看 API 鉴权部分 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent(对外api)