鉴权
租户级别鉴权
基本信息
Path： /token
Method： GET
接口描述：
1. 鉴权参数
| name | 描述 |
|---|---|
| AppId | 租户id |
| Timestamp | 10位时间戳，需要自己生成 |
| Token | 鉴权签名，5分钟内有效，生成方式请参考第2小节 |
2. 鉴权签名参数说明
Token签名采用 HMAC-SHA1 进行加密，需要通过AppId、Timestamp、Secret来生成。生成方式如下：
| 字段名称 | 描述 | 样例 |
|---|---|---|
| 消息 | 租户id + 时间戳 | a54a8b77-f12d-4ac9-742d-5b2bef5c4d111612513422 |
| 算法 | sha1 | |
| Secret | 秘钥，对消息进行加密的秘钥，每个租户都有一个单独的秘钥，秘钥信息请联系管理员获取 | 1234569abcdef |
| Token | 根据消息、算法、秘钥生成 | 5320d95c846d4a26d4b19c762a1d063ec50f4da6 |
备注:
1) token生成可参考网址: 【https://1024tools.com/hmac】
2) 秘钥请联系相关负责人获取
3 请求样例
【http://ccps.xx.tryudesk.com/api/v1/workTimes?AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Timestamp=1612762544&oken=2e511f0b41902747ca5e3aaa1e64754695e96e38】
查询AI自动外呼任务下通话记录
基本信息
Path： /api/v1/call-calls/task
Method： POST
接口描述：
概述
查询AI外呼任务下通话记录，通话开始时间和结束时间间隔不能大于7天。
示例
请求
$ curl 'http://ip:port/api/v1/call-calls/task?AppId={appid}&Timestamp={mytime}&Token={token} -i -X POST -H 'Content-Type: application/json' -d '{
"pageNum":1,
"pageSize":20,
"adTaskId":123456,
"startDateTime":"2022-03-18 10:10:00",
"endDateTime":"2022-03-18 11:10:00",
"toNumber":"15888888888"
}'
响应
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 20,
"total": 1
},
"data": [
{
"id": 168,
"callId": "2a1",
"workflow": 4,
"fromNumber": "05388593",
"toNumber": "15201111111",
"relayNumber": "05388593",
"callStartTime": [
2021,
10,
15,
14,
26,
35
],
"callEndTime": [
2021,
10,
15,
14,
27,
23
],
"callDuration": 48,
"callRecordUrl": "https://prords.iao.com/9ff65-0e6a-767.mp3?OSSAccessKeyId=bPehfu&Expires=16658153&Signature=y7qb%2FStD4%3D",
"customerProvince": "北京",
"customerCity": "北京",
"userAnsweredFlag": 1,
"userAnsweredCount": 4,
"userAnsweredEffectiveCount": 2,
"routerId": null,
"routerName": null,
"readFlag": 0,
"transferAgentFlag": 0,
"agentId": null,
"agentName": null,
"queueId": null,
"queueName": null,
"robotNames": [
"勿动话术"
],
"labelInfos": [
"11"
],
"adTaskId": 111,
"variables": null,
"ringingTime": 16,
"ringResult": "未选择队列",
"hangupCause": null,
"hangupBy": "IVR",
"adTaskName": "AI外呼",
"callDirection": "呼出",
"intentionLabelKey": null,
"intentionLabelName": null,
"callResult": 1,
"calledResult": 1,
"taskContactBatchName": "联系人A",
"agentCallDuration": 0,
"customerNumber": "13394837483",
"remark": null
}
]
}
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| pageNum | number | 非必须 | 页码，默认为1 | ||
| pageSize | number | 非必须 | 每页数量，默认为20，最大50 | ||
| adTaskId | number | 必须 | 任务Id | ||
| startDateTime | string | 非必须 | 通话开始时间 | mock: 2021-10-10 00:00:00 | |
| endDateTime | string | 非必须 | 通话结束时间 | mock: 2021-10-17 00:00:00 | |
| toNumber | string | 非必须 | 被叫号码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| succeed | boolean | 必须 | 成功标识 | ||
| code | number | 必须 | 结果码 | ||
| bizCode | string | 必须 | 业务码 | ||
| message | string | 必须 | 消息 | ||
| visible | boolean | 必须 | 是否可见 | ||
| paging | object | 非必须 | |||
| ├─ pageNum | number | 非必须 | 页码 | ||
| ├─ pageSize | number | 非必须 | 每页数量 | ||
| ├─ total | number | 非必须 | 总数 | ||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | number | 必须 | Id | ||
| ├─ callId | string | 必须 | 通话Id | ||
| ├─ workflow | number | 必须 | 呼叫类型，4-自动外呼 | ||
| ├─ fromNumber | string | 必须 | 主叫号码 | ||
| ├─ toNumber | string | 必须 | 被叫号码 | ||
| ├─ relayNumber | string | 必须 | 中继号码 | ||
| ├─ callStartTime | string | 必须 | 通话开始时间 | ||
| ├─ callEndTime | string | 必须 | 通话结束时间 | ||
| ├─ callDuration | number | 必须 | 通话总时长（秒） | ||
| ├─ callRecordUrl | string | 必须 | 通话录音地址 | ||
| ├─ customerProvince | string | 必须 | 客户号码归属地-省 | ||
| ├─ customerCity | string | 必须 | 客户号码归属地-市 | ||
| ├─ routerId | null | 必须 | 路由Id | ||
| ├─ routerName | null | 必须 | 路由名称 | ||
| ├─ readFlag | number | 必须 | 是否已读，0-未读，1-已读 | ||
| ├─ transferAgentFlag | number | 必须 | 是否转人工坐席，0-否，1-是 | ||
| ├─ agentId | null | 必须 | 坐席Id | ||
| ├─ agentName | null | 必须 | 坐席名称 | ||
| ├─ queueId | null | 必须 | 队列Id | ||
| ├─ queueName | null | 必须 | 队列名称 | ||
| ├─ robotNames | string [] | 必须 | 话术名称数组：["话术1","话术2"] | item 类型: string | |
| ├─ | 非必须 | ||||
| ├─ labelInfos | string [] | 必须 | 普通标签数组：["水果","蔬菜"] | item 类型: string | |
| ├─ | 非必须 | ||||
| ├─ adTaskId | number | 必须 | 自动外呼任务ID | ||
| ├─ variables | string [] | 必须 | 对话变量 | item 类型: string | |
| ├─ | 非必须 | ||||
| ├─ ringingTime | number | 必须 | 振铃时间 | ||
| ├─ ringResult | string | 必须 | 呼叫结果 | ||
| ├─ hangupCause | null,string | 必须 | 客户未接挂机原因 | ||
| ├─ hangupBy | string | 必须 | 挂断方 | ||
| ├─ adTaskName | string | 必须 | 自动外呼任务名称 | ||
| ├─ callDirection | string | 必须 | 呼叫方向 | ||
| ├─ intentionLabelKey | string | 必须 | 意向标签标识 | ||
| ├─ intentionLabelName | string | 必须 | 意向标签名称 | ||
| ├─ customerNumber | string | 必须 | 客户号码 | ||
| ├─userAnsweredFlag | number | 非必须 | 有效通话(0否1是) | ||
| ├─userAnsweredCount | number | 非必须 | 用户交互次数 | ||
| ├─userAnsweredEffectiveCount | number | 非必须 | 用户有效交互次数 | ||
| ├─ remark | string | 非必须 | 备注 | ||
| ├─ allRecordUrlList | object [] | 非必须 | 录音 | item 类型: object | |
| ├─ recordUrl | string | 非必须 | 记录地址 | ||
| ├─ recordType | string | 非必须 | 类型 | ||
| ├─ contactDetailRel | object [] | 非必须 | 联系人信息 | item 类型: objcet | |
| ├─ name | string | 非必须 | 联系人名称 | ||
| ├─ mobile | string | 非必须 | 手机号 | ||
| ├─ companyName | string | 非必须 | 公司名称 | ||
| ├─ remark | string | 非必须 | 备注 | ||
| ├─ variates | objet [] | 非必须 | 变量集合 | item 类型: object | |
| ├─ key | string | 非必须 | 变量名称 | ||
| ├─ type | string | 非必须 | 变量类型 | ||
| ├─ value | string | 非必须 | 变量值 | ||
| ├─ customerAnswerAt | string | 非必须 | 客户接听时间 | ||
| ├─ isFinalCall | string | 非必须 | 暂不使用 | ||
| ├─ agentCallDuration | number | 非必须 | 人工通话时长 | ||
| ├─ calledResult | number | 非必须 | 呼叫结果，1-已接通 2-未接通 | ||
| ├─ taskContactBatchName | string | 非必须 | 联系单名称 | ||
| ├─ callResult | number | 非必须 | 振铃结果 |