主账户信息_开发文档

| 开发者中心

新用户指南 SDK文档 Rest API IVR API 云通讯首页

∨ Rest API介绍

Rest 介绍

❀ 云通讯首页>>开发者中心>>Rest API>>Rest介绍

账户信息查询

账户信息查询是云通讯平台提供的一个账户管理API，通过此REST API可以方便您对账户进行管理。

接口Demo示例可在REST Server Demo中找到，开发者可根据使用的语言下载对应的Demo

REST API：账户信息查询

通过HTTPS GET方式提交请求，云通讯平台收到请求后，返回主账号信息。

1、请求

1.1 请求地址

通过主账户Id查询使用GET方式

/{SoftVersion}/Accounts/{accountSid}/AccountInfo

1.2 请求包头

请参阅：Rest 介绍》统一请求包头，使用主账户进行验证

1.3 请求包体

无

1.4 XML请求示例

GET /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/AccountInfo?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
Host:192.168.0.1:8883
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=

1.5 JSON请求示例

GET /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/AccountInfo?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
Host:192.168.0.1:8883
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=

2、响应

2.1 响应包体

属性	类型	约束	说明
statusCode	String	必选	请求状态码，取值000000（成功），可参考Rest 错误代码。
dateCreated	String	必选	主账户的创建时间
dateUpdated	String	必选	主账户的最近更新时间
friendlyName	String	必选	主账户名称，唯一，由64个英文字母和阿拉伯数字组成，默认为你的电子邮箱地址
type	String	必选	主账户类型，取值有0（试用）和1（已注册），默认值为0
status	String	必选	主账户状态，取值有0（未激活）、1（激活）、2（暂停）、3（关闭），默认值为0
balance	String	必选	主账户余额
subBalance	String	必选	副账户余额

2.1 XML响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
  <Account>
    <friendlyName>help@163.com</friendlyName>
    <type>0</type>
    <status>1</status>
    <dateCreated>2013-02-01 15:38:09</dateCreated>
    <dateUpdated>2013-02-01 15:38:09</dateUpdated>
    <balance>0.0</balance>
    <subBalance>112.0</balance>
  </Account>
</Response>

2.3 JSON响应示例

HTTP/1.1 200 OK 
Content-Length: 641 

{"statusCode":"000000","Account":{"balance":"211","subBalance":"112","status":"1","friendlyName":"123456789@qq.com",
 "dateCreated":"2013-02-19 14:59:18","type":"1","dateUpdated":"2013-09-27 09:13:33"}}

文档更新时间：2017年5月12日