1.1 交互模式接口
交互模式说明
1.1.1 语音交互接口
接口提供方：客户平台
接口资源名称
/free/v2.0/voice_inactive
完整 URL 示例：http[s] ://<ip address> :<port>/privacy/free/v2.0/voice_inactive
| 字段名称 | 类型 | 约束 | 说明 |
| callId | string (64) | 必须 | call-id |
| caller | string (20) | 必须 | 呼入的主叫号码(真实主叫) |
| callee | string (20) | 必须 | 呼入的被叫号码(一般为小号) |
请求响应
语音交互接口分为以下 4 种响应
1.1.1.1 错误响应
| 字段名称 | 类型 | 约束 | 说明 |
| code | int | 必须 | 状态码，200 表示成功 其他表示处理失 败 |
| msg | string (50) | 必须 | 失败时，错误原因描述必填 |
51.1.1.2 业务中止响应
| 字段名称 | 类型 | 约束 | 说明 |
| code | int | 必须 | 状态码，200 表示成功 |
| processType | string (2) | 必须 | 1 小号逻辑关机2 被叫号码不存在3 （客户级）黑名单号码拦截 |
| data | DataInfo | 可选 | |
| DataInfo（以下未DataInfo里的参数） | - | - | - |
| uId | string (32) | 可选 | 客户平台指定ID标识 |
| audioCode | string (50) | 条件 | 客户定制音频文件编码注 1 |
注 1：一般情况下，小号逻辑关机、被叫号码不存在、号码拦截由平台提供默认提示音，无需特别指定。
1.1.1.3 普通语音业务响应
普通语音业务支持呼叫前转、企业彩铃、企业名片等增值业务。
| 字段名称 | 类型 | 约束 | 说明 |
| code | int | 必须 | 状态码，200 表示成功 |
| processType | string (2) | 必须 | 0 正常呼叫 |
| data | DataInfo | 必须 | |
| DataInfo（以下未DataInfo里的参数） | - | - | - |
| uId | String (32) | 可选 | 客户平台指定ID标识 |
| caller | string (20) | 必须 | 呼出的主叫号码(一般为小号) |
| callee | string (20) | 必须 | 呼出的被叫号码(真实被叫) |
| limitTime | string (5) | 可选 | 接通时长限制，单位为秒，有效值范围 60 至 3600，范围之外视为未设置该参数通常不需要设置，最大时长由基 础网限制 |
| audioCode | string (50) | 可选 | 企业彩铃的音频文件编码 |
| ussd | int | 可选 | 企业名片注 11: 主叫企业名片2：被叫企业名片 |
| noAnswerForward | string (1) | 可选 | 无应答前转0：不前转1：前转 |
| busyForword | string (1) | 可选 | 遇忙前转0：不前转1：前转 |
| altCallee | string (20) | 可选 | 前转号码 |
| connectAudioToUp | string (50) | 可选 | 接通后,向主叫播放的音频文件编码 |
| connectAudioToDown | string (50) | 可选 | 接通后,向被叫叫播放的音频文件编码 |
| hangupDtmf | string (1) | 可选 | 挂断前的 DTMF 收号功能0：不生效1：主叫挂断时，被叫 DTMF 流程2：被叫挂断时，主叫 DTMF 流程 |
| hangupDtmfWaitingTi me | string (2) | 可选 | DTMF 最大等待时长，单位秒，有效值范 围 5 至 30，范围之外视为未设置未设置时缺省值为 5 |
| hangupFrontDtmf | string (50) | 可选 | DTMF 前的引导音频文件 |
| hangupAfterDtmfOk | string (50) | 可选 | DTMF 后的终结音频文件,有效按键时播 |
| hangupAfterDtmfFail | string (50) | 可选 | DTMF 后的终结音频文件，无效按键时播 |
1.2 CDR 接口
接口提供方：客户平台
接口资源名称
/free/v2.0/cdr_pull
1.2.1 语音 CDR
| 字段名称 | 类型 | 约束 | 说明 |
| id | string (64) | 必须 | 语音 call-id |
| uId | string (32) | 可选 | 客户平台指定ID标识 |
| serviceType | string (8) | 必须 | 业务类型：voice |
| inboundCaller | string (20) | 必须 | 呼入主叫(真实主叫) |
| inboundCallee | string (20) | 必须 | 呼入被叫(一般为小号) |
| outboundCaller | string (20) | 必须 | 呼出主叫(一般为小号) |
| outboundCallee | string (20) | 必须 | 呼出被叫(真实被叫) |
| startTime | string (20) | 必须 | 呼叫起始时间 |
| ringTime | string (20) | 可选 | 振铃时间 |
| connectTime | string (20) | 可选 | 接通时间 |
| endTime | string (20) | 可选 | 呼叫结束时间 |
| talkTime | int（8） | 可选 | 通话时长 |
| releaseDir | int | 必须 | 释放原因0：主叫释放1：被叫释放2：平台释放 |
| releaseCause | int | 必须 | 话务分析 |
| recordUrl | string (256) | 条件 | 录音文件提取方式向企业客户推送录音时 |
| dtmfValue | string (1) | 条件 | 挂断前的 DTMF 收号结果 |
注：录音保存时间为 3 个月
注 1：话务分析
| 键值 | 话务分析描述 |
| 1 | 无匹配规则 |
| 2 | 拦截 |
| 3 | 小号逻辑关机 |
| 4 | 业务响应超时 |
| 5 | 未接通超时 |
| 6 | Channel 异常 |
| 7 | Session 异常 |
| 8 | 系统处理异常 |
| 9 | 呼入信令异常 |
| 10 | 保留 |
| 11 | 主叫正常挂机 |
| 12 | 主叫挂机 |
| 13 | 被叫正常挂机 |
| 14 | 被叫挂机 |
| 15 | 超长通话平台拆机 |
| 16 | 业务设置通话时长平台拆机 |
| 17 | 媒体中断平台拆机 |
| 18 | 系统拆机 |
| 19 | 被叫停机 |
| 20 | 被叫关机 |
| 21 | 主叫呼叫中止 |
| 22 | 主叫中止 |
| 23 | 号码不存在 |
| 24 | 转接遇忙 |
| 25 | 被叫忙 |
| 26 | 被叫拒接 |
| 27 | 被叫漏接 |
| 28 | 被叫无应答 |
| 29 | 被叫不可及 |
| 30 | 不可达，未指定 |
| 41 | DTMF 无响应 |
| 42 | DTMF 号码异常 |
| 43 | DTMF 处理异常 |
| 80 | 路由阻塞 |
| 98 | 未知定义 |
| 99 | 无法判断 |