开发者可以通过开放接口实现特定功能需求。
说明:用户API涉及的功能为 VIP 功能,若须使用请点击右侧“技术咨询”了解详情。
开发者可以通过外部用户数据导入接口导入自己感兴趣的用户id列表,用于后续在运营工具作为人群圈人、洞察的分析对象。
Header参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
token | String |
是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
body参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
idType | string |
是 | 无 | id类型,目前支持mobile_md5,imei_md5,oaid_md5,idfa_md5,cid以及gtcid |
idList | List<String> |
是 | 无 | 用户标识id列表,根据id类型分别对应不同的id数据,详见用户id说明,size最大支持200 |
{
"idType": "mobile_md5",
"idList": [
"md5($mobile_md5)"
// 32位小写
]
}
{
"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)"
]
}'
开发者可以通过该接口获取用户群列表信息。
Header参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
token | String |
是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
list | List<Object> |
否 | 无 | 用户群列表,目前最大size=100 |
total | Long |
否 | 无 | 用户群列表数量 |
{
"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 '{}'
开发者可以通过该接口创建用户群导出任务。
Header参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
token | String |
是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
body参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
crowdId | String |
是 | 无 | 用户群id |
uidType | String |
是 | 无 | 导出ID类型,目前支持CID 和GTCID ,大小写敏感。CID 仅在创建用户群时对接推送或文件上传CID 创建用户群时支持 |
{
"crowdId": "crowdId1",
"uidType": "GTCID"
}
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
taskId | Long |
否 | 无 | 任务id |
{
"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"
}'
开发者可以通过该接口获取用户群导出任务列表信息。
Header参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
token | String |
是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
list | List<Object> |
否 | 无 | 用户群导出任务列表 |
total | Long |
否 | 无 | 用户群导出任务列表数量 |
{
"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": "成功"
// 响应信息
}
名称 | 类型 | 描述 |
---|---|---|
$list | List<Object> |
用户群导出任务列表 |
appId | String |
应用id |
crowdId | String |
用户群id |
taskId | Long |
任务id |
uidType | String |
导出ID类型 |
status | Byte |
任务状态,0:执行中、1:成功、2:失败 |
fileIdList | List<String> |
文件Id列表,任务状态为成功时返回。使用fileId导出用户群单个文件,目前最大size=50 |
$total | Long |
列表数量 |
curl $BaseUrl/export/crowd/exportCrowdTaskList\
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{}'
开发者可以通过该接口导出用户群Id数据。
Header参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
token | String |
是 | 无 | 接口访问凭据,获取方式请参考获取鉴权token |
body参数说明
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
crowdId | String |
是 | 无 | 用户群id |
taskId | Long |
是 | 无 | 任务id |
fileId | String |
是 | 无 | 导出文件id |
{
"crowdId": "crowdId1",
"taskId": 1001,
"fileId": "9e385078-8210-4ebc-a4fe-e8edde2476eb"
}
名称 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
list | List<String> |
否 | 无 | id列表,目前最大size=1000000 |
total | Long |
否 | 无 | id列表数量 |
{
"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"
}'
以上文档对您是否有帮助?