-
Notifications
You must be signed in to change notification settings - Fork 6
Callbot API mgrTaskStatus
henryou edited this page Sep 26, 2024
·
3 revisions
v1.0.0
Base URLs:
鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization
POST /callcentre/api/v3/mgrTaskStatus
修改任务状态 如开启、暂停或完结任务
{
"productID": "callbot",
"userTaskID": "string",
"taskOperate": 1,
"delCall": 0
}
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
requestID | string | 是 | 请求唯一id |
uuid | string | 是 | uuid,由被调用方给出 |
createTs | string | 是 | 请求时间戳,(秒级) |
sign | string | 是 | 签名 |
algorithm | string | 否 | 签名的算法:MD5或者SHA256,不填默认用MD5 |
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
productID | string | 是 | 产品id,定值"callbot" |
userTaskID | string | 是 | 任务id,请求方的任务id(调用方生成并且保证唯一),建议使用uuid |
taskOperate | integer | 是 | 任务操作参数 |
delCall | integer | 否 | 是否删除未拨打的数据,0:none,1:删除(谨慎使用) |
属性 | 值 | 说明 |
---|---|---|
» taskOperate | 1 | 启动 |
» taskOperate | 2 | 暂停 |
» taskOperate | 3 | 完结 |
200 Response
{
"retCode": 0,
"retMsg": "string",
"responseID": "string",
"taskID": "string",
"taskStatus": 1
}
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
requestID | string | 是 | 与请求头一致 |
uuid | string | 是 | 与请求头一致 |
createTs | string | 是 | 响应时的秒级时间戳 |
sign | string | 是 | 生成方法与请求头sign生成算法一样 |
algorithm | string | 否 | 与请求头一致,签名的算法:MD5或者SHA256,不填默认用MD5 |
状态码 200
名称 | 类型 | 必选 | 约束 | 说明 |
---|---|---|---|---|
retCode | integer | true | none | 响应码,0为成功,其余为失败 |
retMsg | string | true | none | 响应消息 |
responseID | string | true | none | 响应id,随机唯一id,用于请求追踪,定位问题时需要提供该次请求的responseID |
taskID | string | true | none | 任务id |
taskStatus | integer | true | none | 任务状态 |
属性 | 值 | 说明 |
---|---|---|
taskStatus | 1 | 任务待启动 |
taskStatus | 2 | 任务进行中 |
taskStatus | 3 | 任务已完成 |
taskStatus | 4 | 任务已完结(失败) |
taskStatus | 5 | 任务已暂停 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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)