中文帮助文档>Rest API

Rest API介绍

REST API DEMO 下载

轻码云平台rest接口为开发者提供语音能力接口。

在使用轻码云通讯开放平台REST API前,请您在网站首页注册账号,您将获得一个主账户和若干子账号,您可以通过子账号管理客户信息以及控制用户使用情况。

API是基于rest原则上的,您可以使用几乎任何客户端在任何编程语言与REST API进行交互,以及编写和测试应用程序。

Base URL:
文档中所有请求的URL地址都须加上如下Base URL:
https://api.qingmayun.com/{softVersion}
注意:为了确保数据隐私和安全, REST API须通过HTTPS方式请求。
统一请求包头
请求URL格式
Base URL与业务URL相拼接为完整请求URL
/accounts/{accountSid}/{function}/{operation}?sig={SigParameter}&timestamp={timestamp}
 
HTTP标准包头字段(必填)
Accept:application/xml
Content-Type:application/xml;charset=utf-8

属性说明

属性 类型 约束 说明
softVersion String 必选 轻码云平台REST API版本号。当前版本号为:20141029
accountSid String 必选 开发者账号ID。由32个英文字母和阿拉伯数字组成的开发者账号唯一标识符。
如果是子账号验证级别,则代表子账号id。
function String 必选 业务功能,根据业务的需要添加,具体的业务页面可获得该值。
operation String 必选 业务操作,业务功能的各类具体操作分支,具体的业务页面可获得该值。
sigParameter String 必选 REST API 验证参数,请求URL必须带有此参数,生成规则参考sigParameter生成说明
timestamp String 必选 时间戳,当前系统时间(24小时制),格式"yyyyMMddHHmmss"。时间戳有效时间为5分钟。
Accept String 必选 客户端响应接收数据格式:application/xml、application/json,具体信息参考数据报文格式
Content-Type String 必选 类型:application/xml;charset=utf-8、application/json;charset=utf-8,
具体信息参考数据报文格式
说明:
1、验证级别:
主账号鉴权(accountSid):轻码云平台对开发者主账号ID(ACCOUNT SID)和主帐号Token(AUTH TOKEN)进行验证。
子账号鉴权(clientNumber):轻码云平台对Client号码(clientNumber)和Client密码(clientPwd)进行验证。
 
sigParameter是REST API 验证参数

*URL后必须带有sig参数:

sig= MD5(ACCOUNT SID + AUTH TOKEN + 时间戳),共32位小写。
数据报文格式:
轻码云平台REST接口支持两种主流的报文格式:XML和JSON。
2.Accept表示返回给开发的数据类型。 application/xml;Content-Type:application/json若不包含application/xml 或者application/json 则返回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。