申请导出用户数据

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Authorization

string

必需

Body 参数application/json

reason

string

申请理由

可选

filter

object (用户filter)

过滤条件

可选

client

array[string]

注册客户端

可选

userGuid

array[string]

用户GUID

可选

userName

array[string]

用户名

可选

email

array[string]

邮箱

可选

phone

array[string]

手机

可选

hasEmail

boolean

是否已绑定邮箱

可选

hasPhone

boolean

是否已绑定手机

可选

accountState

array[string]

帐号状态

可选

external

array[string]

第三方

可选

createBefore

string

在此时间之前注册

可选

createAfter

string

在此时间之前注册后

可选

lastLoginBefore

string

在此时间之前最后一次登录

可选

lastLoginAfter

string

在此时间之后最后一次登录

可选

示例

{
    "reason": "string",
    "filter": {
        "client": [
            "string"
        ],
        "userGuid": [
            "string"
        ],
        "userName": [
            "string"
        ],
        "email": [
            "string"
        ],
        "phone": [
            "string"
        ],
        "hasEmail": true,
        "hasPhone": true,
        "accountState": [
            "string"
        ],
        "external": [
            "string"
        ],
        "createBefore": "string",
        "createAfter": "string",
        "lastLoginBefore": "string",
        "lastLoginAfter": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://accounts.zwsoft.cn/api/v1.0/manage/users/export' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "string",
    "filter": {
        "client": [
            "string"
        ],
        "userGuid": [
            "string"
        ],
        "userName": [
            "string"
        ],
        "email": [
            "string"
        ],
        "phone": [
            "string"
        ],
        "hasEmail": true,
        "hasPhone": true,
        "accountState": [
            "string"
        ],
        "external": [
            "string"
        ],
        "createBefore": "string",
        "createAfter": "string",
        "lastLoginBefore": "string",
        "lastLoginAfter": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

status

integer

返回码

必需

详情请查看全局返回码

message

string

错误详细信息

必需

无错误时，返回：success

error

string | null

错误代号

必需

详情请查看全局返回码

data

array[object (数据导出申请) {7}]

必需

guid

string

申请Guid

必需

state

string

状态

必需

生成中(processing)；可下载(downloadable)；已取消(cancel)；已过期(expired)

createTime

string

申请时间

必需

updateTime

string

更新时间

必需

downloadNum

integer

下载次数

必需

creator

object

申请人信息

必需

filter

过滤条件

必需

示例

{
    "status": 0,
    "message": "success",
    "error": null,
    "data": [
        {
            "guid": "a5f1321b-8c67-4e22-90a8-74bcbca38d46",
            "downloadNum": 1,
            "state": "downloadable",
            "reason": "吖",
            "creator": {
                "displayName": "177****1211",
                "email": "2420741283@qq.com",
                "guid": "3da33ecf-95e3-4034-820e-5f93943948e4",
                "phone": "17724251211"
            },
            "filter": {
                "hasEmail": null,
                "hasPhone": false,
                "userGuid": [],
                "client": [],
                "userName": [],
                "email": [],
                "phone": [],
                "external": [],
                "accountState": [],
                "createBefore": null,
                "createAfter": null,
                "lastLoginBefore": null,
                "lastLoginAfter": null
            },
            "createTime": "2022-11-02T02:53:45.000Z",
            "updateTime": "2022-11-02T02:54:20.000Z",
            "history": [
                {
                    "userDisplayName": "177****1211",
                    "email": "2420741283@qq.com",
                    "reason": "环境",
                    "result": null,
                    "downloadTime": "2022-11-02T06:29:42.476Z"
                }
            ]
        }
    ]
}