功能描述:
- 密钥鉴权是实现呼叫中心接口安全调用。密钥鉴权主要用于服务器后端程序调用。在调用具体应用接口时,增加 appkey、sign、time 参数。
基本流程:
- 接口参数配置生成 appkey 及 appsecret。配置如下图:
- 调用呼叫操作接口时,获取所有的需要传递的参数,作为一个数组。
- 排除数组中键为 sign 和值为空的数据,即 sign 的值和空数据不参与加密。
- 对数组进行排序,按照 key 的名称升序排列。遍历参数数组,将值拼接成一串字符串 str1。
- 对 secret(密码)进行 sha1 加密, 生成一串字符串 str2。
- 将 str1 与 str2 字符串拼接为一个新字符串 str3。
- 生成 sign 值,将 str3 字符串进行 sha1 加密后转为小写。
请求 URL:
注:调用呼叫操作时,需要进行鉴权。其中 xxxapp 为具体应用名称,例如:dail
请求方式:
- POST
请求参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
appkey | 是 | string(32) | 应用的 appkey |
sign | 是 | string(32) | 加密鉴权验证字段 |
time | 是 | string(32) | Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟 |
注:appsecret 是密钥,不作为参数传递。
返回示例:
正确时返回:
{
"success": true,
"code": "100000",
"msg": "操作成功",
"data": null
}
错误时返回:
{
"success": false,
"code": "100001",
"msg": "这里是返回的消息",
"data": null
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
success | string | 请求的状态,true:请求成功,false:请求失败 |
code | string(6) | 结果码,用于区分状态类型 |
msg | string | 描述内容 |
data | json | 用于处理数据,此处值为:null |
状态码:
结果码 | 描述 | 处理方法 |
---|---|---|
100000 | 请求成功 | 请求的状态,true:请求成功,false:请求失败 |
100100 | 连接呼叫模块失败 | 检查接口中呼叫中心配置地址。 |
100101 | 未检测到 sign 参数, sign 参数为必传选项 | 传递 sign 参数 |
100102 | 加密校验失败, 请检查加密是否正确 | 加密码不匹配 |
100103 | 缺少 time 参数,time 为必传的参数 | 传递 time 参数 |
100104 | 接口访问连接的有效期为 10 分钟, 您传递过来的时间为 xxxx | 接口请求时效保持 10 分钟内 |
100105 | appkey 为必传的参数 | appkey 为必传参数 |
100106 | appkey 值不能为空 | appkey 值不能为空 |
100107 | appkey 长度错误,应为 32 位字符串 | appkey 长度应为 32 位字符串 |
100108 | appkey 格式错误 | appkey 格式错误 |
100109 | appkey 错误 | 与设置 appkey 无法匹配 |
100110 | ||
100111 | ||
100112 |
文档更新时间: 2020-11-03 09:03 作者:admin