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

来自uucall
跳转至： 导航、 搜索
（→‎创建密保拨号秘钥）
第2行： 第2行：
 
=== 说明 ===
 
=== 说明 ===
 
方法: POST<br />
 
方法: POST<br />
−
前缀：http://ip:port/uucall_restapi/rest/
+
前缀：http://ip:port/uucall_restapi/rest/<br />
 
路径: callback/dailkey<br />
 
路径: callback/dailkey<br />
 
参数校验：无
 
参数校验：无
第80行： 第80行：
 
application/json<br />
 
application/json<br />
  
 +
== 密保拨号信息查询 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: callback/dailkeypage<br />
 +
参数校验：无
  
 +
=== 示例 ===
 +
GET callback/dailkeypage 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
 
<br />
 
<br />
  
−
== 密保拨号信息查询 ==
+
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || String ||
 +
|-
 +
|-
 +
| 输入参数 || state || 状态 (1:有效 2:无效 ) || false|| String ||
 +
|-
 +
|-
 +
| 输入参数 || sdate || 创建时间开始格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || edate || 创建时间结束格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 || false|| String ||
 +
|-
 +
|-
 +
| 输入参数 || command || 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列  4: 双向回拨- 其中转接不为4和1的话，caller为转接参数 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || callbackDiyCaller || 回拨主叫外显 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || diyCallee || 被叫透显 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || callbackCaller || 回拨主叫 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || callee || 被叫 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || page || 第几页 大于0，默认1 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || pagesize || 一页几行 大于0，最大不能超过100，默认10 || false || String ||
 +
|}
 +
 
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !!Code !!  Data
 +
|-
 +
| success || 0 || list<data>
 +
|-
 +
| error|| 1 || 错误信息
 +
|}
 +
 
 +
返回值格式:
 +
application/json<br />
 +
 
 
== 修改密保拨号信息 ==
 
== 修改密保拨号信息 ==
 +
=== 说明 ===
 +
方法: PUT<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: callback/{uid}/dailkeys/{dailkey}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
PUT callback/1225/dailkeys/dsadsffgdfsfdsfsdf 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
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || String ||
 +
|-
 +
|-
 +
| 输入参数 || dailkey || 密保呼叫密匙 || true|| String ||
 +
|-
 +
|-
 +
| 输入参数 || secretType || 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列  4: 双向回拨- 其中转接不为4和1的话，caller为转接参数 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || diyCaller || 回拨主叫号码 || false|| String ||
 +
|-
 +
|-
 +
| 输入参数 || diyCallee || 被叫透显号码 || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || caller || secretType=1：添分机id; secretType=2:ivr id; secretType=3:队列 id; secretType=4: 被叫号码; 如果secretType有传 这个必传; || false || String ||
 +
|-
 +
|-
 +
| 输入参数 || callee || 回拨被叫号码 || false || String ||
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
返回值格式:
 +
application/json<br />
 +
 
== 删除密保拨号信息 ==
 
== 删除密保拨号信息 ==
 +
=== 说明 ===
 +
方法: DELETE<br />
 +
前缀：http://ip:port/uucall_restapi/rest/<br />
 +
路径: callback/{uid}/dailkeys/{dailkey}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
DELETE callback/1225/dailkeys/dsadsffgdfsfdsfsdf 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
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || uid || 企业帐号ID || true || String ||
 +
|-
 +
|-
 +
| 输入参数 || dailkey || 密保呼叫密匙 || true|| String ||
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
返回值格式:
 +
application/json<br />

2016年4月25日 (一) 14: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

密保拨号信息查询

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/
路径: callback/dailkeypage
参数校验：无

示例

GET callback/dailkeypage 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
输入参数 state 状态 (1:有效 2:无效 ) false String
输入参数 sdate 创建时间开始格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 false String
输入参数 edate 创建时间结束格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 false String
输入参数 command 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列 4: 双向回拨- 其中转接不为4和1的话，caller为转接参数 false String
输入参数 callbackDiyCaller 回拨主叫外显 false String
输入参数 diyCallee 被叫透显 false String
输入参数 callbackCaller 回拨主叫 false String
输入参数 callee 被叫 false String
输入参数 page 第几页 大于0，默认1 false String
输入参数 pagesize 一页几行 大于0，最大不能超过100，默认10 false String

结构响应

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

Result Code Data
success 0 list
error 1 错误信息

返回值格式: application/json

修改密保拨号信息

说明

方法: PUT
前缀：http://ip:port/uucall_restapi/rest/
路径: callback/{uid}/dailkeys/{dailkey}
参数校验：无

示例

PUT callback/1225/dailkeys/dsadsffgdfsfdsfsdf 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
输入参数 dailkey 密保呼叫密匙 true String
输入参数 secretType 拨号命令( 1: 双向分机回拨 2: 外呼转接IVR 3: 外呼转接队列 4: 双向回拨- 其中转接不为4和1的话，caller为转接参数 false String
输入参数 diyCaller 回拨主叫号码 false String
输入参数 diyCallee 被叫透显号码 false String
输入参数 caller secretType=1：添分机id; secretType=2:ivr id; secretType=3:队列 id; secretType=4: 被叫号码; 如果secretType有传 这个必传; false String
输入参数 callee 回拨被叫号码 false String

结构响应

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

Result Data
success 成功描述
failed 失败描述

返回值格式: application/json

删除密保拨号信息

说明

方法: DELETE
前缀：http://ip:port/uucall_restapi/rest/
路径: callback/{uid}/dailkeys/{dailkey}
参数校验：无

示例

DELETE callback/1225/dailkeys/dsadsffgdfsfdsfsdf 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
输入参数 dailkey 密保呼叫密匙 true String

结构响应

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

Result Data
success 成功描述
failed 失败描述

返回值格式: application/json

取自“http://112.5.128.48:9988/index.php?title=密保拨号秘钥&oldid=163”