外呼、回拨

来自uucall
Admin（讨论 | 贡献）2016年4月25日 (一) 16:54的版本

跳转至： 导航、 搜索

单向回拨电话通过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

取自“http://112.5.128.48:9988/index.php?title=外呼、回拨&oldid=202”