用户 API

简述

开发者可以通过开放接口实现特定功能需求。
说明：用户API涉及的功能为 VIP 功能，若须使用请点击右侧“技术咨询”了解详情。

【用户】外部用户导入

开发者可以通过外部用户数据导入接口导入自己感兴趣的用户id列表，用于后续在运营工具作为人群圈人、洞察的分析对象。

接口定义

• 接口地址: $BaseUrl/import/user/id
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

body参数说明

• 入参字段定义

• 入参示例

{
  "idType": "mobile_md5",
  "idList": [
    "md5($mobile_md5)"
    // 32位小写
  ]
}

Response响应说明

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "msg": "成功",
  // 响应信息
  "code": 0
  // 响应code码
}

请求示例

curl $BaseUrl/import/user/id \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "idType":"mobile_md5",
    "idList":[
      "md5($mobile_md5)"
    ]
}'

【用户】用户群列表查询

开发者可以通过该接口获取用户群列表信息。

接口定义

• 接口地址: $BaseUrl/export/crowd/exportableCrowdList
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

Response响应说明

• 出参data字段定义

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "data": {
    "list": [
      // 用户群列表
      {
        "crowdId": "crowdId1",
        // 用户群id
        "crowdName": "用户群1"
        // 用户群名称
      }
    ],
    "total": 100
    // 列表数量
  },
  "code": "0",
  // 响应code码
  "msg": "成功"
  // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/exportableCrowdList\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{}'

【用户】创建用户群导出任务

开发者可以通过该接口创建用户群导出任务。

接口定义

• 接口地址: $BaseUrl/export/crowd/createCrowdExportTask
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

body参数说明

• 入参字段定义

• 入参示例

{
  "crowdId": "crowdId1",
  "uidType": "GTCID"
}

Response响应说明

• 出参data字段定义

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "data": {
    "taskId": 1001
    // 任务id
  },
  "code": "0",
  // 响应code码
  "msg": "成功"
  // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/createCrowdExportTask\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "crowdId": "crowdId1",
    "uidType": "GTCID"
}'

【用户】用户群导出任务列表查询

开发者可以通过该接口获取用户群导出任务列表信息。

接口定义

• 接口地址: $BaseUrl/export/crowd/exportCrowdTaskList
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

Response响应说明

• 出参data字段定义

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "data": {
    "list": [
      // 用户群导出任务列表
      {
        "appId": "appId1",
        // 应用id
        "crowdId": "crowdId1",
        // 用户群id
        "taskId": 1001,
        // 任务id
        "uidType": "GTCID",
        // 导出ID类型
        "status": 1,
        // 任务状态,0:执行中、1：成功、2：失败
        "fileIdList": [
          // 文件Id列表，任务状态为成功时返回    
          "9e385078-8210-4ebc-a4fe-e8edde2476eb",
          "9e385078-8210-4ebc-a4fe-e8edde2476ec"
        ]
      }
    ],
    "total": 100
    // 列表数量
  },
  "code": "0",
  // 响应code码
  "msg": "成功"
  // 响应信息
}

• 返回参数data说明

请求示例

curl $BaseUrl/export/crowd/exportCrowdTaskList\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{}'

【用户】用户群单个文件导出

开发者可以通过该接口导出用户群Id数据。

接口定义

• 接口地址: $BaseUrl/export/crowd/exportCrowdSingleFile
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

body参数说明

• 入参字段定义

• 入参示例

{
  "crowdId": "crowdId1",
  "taskId": 1001,
  "fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}

Response响应说明

• 出参data字段定义

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "data": {
    "list": [
      // id列表
      "gtcid1",
      "gtcid2"
    ],
    "total": 10000000
    // id数量
  },
  "code": "0",
  // 响应code码
  "msg": "成功"
  // 响应信息
}

请求示例

curl $BaseUrl/export/crowd/exportCrowdSingleFile\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
    "crowdId": "crowdId1",
    "taskId": 1001,
      "fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}'