开放平台

获取子账号列表

POST

https://saas-open.vhall.com/v3/users/child/get-list

调用频率限制:
单用户请求频率限制为 120 次/分钟，如果频率超出限制，请参调用频率说明

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://saas-open.vhall.com/v3/users/child/get-list' \
--header 'platform: 15' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'pos=' \
--data-urlencode 'limit=' \
--data-urlencode 'keyword=' \
--data-urlencode 'role_id=1' \
--data-urlencode 'app_key=' \
--data-urlencode 'sign_type=' \
--data-urlencode 'signed_at=' \
--data-urlencode 'sign='

响应示例

{
    "code": 0,
    "msg": "string",
    "data": {
        "total": 0,
        "list": [
            {
                "child_id": 0,
                "parent_id": 0,
                "nick_name": "string",
                "phone": "string",
                "role_name": "string",
                "role_id": 0,
                "email": "string",
                "is_dynamic": 0,
                "vip_info": {
                    "type": 0,
                    "total": 0,
                    "total_flow": 0,
                    "end_time": "string",
                    "extend_day": 0,
                    "total_duration": 0,
                    "duration": 0,
                    "total_sms": 0,
                    "sms": 0
                }
            }
        ]
    }
}

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

platform

integer

可选

默认值:

Body 参数application/x-www-form-urlencoded

pos

string

必需

获取条目节点 eg : 10 从第10条开始查询

limit

string

必需

每次返回条数,最大500

keyword

string

可选

子账号：ID、昵称、手机号

role_id

string

可选

示例值:

app_key

string

必需

平台分配的APP KEY

默认值:

sign_type

integer

必需

签名类型 : 0=MD5,1=RSA,2=SHA256,3=SM3

默认值:

signed_at

integer

必需

签名时间戳 , 当前 UNIX 时间戳，单位为秒。注意：与服务器时间差不得超过5秒

默认值:

sign

string

计算生成的签名值

必需

默认值:

返回响应

🟢200成功

application/json

Body

code

integer

必需

返回结果的状态码（200 成功)

msg

string

必需

当返回结果的状态码不为200时，包含的错误信息

data

object

数据

必需

total

integer

总数

必需

list

array [object {9}]

子账号列表信息

必需

修改于 2025-06-09 14:10:34

获取子账号个数

获取子账号详情