二维码拨号

来自uucall
跳转至: 导航搜索

创建二维码

  • 说明
方法: POST
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/qrgenerator
参数校验:无
  • 示例
POST callback/qrgenerator 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":"1225",
"dailKey":"dd746577edb0465680cc7f0356e354f6"
}


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true String
输入参数 dailKey 密保呼叫密匙 true String


  • 结构响应

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

Result Code Data
success 0 二维码名称用于下载
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// 请求外呼失败


  • 返回值格式

{"Result":"SUCCESS","data":"","code":0}

查询二维码

  • 说明
方法: GET
前缀:http://ip:port/uucall_restapi/rest/
路径: callback/qrgeneratorpage
参数校验:无
  • 示例
GET callback/qrgeneratorpage 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-12-31 23:59:59 false String
输入参数 edate 创建时间结束格式"yyyy-MM-dd HH:mm:ss",例如:2016-12-31 23:59:59 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 错误信息


  • 返回值格式

{"Result":"SUCCESS","data":"{PageUtil(page:1, pageSize:10, total:0)=[]}","code":100}

删除二维码

  • 说明
方法: DELETE
前缀:http://ip:port/uucall_restapi/rest/
路径: /callback/{uid}/qrgenerators/{qrgeneratorid}
参数校验:无
  • 示例
DELETE /callback/1225/qrgenerators/111 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
输入参数 qrgeneratorid 二维码id true String


  • 结构响应

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

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


返回值格式: application/json