======1.Client帐号管理======
----
帐号管理主要提供给开发者用于关联自己的帐号体系到云之讯平台,并且对云之讯平台的帐号进行管理,帐号操作管理主要包括:创建帐号、释放帐号、根据手机查询帐号、查询帐号信息。
===== 1.1创建帐号 =====
通过HTTPS POST方式提交请求,云之讯融合通讯开放平台收到请求后,创建Client帐号与开发者提供的用户注册帐号关联。\\
**请求**
/{SoftVersion}/Accounts/{accountSid}/Clients
**请求包头**
详情请查阅统一请求包头,并使用开发者账号进行验证。
**请求包体**
^属性 ^类型 ^约束 ^说明 |
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一。|
|friendlyName |String |可选 |开发者应用下注册用户对应的昵称,数字、字母(区分大小写)、下划线组成,最长50位|
|mobile |String |可选 |绑定的手机号码,同一个应用内唯一。|
**XML请求示例:**
POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Clients?sig=3C861C9CFA64862A79B906D80EDB79BA
Host: api.ucpaas.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzE2MzI=
e462aba25bc6498fa5ada7eefe1401b7
123867124912354679
97854038
18612345678
**JSON请求示例:**
POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Clients?sig=027282406B5E0E66F4EFE2A86B7A60F7
Host: api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzMwMzg=
{
"client" : {
"appId" : "e462aba25bc6498fa5ada7eefe1401b7",
"userId" : "123867124912354679",
"friendlyName" : "76598140",
"mobile" : "18612345678"
}
}
**响应**
**响应包体**
^属性 ^类型 ^约束 ^说明 |
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明|
|client |String |必选 |client列表,节点的名称|
|clientNumber|String |必选 |UCPaas平台生成的唯一用户id,定长14位数字|
|clientPwd|String |必选 |用户帐号密码,数字和字母混合,定长8位|
|loginToken|String |必选 |UCPaas平台用户令牌|
|createDate|String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一|
**XML响应示例:**
HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
000000
66807000020828
a9316df8
e03bc9106c6ed0eaebfce8c368fdcd48
2015-06-23 17:16:27
123867124912354679
**JSON响应示例:**
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"resp" : {
"respCode" : "000000",
"client" : {
"clientNumber" : 66807000020827,
"clientPwd" : "c4ad7da6",
"loginToken" : "e03bc9106c6ed0eaebfce8c368fdcd48",
"createDate" : "2015-06-23 17:15:04",
"userId" : "123867124912354679"
}
}
}
===== 1.2释放帐号 =====
通过HTTPS POST方式提交请求,云之讯融合通讯开放平台收到请求后,在云之讯平台上释放关闭对应开发者应用下用户的帐号。\\
**请求**
/{SoftVersion}/Accounts/{accountSid}/dropClient
**请求包头**
详情请查阅统一请求包头,并使用开发者账号进行验证。
**请求包体**
^属性 ^类型 ^约束 ^说明 |
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一|
**XML请求示例:**
POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/dropClient?sig=3C861C9CFA64862A79B906D80EDB79BA
Host: api.ucpaas.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzE2MzI=
e462aba25bc6498fa5ada7eefe1401b7
123867124912354679
**JSON请求示例:**
POST/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/dropClient?sig=027282406B5E0E66F4EFE2A86B7A60F7
Host: api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzMwMzg=
{
"client" : {
"appId" : "e462aba25bc6498fa5ada7eefe1401b7",
"userId" : "123867124912354679",
}
}
**响应**
**响应包体**
^属性 ^类型 ^约束 ^说明 |
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明|
**XML响应示例:**
HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
000000
**JSON响应示例:**
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"resp" : {
"respCode" : "000000"
}
}
===== 1.3根据手机号查询子帐号 =====
通过HTTPS GET方式提交请求,云之讯融合通讯开放平台收到请求后,返回开发者应用下与手机号绑定的用户帐号信息\\
**请求**
/{SoftVersion}/Accounts/{accountSid}/ClientsByMobile
**请求包头**
详情请查阅统一请求包头,并使用开发者账号进行验证。
**请求包体**
^属性 ^类型 ^约束 ^说明 |
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度|
|mobile |String |必选 |手机号码|
**XML请求示例:**
GET/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/ClientsByMobile?sig=0E270413B0B038B7AEB6997F510F98EB&mobile=18612345678&appId=e462aba25bc6498fa5ada7eefe1401b7
Host: api.ucpaas.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzE2MzI=
**JSON请求示例:**
GET/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/ClientsByMobile?sig=83D00E8EF62FC601A4035AE7EEF6197F&mobile=18612345678&appId=e462aba25bc6498fa5ada7eefe1401b7
Host: api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzMwMzg=
**响应**
**响应包体**
^属性 ^类型 ^约束 ^说明 |
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明|
|client |String |必选 |client列表,节点的名称|
|friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线组成,最长50位|
|mobile |String |可选 |用户帐号绑定的手机号|
|clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字|
|clientPwd |String |必选 |用户帐号密码,数字和字母混合,定长8位|
|createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss|
|loginToken|String |必选 |UCPaas平台用户令牌|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一|
**XML响应示例:**
HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
000000
/*Client为节点*/
66807000020851
afabcaa9
2015-06-23 18:41:51
71127894
18612345678
e03bc9106c6ed0eaebfce8c368fdcd48
123867124912354679
**JSON响应示例:**
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"resp" : {
"respCode" : "000000",
"client" : {
"clientNumber" : "66807000020851",
"clientPwd" : "afabcaa9",
"createDate" : "2014-06-23 18:41:51",
"friendlyName" : "71127894",
"mobile" : "18612345678",
"loginToken" : "e03bc9106c6ed0eaebfce8c368fdcd48",
"userId" : "123867124912354679"
}
}
}
===== 1.4根据userId查询子帐号 =====
通过HTTPS GET方式提交请求,云之讯融合通讯开放平台收到请求后,返回开发者应用下与UserId绑定的用户帐号信息\\
**请求**
/{SoftVersion}/Accounts/{accountSid}/ClientsByUserId
**请求包头**
详情请查阅统一请求包头,并使用开发者账号进行验证。
**请求包体**
^属性 ^类型 ^约束 ^说明 |
|appId |String |必选 |开发者创建的应用ID,UCpaas平台生成,固定32位长度|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位,应用下唯一|
**XML请求示例:**
GET/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/ClientsByUserId?sig=0E270413B0B038B7AEB6997F510F98EB&userId=18612345678123&appId=e462aba25bc6498fa5ada7eefe1401b7
Host: api.ucpaas.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzE2MzI=
**JSON请求示例:**
GET/2015-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/ClientsByUserId?sig=83D00E8EF62FC601A4035AE7EEF6197F&userId=18612345678123&appId=e462aba25bc6498fa5ada7eefe1401b7
Host: api.ucpaas.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxNzMwMzg=
**响应**
**响应包体**
^属性 ^类型 ^约束 ^说明 |
|respCode |String |必选 |响应状态码,定长6位,取值000000(成功),具体状态码见状态码说明|
|client |String |必选 |client列表,节点的名称|
|friendlyName |String |必选 |开发者应用下用户在UCPaas平台注册的昵称,数字、字母(区分大小写)、下划线注册,最长50位|
|mobile |String |可选 |用户帐号绑定的手机号|
|clientNumber |String |必选 |UCPaas平台生成的唯一用户id,定长14位数字|
|clientPwd |String |必选 |用户帐号密码,数字和字母混合,定长8位|
|createDate |String |必选 |创建日期,格式yyyy-mm-dd hh:mm:ss|
|loginToken|String |必选 |UCPaas平台用户令牌|
|userId |String |必选 |开发者应用下注册用户的ID,数字、字母(区分大小写)组成,最长31位|
**XML响应示例:**
HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
000000
/*Client为节点*/
66807000020851
afabcaa9
2015-06-23 18:41:51
71127894
18612345678
e03bc9106c6ed0eaebfce8c368fdcd48
123867124912354679
**JSON响应示例:**
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"resp" : {
"respCode" : "000000",
"client" : {
"clientNumber" : "66807000020851",
"clientPwd" : "afabcaa9",
"createDate" : "2014-06-23 18:41:51",
"friendlyName" : "71127894",
"mobile" : "18612345678",
"loginToken" : "e03bc9106c6ed0eaebfce8c368fdcd48",
"userId" : "123867124912354679"
}
}
}
===== 1.5SDK2.0升级至3.0注意事项 =====
1. client账号申请的post请求里,版本号为“2014-06-30”,此版本称为”账号体系2014“;版本号为“2015-06-30”,此版本称为”账号体系2015“。\\
2. 账号体系2014在3.0SDK中只能使用明文登录方式,即原有的clientnumber+password方式,无法使用账号体系2014 token方式登录。\\
3. 3.0 SDK版本接口使用的是userid操作风格,2.0 SDK开发者可以沿用之前的client账号,把clientnumber作为userid使用。\\
4. 注意,如果希望同时使用互联网音视频3.0和即时通信(IM)业务,则需要全部使用账号体系2015。\\