======Rest API介绍及接入====== Ucpaas通讯开放平台提供**语音、短信、视频、IM**等通讯服务。当您计划在自有业务接入我们平台相关资源服务的同时,可以将Ucpaas认为是一个巨大的通讯(语音、视频、IM等)路由平台。
https://api.ucpaas.com/{SoftVersion}/
注意: 为了确保数据隐私和安全, REST API须通过HTTPS方式请求。
==== 统一请求包头 ====
**请求URL格式**
{SoftVersion}/Accounts/{AccountSid}/{function}/{operation}?sig={SigParameter}
**HTTP标准包头字段(必填)**
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Content-Length:256;
==== 属性说明 ====
----
^属性 ^类型 ^约束 ^说明 |
|SoftVersion |String |必选 |云之讯REST API版本号,当前版本号为:2014-06-30 |
|AccountSid |String |必选 |开发者账号ID。由32个英文字母和阿拉伯数字组成的开发者账号唯一标识符 |
|SigParameter |String |必选 |请求URL必须带有此参数。 |
|Accept |String |必选 |客户端响应接收数据格式:application/xml、application/json |
|Content-Type |String |必选 |类型:application/xml;charset=utf-8、application/json;charset=utf-8 |
|Authorization |String |必选 |验证信息。 |
|function |String |可选 |业务功能。 |
|operation |String |可选 |业务操作,业务功能的各类具体操作分支。 |
**说明**
1. SoftVersion是当前使用的REST API版本号,开发时须填写正确的版本号。
2. SigParameter是REST API 验证参数\\
* URL后必须带有sig参数,sig= MD5(账户Id + 账户授权令牌 + 时间戳),共32位(注:转成大写)
* 使用MD5加密(账户Id + 账户授权令牌 + 时间戳),共32位
* 时间戳是当前系统时间(24小时制),格式"yyyyMMddHHmmss"。时间戳有效时间为50分钟。
3. Authorization是包头验证信息\\
* 使用Base64编码(账户Id + 冒号 + 时间戳)
* 冒号为英文冒号
* 时间戳是当前系统时间(24小时制),格式"yyyyMMddHHmmss",需与SigParameter中时间戳相同。
4. function描述对应业务能力,operation描述业务能力的具体操作。
例如:/Calls/voiceCode
==== 数据报文格式 ====
----
REST API支持两种主流的报文格式:XML和JSON。
通过请求包头的字段Content-Type及Accept,即可决定请求包体和响应包体的格式,如:
Content-Type:application/xml;charset=utf-8;Accept:application/xml;
表示请求类型格式是XML,要求服务器响应的包体类型也是XML;
Content-Type:application/json;charset=utf-8;Accept:application/json;
表示请求类型格式是JSON,要求服务器响应类型也是JSON;