列出平台认证用户

调用参数:

  • function: list_users
  • params:
    • service_code 被列出用户所属服务码
    • id 被更新用户id 数值类型
    • fields 列出的字段列表,用,分隔, 支持的字段见下表
    • page_index 数据段号
    • per_page 每个数据段包含的记录数

可用字段表如下:

id 记录iD
user_name 用户名
service_code 用户对应的服务码
output_formats 用户对应的视频输出格式配置
disabled true/false 是否禁用此用户,禁用后虽然用户数据未删除也会登录失败

以下是一个调用示例:

{
    "function": "list_users",
    "params": {
        "service_code": "TESTING",
        "fields": "id, service_code, user_name",
        "page_index": 0,
        "per_page": 5
    }
}

上述请求参数表示: 查询服务码为TESTING的用户,获取第0页数据,每页5条记录,记录按ID逆序排列。

返回:

  • ret 0 表示成功,非0失败。错误代码参考API返回代码表
  • list 数据集
    • id 用户id
    • service_code 服务码
    • user_name 用户名

返回示例如下:

{
    "ret": 0,
    "list": [
        {
            "id": 29,
            "service_code": "TESTING",
            "user_name": "101" 
        },
        {
            "id": 2,
            "service_code": "TESTING",
            "user_name": "002" 
        },
        {
            "id": 1,
            "service_code": "TESTING",
            "user_name": "001" 
        }
    ]
}

返回管理类API列表