云之讯Rest API快速接入指南

云之讯Rest API快速接入指南

在2014年成立的云之讯目前是国内体量最大的云通讯PaaS平台，使用云之讯可以通过简单可靠的通信接口调用，来实现语音、短信、视频、IM等各类OTT通讯服务。从开发者角度而言，云之讯可以被看作是一个巨大的通讯路由平台。为了方便不同行业的开发者理解和快速接入，云之讯将所有的通讯服务都提供一套 Restful 的标准接口，基于这些接口开发者就只需要具备基本的HTTP协议知识背景，以及结合任何一门熟悉的开发语音，就可完成在现有业务的基础上完成集成通讯服务。

除了为开发者提供标准的Rest 接口，云之讯还针对不同平台提供SDK，包括iOS SDK、Android SDK、Windows SDK、以及未来即将推出的JS SDK，开发者可以根据自己业务的需求，下载并集成相应的SDK快速开发。下面我们就来简单介绍如何使用云之讯的Rest API。

云之讯Rest API功能：

Rest是一套新兴的web通讯协议，访问方式和普通的http类似，平台接口分get和post方式请求。云之讯融合通讯开放平台rest接口为第三方应用提供了简单易用的API调用服务，旨在为第三方开发者在应用内快速、高效、低成本集成云之讯的各项业务提供了一站式的服务。REST协议支持xml，json两种请求方式,采用md5加密算法的方式，通过url参数的形式发送参数。目前提供的主要功能包括：a、短信；b、语音验证码；c、语音通知；d、隐号通话 ；e、云呼叫中心；f、管理Client账号；g、详单记录下载。

开发环境需求：

在使用云之讯融合通讯开放平台REST API前，开发者需要在云之讯官网注册账号，之后您将拥有一个主账户和若干Client，您可以通过Client管理客户信息以及控制用户使用情况。API是基于rest协议的，您可以使用几乎任何客户端在任何编程语言与REST API进行交互，以及编写和测试应用程序。因此Rest API不要求开发环境，其可以支持任何语言。

REST API作用：

（1）创建子账号，用于客户端的接入

（2）语音验证码

（3）短信（短信验证码等）

（4）语音消息（发送任何法律范围内的文字用语音的形式播放）

Base URL接入：

对于REST API而言，所有请求的URL地址都须加上如下Base URL：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;

REST API属性说明：

如图所示，图中参数具体情况如下：（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。