獲取子賬戶
獲取子賬戶是云通訊平臺(tái)為開(kāi)發(fā)者提供的子賬戶批量獲取接口，通過(guò)此REST API可以在您需要獲取大量子賬戶基本信息時(shí)使用。支持版本{2013-12-26}
REST API: 獲取子賬戶
通過(guò)HTTPS POST方式提交請(qǐng)求，云通訊平臺(tái)收到請(qǐng)求后根據(jù)子賬戶開(kāi)始序號(hào)查詢并批量返回子賬戶信息。
接口Demo示例可在REST Server Demo中找到，開(kāi)發(fā)者可根據(jù)使用的語(yǔ)言下載對(duì)應(yīng)的Demo
1、請(qǐng)求
1.1 請(qǐng)求地址
/{SoftVersion}/Accounts/{accountSid}/GetSubAccounts
1.2 請(qǐng)求包頭
請(qǐng)參閱：Rest 介紹》統(tǒng)一請(qǐng)求包頭，使用主賬戶進(jìn)行驗(yàn)證
1.3 請(qǐng)求包體
| 屬性 | 類(lèi)型 | 約束 | 說(shuō)明 |
|---|---|---|---|
| appId | String | 必選 | 應(yīng)用Id |
| startNo | String | 可選 | 開(kāi)始的序號(hào)，默認(rèn)從0開(kāi)始 |
| offset | String | 可選 | 一次查詢的最大條數(shù)，最小是1條，最大是100條 |
1.4 XML請(qǐng)求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/GetSubAccounts?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1 Host:192.168.0.1:8883 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version='1.0' encoding='utf-8'?> <SubAccount> <appId>ff8080813c37da53013c8054f5123456</appId> <startNo>1</startNo> <offset>10</offset> </SubAccount>
1.5 JSON請(qǐng)求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/GetSubAccounts?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
{'appId':'ff8080813c37da53013c8054f5612345','startNo':'1','offset':'10'}
2、響應(yīng)
2.1 響應(yīng)包體
| 屬性 | 類(lèi)型 | 約束 | 說(shuō)明 |
|---|---|---|---|
| statusCode | String | 必選 | 請(qǐng)求狀態(tài)碼，取值000000（成功），可參考Rest 錯(cuò)誤代碼。 |
| totalCount | String | 必選 | 子賬號(hào)的數(shù)量 |
| SubAccount | String | 必選 | 節(jié)點(diǎn)的名稱 |
| subAccountSid | String | 必選 | 子賬戶Id。由32個(gè)英文字母和阿拉伯?dāng)?shù)字組成的子賬戶唯一標(biāo)識(shí)符 |
| subToken | String | 必選 | 子賬戶的授權(quán)令牌。由32個(gè)英文字母和阿拉伯?dāng)?shù)字組成 |
| dateCreated | String | 必選 | 子賬戶的創(chuàng)建時(shí)間 |
| voipAccount | String | 必選 | 通訊賬號(hào)。由14位數(shù)字組成，用于客戶端SDK登錄，作為語(yǔ)音通話及IM功能的唯一標(biāo)識(shí)帳號(hào) |
| voipPwd | String | 必選 | 通訊密碼。由8位數(shù)字和字母組成 |
| friendlyName | String | 必選 | 子賬號(hào)名稱 |
2.1 XML響應(yīng)示例
HTTP/1.1 200 OK
Content-Length:586
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
<statusCode>000000</statusCode>
<totalCount>2</totalCount>
<SubAccount>
<subAccountSid>abcdefghijklmnopqrstuvwxyz123456</subAccountSid>
<subToken>666961bb08a14f568d421e6fe57d2d3c</subToken>
<friendlyName>2981</friendlyName>
<dateCreated>2013-02-01 15:22:46</dateCreated>
<voipAccount>80000123456789</voipAccount>
<voipPwd>xRkazyz3</voipPwd>
</SubAccount>
<SubAccount>
<subAccountSid>abcdefghijklmnopqrstuvwxyz123457</subAccountSid>
<subToken>666961bb08a14f568d421e6fe57d2d3c</subToken>
<friendlyName>2983</friendlyName>
<dateCreated>2013-02-01 15:22:46</dateCreated>
<voipAccount>80000123456780</voipAccount>
<voipPwd>xRkazyz3</voipPwd>
</SubAccount>
</Response>
2.3 JSON響應(yīng)示例
HTTP/1.1 200 OK
Content-Length:586
{"statusCode":"000000","totalCount":"2","SubAccount":[{"subAccountSid":"abcdefghijklmnopqrstuvwxyz123456","subToken":"666961bb08a14f568d42176fe571234","friendlyName":" 2983"
"dateCreated":"2013-09-27 11:42:24","voipAccount":"80000123456789","voipPwd":" xRkazyz3"},{"subAccountSid":"abcdefghijklmnopqrstuvwxyz123457","subToken":"666961bb08a14f568d42176fe571234","friendlyName":" 2980"
"dateCreated":"2013-09-27 11:42:24","voipAccount":"80000123456780","voipPwd":" xRkazyz3"}]}