查看公司白名单分组列表
1. 接口描述
接口名称:
/eventopenapi/mcenter/whitelist/groups/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
groupIds | Array | 否 | 白名单分组列表 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
namespaceId | Long | 白名单名称ID |
groupId | Long | 分组ID |
groupType | Int | 分组类型 |
name | String | 分组名称 |
labelId | String | 标签ID |
contactsNum | Int | 联系人数量 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b"
"groupIds": null
}
输出示例
{
"timeStamp": 1642324815531,
"code": 200,
"msg": "Successfully to get the company whitelist groups!",
"data": [
{
"groupType": 1,
"labelId": "",
"namespaceId": 71473,
"groupId": 12270693,
"name": "G1",
"contactsNum": 4
},
{
"groupType": 1,
"labelId": "labelId-1",
"namespaceId": 71473,
"groupId": 12271201,
"name": "group-1",
"contactsNum": 0
},
{
"groupType": 1,
"labelId": "labelId-2",
"namespaceId": 71473,
"groupId": 12271202,
"name": "group-2",
"contactsNum": 0
}
],
"requestId": "10.255.0.106_20220116_172015_1642324815394"
}