查询子账户接口

更新时间：2023-01-12

1.功能说明

1.1.通过该接口可以查询子账户的相关信息，如：姓名/公司名称、手机号码、appkey、appsecret、短信余额、短信消耗、状态等；
1.2.接口调用地址：http(s)://api.guoyangyun.com/api/user/searchAccount.htm
1.4.请求方式：以HTTP POST请求的方式（推荐使用post方式）。
1.5.汉字字符集：UTF-8，请注意参数的大小写。

2.输入参数

参数	名称	类型	必须	描述
公共参数	公共参数	—	是	详见《公共参数和配置》文档
username	子账户名	String	否	要查询的子账户登录名，为空则查询全部子账户。

3.调用示例

http(s)://api.guoyangyun.com/api/user/searchAccount.htm?appkey=XXXXX&appsecret=XXXXX&username=guoyang001

4.Json返回

4.1.返回参数

参数	名称	类型	描述
code	返回码	String	提交返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》）
msg	信息描述	String	返回码对应的中文描述。
data	账户信息	List	返回该账户的基本信息，以及已开通的产品信息
created	创建时间	String	账户的创建时间
modified	修改时间	String	账户最近一次修改时间
primaryName	主账户名	String	主账户的登录名称
username	账户名称	String	账户登录名称
mobile	手机号码	String	账户绑定的手机号码
corp	姓名/公司名称	String	账户姓名或者公司名称
appkey	账户唯一标识	String	开户时系统自动分配
appsecret	账户密钥	String	开户时系统自动分配
status	账户状态	String	账户当前状态{01=正常、02=冻结、03=禁用}
productList	已开通产品信息	List	返回该账户已开通的产品信息
instanceId	产品账户ID	String	产品账户的唯一ID，系统自动分配
productName	产品账户名称	String	产品账户中文名称
status	产品账户状态	String	产品账户当前状态{01=正常、02=冻结、03=禁用}
presentBalance	产品账户余额	String	产品账户剩余量
totalUsed	产品账户已用量	String	产品账户累计消耗用量

4.2.调用成功样例

{
    "code":"0",
    "msg":"成功",
    "data":[
        {
            "created":"2019-09-25 16:00:26",
            "modified":"2023-06-19 10:13:24",
            "primaryName":"a123456",           //主账户名
            "username":"test11",               //子账户名
            "mobile":null,
            "corp":"123",
            "appkey":"8771711500303127746",
            "appsecret":"d3113d7858d1b6b00f",
            "status":"01",                     //账户状态：{01=正常、02=冻结、03=禁用}
            "productList":[
                {
                    "productName":"行业短信",    //产品账户名称
                    "presentBalance":364,      //产品账户余额
                    "totalUsed":69,            //产品账户累计消耗
                    "instanceId":"531241234",  //产品账户ID
                    "status":01                //产品账户状态：{01=正常、02=冻结、03=禁用}
                },
                {
                    "productName":"营销短信",
                    "presentBalance":224,
                    "totalUsed":23,
                    "instanceId":"431242155",
                    "status":"01"
                }
            ]
        }
    ]
}

4.3.调用失败样例

{
    "code":"XXXX",
    "msg":"错误提示内容"
}

results matching ""

No results matching ""