“外呼、回拨”的版本间的差异
第1行: | 第1行: | ||
== 单向回拨电话通过ivr == | == 单向回拨电话通过ivr == | ||
− | + | * <big>说明</big> | |
方法: POST<br /> | 方法: POST<br /> | ||
前缀:http://ip:port/uucall_restapi/rest/<br /> | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
第6行: | 第6行: | ||
参数校验:无 | 参数校验:无 | ||
− | + | * <big>示例</big> | |
POST callback/callbackivr HTTP/1.1 | POST callback/callbackivr HTTP/1.1 | ||
Host:192.168.2.1:2888 | Host:192.168.2.1:2888 | ||
第17行: | 第17行: | ||
<br /> | <br /> | ||
− | + | * <big>参数列表</big> | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第37行: | 第37行: | ||
|} | |} | ||
− | + | * <big>结构响应</big> | |
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
{| class="wikitable" | {| class="wikitable" | ||
第73行: | 第73行: | ||
== 单向回拨电话通过队列 == | == 单向回拨电话通过队列 == | ||
− | + | * <big>说明</big> | |
方法: POST<br /> | 方法: POST<br /> | ||
前缀:http://ip:port/uucall_restapi/rest/<br /> | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
第79行: | 第79行: | ||
参数校验:无 | 参数校验:无 | ||
− | + | * <big>示例</big> | |
POST callback/callbackqueue HTTP/1.1 | POST callback/callbackqueue HTTP/1.1 | ||
Host:192.168.2.1:2888 | Host:192.168.2.1:2888 | ||
第90行: | 第90行: | ||
<br /> | <br /> | ||
− | + | * <big>参数列表</big> | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第110行: | 第110行: | ||
|} | |} | ||
− | + | * <big>结构响应</big> | |
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
{| class="wikitable" | {| class="wikitable" | ||
第146行: | 第146行: | ||
== 单向回拨电话通过tts == | == 单向回拨电话通过tts == | ||
− | + | * <big>说明</big> | |
方法: POST<br /> | 方法: POST<br /> | ||
前缀:http://ip:port/uucall_restapi/rest/<br /> | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
第152行: | 第152行: | ||
参数校验:无 | 参数校验:无 | ||
− | + | * <big>示例</big> | |
POST callback/callbacktts HTTP/1.1 | POST callback/callbacktts HTTP/1.1 | ||
Host:192.168.2.1:2888 | Host:192.168.2.1:2888 | ||
第163行: | 第163行: | ||
<br /> | <br /> | ||
− | + | * <big>参数列表</big> | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第183行: | 第183行: | ||
|} | |} | ||
− | + | * <big>结构响应</big> | |
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
{| class="wikitable" | {| class="wikitable" | ||
第219行: | 第219行: | ||
== 双向回拨电话到电话 == | == 双向回拨电话到电话 == | ||
− | + | * <big>说明</big> | |
方法: POST<br /> | 方法: POST<br /> | ||
前缀:http://ip:port/uucall_restapi/rest/<br /> | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
第225行: | 第225行: | ||
参数校验:无 | 参数校验:无 | ||
− | + | * <big>示例</big> | |
POST callback/callbackphonetophone HTTP/1.1 | POST callback/callbackphonetophone HTTP/1.1 | ||
Host:192.168.2.1:2888 | Host:192.168.2.1:2888 | ||
第236行: | 第236行: | ||
<br /> | <br /> | ||
− | + | * <big>参数列表</big> | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第259行: | 第259行: | ||
|} | |} | ||
− | + | * <big>结构响应</big> | |
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
{| class="wikitable" | {| class="wikitable" | ||
第295行: | 第295行: | ||
== 双向回拨Voip到电话 == | == 双向回拨Voip到电话 == | ||
− | + | * <big>说明</big> | |
方法: POST<br /> | 方法: POST<br /> | ||
前缀:http://ip:port/uucall_restapi/rest/<br /> | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
第301行: | 第301行: | ||
参数校验:无 | 参数校验:无 | ||
− | + | * <big>示例</big> | |
POST callback/callbackvoiptophone HTTP/1.1 | POST callback/callbackvoiptophone HTTP/1.1 | ||
Host:192.168.2.1:2888 | Host:192.168.2.1:2888 | ||
第312行: | 第312行: | ||
<br /> | <br /> | ||
− | + | * <big>参数列表</big> | |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第335行: | 第335行: | ||
|} | |} | ||
− | + | * <big>结构响应</big> | |
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
{| class="wikitable" | {| class="wikitable" |
2016年4月25日 (一) 16:18的版本
单向回拨电话通过ivr
- 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/callbackivr
参数校验:无
- 示例
POST callback/callbackivr HTTP/1.1 Host:192.168.2.1:2888 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; appid:XXXX timestamp:2016-03-11 00:00:00 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | uid | 企业帐号ID | true | String | |
输入参数 | callId | 客户自定id | false | String | |
输入参数 | diyCallee | 被叫透显号码 | false | String | |
输入参数 | callee | 被叫号码 | true | String | |
输入参数 | ivrId | ivr id | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Code | Data |
---|---|---|
success | 0 | OK |
FAILED | 1 | API_RESULT_CODE_ERROR_CUSTOM // 自定义错误 |
FAILED | 2 | API_RESULT_CODE_ERROR_METHOD // 方法不存在 |
FAILED | 3 | API_RESULT_CODE_ERROR_LINE// 请求数达上限 |
FAILED | 4 | API_RESULT_CODE_ERROR_UNKNOW // 未知错误 |
FAILED | 5 | API_RESULT_CODE_ERROR_PASSPORT // passport错误 |
FAILED | 6 | API_RESULT_CODE_ERROR_POWER // 登陆用户不具备调用此方法的权限 |
FAILED | 100 | API_RESULT_CODE_ERROR_PARAM// 参数无效 |
FAILED | 101 | RAPI_ESULT_CODE_ERROR_PARAM_P// 分发参数无效 |
FAILED | 102 | API_RESULT_CODE_ERROR_API// api方法没有授权 |
FAILED | 103 | API_RESULT_CODE_ERROR_USER// 用户没有授权 |
FAILED | 104 | API_RESULT_CODE_ERROR_CALLOUT// 请求外呼失败 |
返回值格式:
application/json
单向回拨电话通过队列
- 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/callbackqueue
参数校验:无
- 示例
POST callback/callbackqueue HTTP/1.1 Host:192.168.2.1:2888 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; appid:XXXX timestamp:2016-03-11 00:00:00 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | uid | 企业帐号ID | true | String | |
输入参数 | callId | 客户自定id | false | String | |
输入参数 | diyCallee | 被叫透显号码 | false | String | |
输入参数 | callee | 被叫号码 | true | String | |
输入参数 | queueId | 队列 id | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Code | Data |
---|---|---|
success | 0 | OK |
FAILED | 1 | API_RESULT_CODE_ERROR_CUSTOM // 自定义错误 |
FAILED | 2 | API_RESULT_CODE_ERROR_METHOD // 方法不存在 |
FAILED | 3 | API_RESULT_CODE_ERROR_LINE// 请求数达上限 |
FAILED | 4 | API_RESULT_CODE_ERROR_UNKNOW // 未知错误 |
FAILED | 5 | API_RESULT_CODE_ERROR_PASSPORT // passport错误 |
FAILED | 6 | API_RESULT_CODE_ERROR_POWER // 登陆用户不具备调用此方法的权限 |
FAILED | 100 | API_RESULT_CODE_ERROR_PARAM// 参数无效 |
FAILED | 101 | RAPI_ESULT_CODE_ERROR_PARAM_P// 分发参数无效 |
FAILED | 102 | API_RESULT_CODE_ERROR_API// api方法没有授权 |
FAILED | 103 | API_RESULT_CODE_ERROR_USER// 用户没有授权 |
FAILED | 104 | API_RESULT_CODE_ERROR_CALLOUT// 请求外呼失败 |
返回值格式:
application/json
单向回拨电话通过tts
- 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/callbacktts
参数校验:无
- 示例
POST callback/callbacktts HTTP/1.1 Host:192.168.2.1:2888 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; appid:XXXX timestamp:2016-03-11 00:00:00 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | uid | 企业帐号ID | true | String | |
输入参数 | callId | 客户自定id | false | String | |
输入参数 | diyCallee | 被叫透显号码 | false | String | |
输入参数 | callee | 被叫号码 | true | String | |
输入参数 | ttsText | 要播放的语音文字 | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Code | Data |
---|---|---|
success | 0 | OK |
FAILED | 1 | API_RESULT_CODE_ERROR_CUSTOM // 自定义错误 |
FAILED | 2 | API_RESULT_CODE_ERROR_METHOD // 方法不存在 |
FAILED | 3 | API_RESULT_CODE_ERROR_LINE// 请求数达上限 |
FAILED | 4 | API_RESULT_CODE_ERROR_UNKNOW // 未知错误 |
FAILED | 5 | API_RESULT_CODE_ERROR_PASSPORT // passport错误 |
FAILED | 6 | API_RESULT_CODE_ERROR_POWER // 登陆用户不具备调用此方法的权限 |
FAILED | 100 | API_RESULT_CODE_ERROR_PARAM// 参数无效 |
FAILED | 101 | RAPI_ESULT_CODE_ERROR_PARAM_P// 分发参数无效 |
FAILED | 102 | API_RESULT_CODE_ERROR_API// api方法没有授权 |
FAILED | 103 | API_RESULT_CODE_ERROR_USER// 用户没有授权 |
FAILED | 104 | API_RESULT_CODE_ERROR_CALLOUT// 请求外呼失败 |
返回值格式:
application/json
双向回拨电话到电话
- 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/callbackphonetophone
参数校验:无
- 示例
POST callback/callbackphonetophone HTTP/1.1 Host:192.168.2.1:2888 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; appid:XXXX timestamp:2016-03-11 00:00:00 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | uid | 企业帐号ID | true | String | |
输入参数 | callId | 客户自定id | false | String | |
输入参数 | diyCallee | 被叫透显号码 | false | String | |
输入参数 | callee | 被叫号码 | true | String | |
输入参数 | caller | 回拨主叫号码 | true | String | |
输入参数 | diyCaller | 回拨主叫外显 | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Code | Data |
---|---|---|
success | 0 | OK |
FAILED | 1 | API_RESULT_CODE_ERROR_CUSTOM // 自定义错误 |
FAILED | 2 | API_RESULT_CODE_ERROR_METHOD // 方法不存在 |
FAILED | 3 | API_RESULT_CODE_ERROR_LINE// 请求数达上限 |
FAILED | 4 | API_RESULT_CODE_ERROR_UNKNOW // 未知错误 |
FAILED | 5 | API_RESULT_CODE_ERROR_PASSPORT // passport错误 |
FAILED | 6 | API_RESULT_CODE_ERROR_POWER // 登陆用户不具备调用此方法的权限 |
FAILED | 100 | API_RESULT_CODE_ERROR_PARAM// 参数无效 |
FAILED | 101 | RAPI_ESULT_CODE_ERROR_PARAM_P// 分发参数无效 |
FAILED | 102 | API_RESULT_CODE_ERROR_API// api方法没有授权 |
FAILED | 103 | API_RESULT_CODE_ERROR_USER// 用户没有授权 |
FAILED | 104 | API_RESULT_CODE_ERROR_CALLOUT// 请求外呼失败 |
返回值格式:
application/json
双向回拨Voip到电话
- 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/callbackvoiptophone
参数校验:无
- 示例
POST callback/callbackvoiptophone HTTP/1.1 Host:192.168.2.1:2888 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; appid:XXXX timestamp:2016-03-11 00:00:00 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | uid | 企业帐号ID | true | String | |
输入参数 | callId | 客户自定id | false | String | |
输入参数 | diyCallee | 被叫透显号码 | false | String | |
输入参数 | callee | 被叫号码 | true | String | |
输入参数 | caller | 坐席id | true | String | |
输入参数 | diyCaller | 回拨主叫外显 | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Code | Data |
---|---|---|
success | 0 | OK |
FAILED | 1 | API_RESULT_CODE_ERROR_CUSTOM // 自定义错误 |
FAILED | 2 | API_RESULT_CODE_ERROR_METHOD // 方法不存在 |
FAILED | 3 | API_RESULT_CODE_ERROR_LINE// 请求数达上限 |
FAILED | 4 | API_RESULT_CODE_ERROR_UNKNOW // 未知错误 |
FAILED | 5 | API_RESULT_CODE_ERROR_PASSPORT // passport错误 |
FAILED | 6 | API_RESULT_CODE_ERROR_POWER // 登陆用户不具备调用此方法的权限 |
FAILED | 100 | API_RESULT_CODE_ERROR_PARAM// 参数无效 |
FAILED | 101 | RAPI_ESULT_CODE_ERROR_PARAM_P// 分发参数无效 |
FAILED | 102 | API_RESULT_CODE_ERROR_API// api方法没有授权 |
FAILED | 103 | API_RESULT_CODE_ERROR_USER// 用户没有授权 |
FAILED | 104 | API_RESULT_CODE_ERROR_CALLOUT// 请求外呼失败 |
返回值格式:
application/json