文档首页

新手指南

Rest API

iOS SDK

Android SDK

状态码

常见问题

文档>Rest Api介绍

Rest API介绍及接入

有联云通讯开放平台提供语音、短信等通讯服务。当您计划在自有业务接入我们平台相关资源服务的同时，可以将有联云认为是一个巨大的通讯（语音短信等）路由平台。

  • 以语音为例：
  • 平台主要为其他业务提供电话的接入、呼出，甚至包括电话的桥接，平台也主要为开发者提供IP网络与电信网络的语音传输和桥接，例如您可以通过IP网络发出呼叫至电信网（PSTN）的用户------我们将这种语音通讯场景称作：直拨。

为方便不同行业的开发者理解和快速接入，我们将所有的通讯服务都提供一套 Restful 的标准接口，基于这些接口开发者就只需要具备基本的HTTP协议知识背景，以及结合任何一门熟悉的开发语音，就可完成在现有业务的基础上完成集成通讯服务。

除了为开发者提供标准的Rest 接口，我们还针对不同平台提供SDK，您可以根据自己业务的需求，下载并集成相应的SDK快速开发

Rest API简介

注：Rest是一套新兴的web通讯协议，访问方式和普通的http类似，平台接口分get和post方式请求。

有联云融合通讯开放平台rest 接口为第三方应用提供了简单易用的API调用服务，旨在为第三方开发者在应用内快速、高效、低成本集成有联云的各项业务提供了一站式的服务。

REST 协议支持xml，json两种请求方式,采用md5加密算法的方式，通过url参数的形式发送参数

REST API提供功能如下：

在使用有联云融合通讯开放平台REST API前，请您在有联云官网首页注册账户，您将拥有一个主账户和若干Client，您可以通过Client管理客户信息以及控制用户使用情况。

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

开发环境要求

不要求，可以支持任何语言

REST API的作用

  • 1. 创建子账号，用于客户端的接入
  • 2. 语音验证码
  • 3. 语音消息(发送任何法律范围内的文字用语音的形式播放)
  • 4. 回拨(有联云发起，接通主被叫双方)
  • 5. 话单下载(应用级别话单下载)

Best URL

文档中所有请求的URL地址都须加上如下Best URL：

https://app.youlianyun.com:443

注意： 为了确保数据隐私和安全， REST API须通过HTTPS方式请求。

统一请求包头

请求URL格式

/Accounts/{accountSid}/{function}/{operation}?sig={SigParameter}

HTTP标准包头字段（必填）

Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Content-Length:256;

属性说明

属性 类型 约束 说明
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. SigParameter是REST API 验证参数

  • 1. URL后必须带有sig参数，sig= MD5（账户Id + 账户授权令牌 + 时间戳），共32位(注:转成大写)
  • 2. 使用MD5加密（账户Id + 账户授权令牌 + 时间戳），共32位
  • 3. 时间戳是当前系统时间（24小时制），格式“yyyyMMddHHmmss”。时间戳有效时间为50分钟。
  • 注：账户授权令牌可在 有联云用户后台->应用->应用列表->某应用详细->签名验证（没值时需先设置）处找到。

3. Authorization是包头验证信息

  • 1. 使用Base64编码（账户Id + 冒号 + 时间戳）
  • 2. 冒号为英文冒号
  • 3. 时间戳是当前系统时间（24小时制），格式“yyyyMMddHHmmss”，需与SigParameter中时间戳相同。

4. function描述对应业务能力，operation描述业务能力的具体操作。

 例如：/Calls/callBack

数据报文格式

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；

想了解更多信息,请咨询QQ : 12925489

免费咨询
©有联云通讯 . All Rights Reserved 粤ICP备18114550号-2