人群接口
人群开放接口
3.1、查询分群列表
请求方式:POST
请求URL:/cdp-label-open-hh/oapi/v1/audience/page
请求示例:
{
"audienceName": "",
"cdpUserName": "",
"pageQueryParam": {
"ascs": [],
"descs": [],
"pageNo": 1,
"size": 10
}
}
请求参数:
| 参数名称 | 参数说明 | 是否必填 | 数据类型 |
|---|---|---|---|
| audienceName | 人群名称 | false | String |
| cdpUserName | 人群创建人 | false | String |
| ascs | 升序字段集合 | false | array |
| descs | 降序字段集合 | false | array |
| pageNo | 页码 | false | integer(int32) |
| size | 每页显示条数 | false | integer(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 | 人群ID | int |
| audienceName | 人群名称 | string |
| comment | 备注 | string |
| createTime | 创建时间 | datetime |
| updateTime | 更新时间 | datetime |
| userCount | 人群数量 | Integer(32) |
| predictUserCount | 人群预估数量 | Integer(32) |
| bizWorkspaceId | 业务体系ID | Integer(32) |
| bizWorkspaceName | 业务体系名称 | sting |
**3.2、**人群下载审批回调接口
Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/audience/download/noticeCallback
Ø
Ø 请求示例:
{
"audienceId": 1,
"oaWorkflowRequestId": "122221212",
"oaWorkflowStatus": 2
}
请求参数:
| 参数名称 | 参数说明 | 是否必填 | 数据类型 |
|---|---|---|---|
| audienceId | 人群ID | true | Integer(32) |
| oaWorkflowRequestId | 工作流申请请求ID,调用发起工作流接口时返回,回调时也传递此ID更改状态 | true | string |
| oaWorkflowStatus | 工作流状态,1:审批中,2:审批成功,3:审批失败 | true | Integer(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 | 人群推送ID | true | Integer(32) |
| callBackStatus | 人群推送状态, 3:推送中 4:成功 5:失败 | true | Integer(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 |