“接口说明”的版本间的差异

来自uucall
跳转至: 导航搜索
第22行: 第22行:
 
  appid:XXXX<br />
 
  appid:XXXX<br />
 
  timestamp:2016-03-11 00:00:00<br />
 
  timestamp:2016-03-11 00:00:00<br />
  Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX<br />
+
  Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX<br /><br />
  属性说明:<br />
+
  <big><big>HTTP包头属性说明</big></big><br />
  appid:  
+
  appid: 对应模块应用id,具体详见appid获取接口说明<br />
  timestamp:
+
  timestamp: 请求时间戳格式 yyyy-MM-dd HH:mm:ss<br />
  Authorization:  
+
  Authorization: 验证信息,生成规则详见下方详细说明<br />
  
{| class="wikitable"
+
*<big><big>'''字段详细说明'''</big></big>
|-
+
1. appid 获取接口
! 属性 !! 类型 !! 约束 !! 说明
+
    • Accounts:主帐号鉴权,云通讯平台会对请求中的主帐号和主帐号Token进行验证;
|-
+
    • SubAccounts:子帐号鉴权,云通讯平台会对请求中的子帐号和子帐号Token进行验证。
| userName || String || 必选 || 接口使用者主帐号名称(合作客户登录主帐号)
+
 
|-
+
2. SigParameter 鉴权参数
| SigParameter || String || 必选 || REST API 验证参数,生成规则如下
+
    •  SigParameter是隐藏参数,参与到 Authorization 的校验运算规则当中。
1.使用MD5加密(userName+":"+apikey+":"+timestamp)。时间戳是当前系统时间,格式"yyyyMMddHHmmss"。时间戳有效时间为24小时,如:20140416142030
+
    •  使用MD5加密(apikey+":"+extras+timestamp)。其中apikey为企业授权接口密匙,需要接口使用者向UUCALL项目团队获取。     
2.SigParameter参数需要大写,如不能写成sig=abcdefg而应该写成sig=ABCDEFG
+
    •  时间戳是当前系统时间,格式"yyyy-MM-dd HH:mm:ss"。时间戳有效时间为24小时,如:2014-04-16 14:20:30,且必须与HTTP字段时间戳一致。
|}
+
    •  所生成的 SigParameter参数为32位大写MD5值
 +
 
 +
3. Authorization 包头验证信息
 +
    •  使用Base64编码(userName + 英文冒号 + SigParameter),其中 SigParameter 为隐藏数据
 +
    •  冒号为英文冒号
  
 
*<big><big>'''返回值说明'''</big></big>
 
*<big><big>'''返回值说明'''</big></big>

2016年4月25日 (一) 11:17的版本


  • 介绍

UUCALL 云呼叫中心平台 REST API 接口是为企业用户提供CTI管理、接口拨号、语音插件管理、CRM管理、帐号权限管理、账户信息、文件管理等模块功能的外部控制及数据交互的接口支持。API是基于REST原则上的,所以它很容易编写和测试应用程序。您可以使用浏览器访问URL,也可以使用几乎任何客户端在任何编程语言与REST API进行交互。

  • Base URL
所有被引用的地址都有如下Base URL:
沙盒地址,用于应用上线前进行业务测试的Base URL:https://cloud.uucall.cloopen.com:8883
生产地址,用于应用上线后进行正式业务的Base URL:https://cloud.uucall.cn:3888

注意:平台的REST API是通过HTTP方式请求。


  • 统一请求包头
URL格式:rest/{path}
注意:在URL格式中rest为固定内容,{}内的内容表示为实际接口的路径。
HTTP标准包头字段说明(必填)
Accept:text/xml;
Content-Type:text/xml;charset=utf-8;
Content-Length:256;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

HTTP包头属性说明
appid: 对应模块应用id,具体详见appid获取接口说明
timestamp: 请求时间戳格式 yyyy-MM-dd HH:mm:ss
Authorization: 验证信息,生成规则详见下方详细说明
  • 字段详细说明
1. appid 获取接口
   • Accounts:主帐号鉴权,云通讯平台会对请求中的主帐号和主帐号Token进行验证;
   • SubAccounts:子帐号鉴权,云通讯平台会对请求中的子帐号和子帐号Token进行验证。
2. SigParameter 鉴权参数
   •  SigParameter是隐藏参数,参与到 Authorization 的校验运算规则当中。
   •  使用MD5加密(apikey+":"+extras+timestamp)。其中apikey为企业授权接口密匙,需要接口使用者向UUCALL项目团队获取。      
   •  时间戳是当前系统时间,格式"yyyy-MM-dd HH:mm:ss"。时间戳有效时间为24小时,如:2014-04-16 14:20:30,且必须与HTTP字段时间戳一致。
   •  所生成的 SigParameter参数为32位大写MD5值 
3. Authorization 包头验证信息
   •  使用Base64编码(userName + 英文冒号 + SigParameter),其中 SigParameter 为隐藏数据
   •  冒号为英文冒号
  • 返回值说明