“密保拨号秘钥”的版本间的差异

来自uucall
跳转至: 导航搜索
创建密保拨号秘钥
创建密保拨号秘钥
第1行: 第1行:
 
== 创建密保拨号秘钥 ==
 
== 创建密保拨号秘钥 ==
 
=== 说明 ===
 
=== 说明 ===
方法: GET<br />
+
方法: POST<br />
 
前缀:http://ip:port/uucall_restapi/rest/
 
前缀:http://ip:port/uucall_restapi/rest/
路径: cti/ivr/ivrdetail<br />
+
路径: callback/dailkey<br />
 
参数校验:无
 
参数校验:无
  
 
=== 示例 ===  
 
=== 示例 ===  
  GET /cti/ivr/ivrdetail?uid=1225 HTTP/1.1
+
  POST /callback/dailkey HTTP/1.1
 
  Host:192.168.2.1:2888
 
  Host:192.168.2.1:2888
 
  content-length: 139
 
  content-length: 139
第22行: 第22行:
 
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 
|-
 
|-
| 输入参数 || uid || 企业帐号ID || true || Long ||  
+
| 输入参数 || uid || 企业帐号ID || true || String ||  
 +
|-
 +
|-
 +
| 输入参数 || secretType|| 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列  4: 双向回拨- 其中转接不为4和1的话,caller为转接参数 || false|| String ||
 +
|-
 +
|-
 +
| 输入参数 || diyCaller || 回拨主叫号码 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || diyCallee|| 被叫透显号码 || false|| String ||
 +
|-
 +
|-
 +
| 输入参数 || callee|| 回拨被叫号码 || true || String ||
 +
|-
 +
|-
 +
| 输入参数 || caller|| secretType=1:添分机id
 +
secretType=2:ivr id
 +
secretType=3:队列 id
 +
secretType=4: 被叫号码
 +
|| false|| String || 如果这个值没设置的话,扫描二维码的时候是跳到新页面自己手输,有设置的话扫描二维码就直接进行密保拨号
 
|-
 
|-
 
|}
 
|}
第30行: 第49行:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Result !! Data !! Code
+
! Result !!Code !! Data
 
|-
 
|-
| success || [ivr模板json字符串,ivr模板json字符串,...] || 0
+
| success || 0 || dailkey
 
|-
 
|-
| error || sql exception || 4
+
| 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// 请求外呼失败
 
|-
 
|-
| error || parameters error || 9
 
 
|}
 
|}
  
 
返回值格式:  
 
返回值格式:  
 
application/json<br />
 
application/json<br />
其中 ivr模板json字符串 形式如下:<br />
+
 
<br />
+
 
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
+
 
<br />
 
<br />
  

2016年4月5日 (二) 10:13的版本

创建密保拨号秘钥

说明

方法: POST
前缀:http://ip:port/uucall_restapi/rest/ 路径: callback/dailkey
参数校验:无

示例

POST /callback/dailkey 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
输入参数 secretType 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列 4: 双向回拨- 其中转接不为4和1的话,caller为转接参数 false String
输入参数 diyCaller 回拨主叫号码 false String
输入参数 diyCallee 被叫透显号码 false String
输入参数 callee 回拨被叫号码 true String
输入参数 caller secretType=1:添分机id

secretType=2:ivr id secretType=3:队列 id secretType=4: 被叫号码

false String 如果这个值没设置的话,扫描二维码的时候是跳到新页面自己手输,有设置的话扫描二维码就直接进行密保拨号

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Code Data
success 0 dailkey
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



密保拨号信息查询

修改密保拨号信息

删除密保拨号信息