跳到主要内容
版本:3.3-SNAPSHOT

人群接口

人群开放接口

3.1、查询分群列表

请求方式:POST

请求URL:/cdp-label-open-hh/oapi/v1/audience/page

请求示例:

{
"audienceName": "",
"cdpUserName": "",
"pageQueryParam": {
"ascs": [],
"descs": [],
"pageNo": 1,
"size": 10
}
}

请求参数:

参数名称参数说明是否必填数据类型
audienceName人群名称falseString
cdpUserName人群创建人falseString
ascs升序字段集合falsearray
descs降序字段集合falsearray
pageNo页码falseinteger(int32)
size每页显示条数falseinteger(int32)
Ø 响应示例:
{
"data": {
"current": 1,
"total": 27,
"size": 10,
"lastPageNo": 0,
"list": [
{
"audienceId": 1,
"audienceName": "人群测试1",
"comment": "测试1",
"createTime": "2022-07-02 15:20:59",
"updateTime": "2022-07-07 15:21:04",
"userCount": 1900,
"predictUserCount": 160,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 2,
"audienceName": "人群测试2",
"comment": "测试2",
"createTime": "2022-07-01 15:20:47",
"updateTime": "2022-07-07 15:20:54",
"userCount": 1200,
"predictUserCount": 140,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 3,
"audienceName": "人群测试3",
"comment": "测试3",
"createTime": "2022-07-07 15:20:30",
"updateTime": "2022-07-07 15:20:34",
"userCount": 1400,
"predictUserCount": 160,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 4,
"audienceName": "人群测试4",
"comment": "测试4",
"createTime": "2022-07-06 15:20:38",
"updateTime": "2022-07-07 15:20:41",
"userCount": 1000,
"predictUserCount": 160,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 23,
"audienceName": "test_ge",
"comment": "备注信息",
"createTime": null,
"updateTime": null,
"userCount": null,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 24,
"audienceName": "test_audience_create",
"comment": "备注信息",
"createTime": null,
"updateTime": null,
"userCount": null,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 25,
"audienceName": "81501556",
"comment": null,
"createTime": "2022-08-15 18:44:35",
"updateTime": "2022-08-15 18:44:35",
"userCount": 1,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 26,
"audienceName": "81501292",
"comment": null,
"createTime": "2022-08-15 19:27:43",
"updateTime": "2022-08-15 19:27:43",
"userCount": null,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 27,
"audienceName": "81501568",
"comment": null,
"createTime": "2022-08-15 19:28:10",
"updateTime": "2022-08-15 19:28:10",
"userCount": null,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
},
{
"audienceId": 28,
"audienceName": "81501109",
"comment": null,
"createTime": "2022-08-15 19:28:16",
"updateTime": "2022-08-15 19:28:16",
"userCount": null,
"predictUserCount": null,
"bizWorkspaceId": 1,
"bizWorkspaceName": "BNC"
}
]
},
"success": true,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}

Ø响应参数:

参数名称参数说明数据类型
code错误码string
elapsed请求响应耗时integer(int64)
msg消息提示信息string
requestUrl请求路径string
success操作标识boolean
responseStatus响应状态int
errorDetails错误堆栈信息string
errorMsg错误简短信息string
code错误码string
audienceId人群IDint
audienceName人群名称string
comment备注string
createTime创建时间datetime
updateTime更新时间datetime
userCount人群数量Integer(32)
predictUserCount人群预估数量Integer(32)
bizWorkspaceId业务体系IDInteger(32)
bizWorkspaceName业务体系名称sting

**3.2、**人群下载审批回调接口

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/audience/download/noticeCallback
Ø
Ø 请求示例:
{
"audienceId": 1,
"oaWorkflowRequestId": "122221212",
"oaWorkflowStatus": 2
}

请求参数:

参数名称参数说明是否必填数据类型
audienceId人群IDtrueInteger(32)
oaWorkflowRequestId工作流申请请求ID,调用发起工作流接口时返回,回调时也传递此ID更改状态
truestring
oaWorkflowStatus工作流状态,1:审批中,2:审批成功,3:审批失败
trueInteger(32)
Ø 响应示例:
{
"data": null,
"success": true,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}
Ø 响应参数:
参数名称参数说明数据类型
code错误码string
elapsed请求响应耗时integer(int64)
msg消息提示信息string
requestUrl请求路径string
success操作标识boolean
responseStatus响应状态int
errorDetails错误堆栈信息string
errorMsg错误简短信息string
data返回数据T

3.3、人群推送回调

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/audience/outConfig/noticeCallback
Ø
Ø 请求示例:
{
"outputConfigId": 1,
"callBackStatus": 4
}

请求参数:

参数名称参数说明是否必填数据类型
outputConfigId人群推送IDtrueInteger(32)
callBackStatus人群推送状态,
3:推送中
4:成功
5:失败
trueInteger(32)

Ø 响应示例:

{
"data": null,
"success": true,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}

Ø响应参数:

参数名称参数说明数据类型
code错误码string
elapsed请求响应耗时integer(int64)
msg消息提示信息string
requestUrl请求路径string
success操作标识boolean
responseStatus响应状态int
errorDetails错误堆栈信息string
errorMsg错误简短信息string
data返回数据T