文档首页

新手指南

Rest API

iOS SDK

Android SDK

状态码

常见问题

文档>Client 管理API

Client 管理API

Client在有联云融合通讯开放平台是与开发者的应用绑定的子账号，是平台提供给开发者自行管理其客户的账户，即开发者可以根据创建的子账户管理和区分其应用下的不同客户，这样就可以更加方便，便捷的管理应用下的不同客户。

如果开发者的应用接入使用到平台的资源时，可以根据需求为该应用下的每个客户申请绑定一个Client子账户，这样就可以通过Client子账户进行统一方便管理使用到平台的业务。 例如开发者的应用需要用到平台的语音直拨，语音双向回拨等功能，则需要使用Client管理API，开发者的应用只需要使用到短信通知，短信验证码等直接应用到手机号即可完成的业务功能，可不需要使用Client管理API。

申请Client账号

通过HTTPS POST方式提交请求，有联云融合通讯开放平台收到请求后，返回Client信息。

1.1 请求

请求地址

/Accounts/{accountSid}/Clients/addClient

请求包头

详情请查阅统一请求包头，并使用开发者账号进行验证。

请求包体

属性 类型 约束 说明
appId String 必选 应用Id
clientType String 必选 0 开发者计费；1 云平台计费。默认为0。
charge String 必选 充值金额（开发者计费即ClientType为0时，为可选参数），默认为0。
friendlyName String 必选 是开发者自身平台注册用户的的唯一标记 。
mobile String 可选 绑定的手机号码。同一个应用内唯一。

XML请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/addClient.xml?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<appId>950a97bce77b885b747536a1e3887465</appId>
<friendlyName>97854038</friendlyName>
<clientType>1</clientType>
<charge>1</charge>
<mobile>18612345678</mobile>

JSON请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/addClient?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=
{
    "friendlyName" : "76598140",
    "appId"        : "950a97bce77b885b747536a1e3887465",
    "charge"       : "1",
    "mobile"       : "18612345678",
    "clientType"   : "1"
}

1.2 响应

属性 类型 约束 说明
respCode String 必选 请求状态码，取值200（成功）
clientNumber String 必选 Client号码。由16位数字组成
clientPwd String 必选 Client密码。由8位数字和字母组成
createDate String 必选 Client的创建时间

XML响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<respCode>200</respCode>
<clientNumber>3126276635628412</clientNumber>
<clientPwd>Fuvj2aYO</clientPwd>
<createDate>2015-10-14 11:10:27</createDate>

JSON响应示例

{ 
    "respCode"   : "200",
    "clientNumber" : 3126276635628412,
    "clientPwd"    : "Fuvj2aYO",
    "createDate"   : "2015-10-14 11:10:27"
}

释放Client账号

通过HTTPS POST方式提交请求，有联云融合通讯开放平台收到请求后，返回释放Client的结果。

1.1 请求

请求地址

/Accounts/{accountSid}/Clients/dropClient

请求包头

详情请查阅统一请求包头，并使用开发者账号进行验证。

请求包体

属性 类型 约束 说明
clientNumber String 必选 clientNumber号码
appId String 必选 应用Id

XML请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/dropClient.xml?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<clientNumber>3126276635628412</clientNumber>
<appId>950a97bce77b885b747536a1e3887465</appId>

JSON请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/dropClient?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=
 
{
 "clientNumber" : "3126276635628412",
 "appId"        : "950a97bce77b885b747536a1e3887465"
}

1.2 响应

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码，取值200（成功）

XML响应示例

<?xml version="1.0" encoding="UTF-8"?>
<respCode>200</respCode>

JSON响应示例

{
    "respCode" : "200"
}

分页获取Client列表

通过HTTPS POST方式提交请求，有联云融合通讯开放平台收到请求后根据Client开始序号查询并批量返回Client信息。

1.1 请求

请求地址

/Accounts/{accountSid}/Clients/listClient

请求包头

详情请查阅统一请求包头，并使用开发者账号进行验证。

请求包体

属性 类型 约束 说明
appId String 必选 应用Id
start String 必选 开始的序号，默认从0开始
limit String 必选 一次查询的最大条数，最小是1条，最大是100条

XML请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/listClient.xml?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<appId>950a97bce77b885b747536a1e3887465</appId>
<start>0</start>
<limit>2</limit>

JSON请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/listClient?sig=C80B3CA83E40F3947C41B15BE0523FB2
Host:app.youlianyun.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY= 
{
    "appId"  : "950a97bce77b885b747536a1e3887465",
    "start"  : "0",
    "limit"  : "2"
}

1.2 响应

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码，取值200（成功）
count String 必选 Client的数量
client String 必选 节点的名称
friendlyName String 必选 Client绑定的昵称
clientType String 必选 Client类型（即平台是否对Client计费）
mobile String 必选 Client绑定的手机号码
clientNumber String 必选 Client号码。由16位数字组成
clientPwd String 必选 Client的密码
createDate String 必选 Client的创建时间

XML响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <respCode>200</respCode>
    <count>2</count>
    <client>
        <clientNumber>3126276635628411</clientNumber>
        <clientPwd>Fuvj2aY1</clientPwd>
        <clientType>1</clientType>
        <createDate>2015-10-14 10:28:12</createDate>
        <friendlyName>26928212</friendlyName>
        <mobile>18612345678</mobile>
    </client>
    <client>
        <clientNumber>3126276635628412</clientNumber>
        <clientPwd>Fuvj2aYO</clientPwd>
        <clientType>1</clientType>
        <createDate>2015-10-14 10:30:12</createDate>
        <friendlyName>97854038</friendlyName>
        <mobile>13823501320</mobile>
    </client>

JSON响应示例

{
    "respCode"   : "200",
    "count"      : 2,
    "client"    :  [
    {
        "clientNumber" : 3126276635628411,
        "clientPwd"    : Fuvj2aY1,
        "clientType"   : 1,
        "createDate"   : "2015-10-14 10:28:12",
        "friendlyName" : 26928212,
        "mobile"       : 18612345678
      },
    {
        "clientNumber" : 3126276635628412,
        "clientPwd"    : "Fuvj2aYO",
        "clientType"   : 1,
        "createDate"   : "2015-10-14 10:30:12",
        "friendlyName" : 97854038,
        "mobile"       : 13823501320
      } 
      ] 
}

以Client账号方式查询Client信息

通过HTTPS GET方式提交请求，有联云融合通讯开放平台收到请求后根据Client名称查询并返回Client信息。

1.1 请求

请求地址

/Accounts/{accountSid}/Clients/searchClientAcount

请求包头

详情请查阅统一请求包头，并使用开发者账号进行验证。

属性 类型 约束 说明
appId String 必选 应用Id
clientNumber String 必选 clientNumber号码

XML请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/searchClientAcount.xml?sig=C80B3CA83E40F3947C41B15BE0523FB2&clientNumber=3126276635628412&appId=950a97bce77b885b747536a1e3887465
Host:app.youlianyun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=

JSON请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/searchClientAcount?sig=C80B3CA83E40F3947C41B15BE0523FB2&clientNumber=3126276635628412&appId=950a97bce77b885b747536a1e3887465
Host:app.youlianyun.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=

1.2 响应

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码，取值200（成功）
count String 必选 Client的数量
client String 必选 节点的名称
friendlyName String 必选 Client绑定的昵称
clientType String 必选 Client类型（即平台是否对Client计费）
mobile String 必选 Client绑定的手机号码
clientNumber String 必选 Client号码。由16位数字组成
clientPwd String 必选 Client的密码
createDate String 必选 Client的创建时间

XML响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <respCode>200</respCode>
    <count>1</count>
    <clientNumber>3126276635628412</clientNumber>
    <clientPwd>Fuvj2aYO</clientPwd>
    <clientType>1</clientType>
    <createDate>2015-10-14 12:10:51</createDate>
    <friendlyName>71127112</friendlyName>
    <mobile>18612345693</mobile>

JSON响应示例

{ 
    "respCode"   : "200",
    "count"      : 1,    
    "clientNumber" : 3126276635628412,
    "clientPwd"    : "Fuvj2aYO",
    "clientType"   : 1,
    "createDate"   : "2015-10-14 12:10:51",
    "friendlyName" : 71127828,
    "mobile"       : 18612345123
}

以手机号码方式查询Client信息

通过HTTPS GET方式提交请求，有联云融合通讯开放平台收到请求后根据手机号码查询与该手机号码绑定的Client，并返回Client信息。

1.1 请求

请求地址

/Accounts/{accountSid}/Clients/searchClientMobile

请求包头

详情请查阅统一请求包头，并使用开发者账号进行验证。

请求包体

属性 类型 约束 说明
appId String 必选 应用Id
mobile String 必选 绑定的手机号码。同一个应用内唯一。

XML请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/searchClientMobile.xml?sig=C80B3CA83E40F3947C41B15BE0523FB2&mobile=18612345678&appId=950a97bce77b885b747536a1e3887465
Host:app.youlianyun.com
Accept:application/xml
Content-Type:application/xml;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=

JSON请求示例

/Accounts/1784fd62ae354a1eca54f8b34e5a9baf/Clients/searchClientMobile?sig=C80B3CA83E40F3947C41B15BE0523FB2&mobile=18612345678&appId=950a97bce77b885b747536a1e3887465
Host:app.youlianyun.com
Accept:application/json
Content-Type:application/json;charset=utf-8
Authorization:MTc4NGZkNjJhZTM1NGExZWNhNTRmOGIzNGU1YTliYWY6MjAxNTEwMTMxNjA3NTY=

1.2 响应

响应包体

属性 类型 约束 说明
respCode String 必选 请求状态码，取值200（成功）
count String 必选 Client的数量
client String 必选 节点的名称
friendlyName String 必选 Client绑定的昵称
clientType String 必选 Client类型（即平台是否对Client计费）
mobile String 必选 Client绑定的手机号码
clientNumber String 必选 Client号码。由16位数字组成
clientPwd String 必选 Client的密码
createDate String 必选 Client的创建时间

XML响应示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <respCode>200</respCode>
    <count>1</count>
    <clientNumber>3126276635628412</clientNumber>
    <clientPwd>Fuvj2aYO</clientPwd>
    <clientType>1</clientType>
    <createDate>2015-10-14 11:45:51</createDate>
    <friendlyName>71127123</friendlyName>
    <mobile>18612345612</mobile>

JSON响应示例

{
    "respCode"   : "200",
    "count"      : 1,
    "clientNumber" : 3126276635628412,
    "clientPwd"    : "Fuvj2aYO",
    "clientType"   : 1,
    "createDate"   : "2015-10-14 11:45:51",
    "friendlyName" : 71127123,
    "mobile"       : 18612345612  
  }

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

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