子賬戶信息查詢是云通訊平臺為開發者提供的子賬戶查詢接口,通過此REST API可以在您創建子賬戶重復時,查詢原有的子賬戶信息。支持版本{2013-12-26}
REST API: 子賬戶信息查詢
通過HTTPS POST方式提交請求,云通訊平臺收到請求后根據子賬戶名稱查詢并返回子賬戶信息。
接口Demo示例可在REST Server Demo中找到,開發者可根據使用的語言下載對應的Demo
1、請求
1.1 請求地址
/{SoftVersion}/Accounts/{accountSid}/QuerySubAccountByName
1.2 請求包頭
請參閱:Rest 介紹》統一請求包頭,使用主賬戶進行驗證
1.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
appId | String | 必選 | 應用Id |
friendlyName | String | 必選 | 子賬戶名稱 |
1.4 XML請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/QuerySubAccountByName?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> <friendlyName>hello@163.com</friendlyName> </SubAccount>
1.5 JSON請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/QuerySubAccountByName?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','friendlyName':'用戶1'}
2、響應
2.1 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功),可參考Rest 錯誤代碼。 |
subAccountSid | String | 必選 | 子賬戶Id。由32個英文字母和阿拉伯數字組成的子賬戶唯一標識符 |
subToken | String | 必選 | 子賬戶的授權令牌。由32個英文字母和阿拉伯數字組成 |
dateCreated | String | 必選 | 子賬戶的創建時間 |
voipAccount | String | 必選 | 通訊賬號。由14位數字組成,用于客戶端SDK登錄,作為語音通話及IM功能的唯一標識帳號 |
voipPwd | String | 必選 | 通訊密碼。由8位數字和字母組成 |
2.1 XML響應示例
HTTP/1.1 200 OK Content-Length:586 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <SubAccount> <subAccountSid>abcdefghijklmnopqrstuvwxyz123456</subAccountSid> <subToken>666961bb08a14f568d421e6fe57d2d3c</subToken> <dateCreated>2013-02-01 15:22:46</dateCreated> <voipAccount>80000123456789</voipAccount> <voipPwd>xRkazyz3</voipPwd> </SubAccount> </Response>
2.3 JSON響應示例
HTTP/1.1 200 OK Content-Length:586 {"statusCode":"000000","SubAccount":{"subAccountSid":"abcdefghijklmnopqrstuvwxyz123456","subToken":"666961bb08a14f568d42176fe571234", "dateCreated":"2013-09-27 11:42:24","voipAccount":"80000123456789","voipPwd":" xRkazyz3"}}