查看公司白名单联系人列表
1. 接口描述
接口名称:
/eventopenapi/mcenter/whitelist/contacts/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
groupId | Long | 否 | 分组ID |
page | Int | 否 | 显示的页数(默认值1) |
pageSize | Int | 否 | 每页的记录数(默认值 10) |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Array | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
customerCode | String | 客户编码 |
namespaceId | Long | 白名单名称ID |
groupId | Long | 分组ID |
groupIds | Array | 分组ID列表(当联系人属于多个分组时) |
groupName | String | 分组名称 |
contactId | Long | 白名单联系人ID |
name | String | 名称 |
company | String | 公司名称 |
String | 邮箱 | |
mobile | Json | 电话信息 |
namespace_id | Long | 白名单名称ID |
group_id | Long | 分组ID |
group_name | String | 分组名称 |
contact_id | Long | 白名单联系人ID |
mobile 参数说明
参数 | 类型 | 说明 |
---|---|---|
country_code | String | 国家码 |
phone_number | String | 电话号码 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"groupId": null,
"page": 1,
"pageSize": 10
}
输出示例
{
"timeStamp": 1680228990418,
"code": 200,
"msg": "Successfully to get the company whitelist contacts!",
"data": [
{
"contactId": 17230225,
"group_name": "G1",
"groupId": 12275037,
"mobile": {
"country_code": "86",
"phone_number": "18182656375"
},
"customerCode": "154327",
"contact_id": 17230225,
"groupName": "G1",
"namespace_id": 76432,
"namespaceId": 76432,
"group_id": 12275037,
"groupIds": [
12275037
],
"name": "白名单用户-3",
"company": "全时科技",
"email": "user3@quanshi.com"
},
{
"contactId": 17230224,
"group_name": "G1",
"groupId": 12275037,
"mobile": {
"country_code": "",
"phone_number": ""
},
"customerCode": "154327",
"contact_id": 17230224,
"groupName": "G1",
"namespace_id": 76432,
"namespaceId": 76432,
"group_id": 12275037,
"groupIds": [
12275037
],
"name": "白名单用户-2",
"company": "全时科技",
"email": "user2@quanshi.com"
},
{
"contactId": 17230223,
"group_name": "G1",
"groupId": 12275037,
"mobile": {
"country_code": "",
"phone_number": ""
},
"customerCode": "154327",
"contact_id": 17230223,
"groupName": "G1",
"namespace_id": 76432,
"namespaceId": 76432,
"group_id": 12275037,
"groupIds": [
12275037
],
"name": "白名单用户-1",
"company": "全时科技",
"email": "user1@quanshi.com"
},
{
"contactId": 17230167,
"group_name": "group-1",
"groupId": 12274988,
"mobile": {
"country_code": "86",
"phone_number": "19856745655"
},
"customerCode": "154327",
"contact_id": 17230167,
"groupName": "group-1",
"namespace_id": 76432,
"namespaceId": 76432,
"group_id": 12274988,
"groupIds": [
12274988
],
"name": "xiuyue",
"company": "quanshi.com",
"email": ""
}
],
"requestId": "172.10.85.75_20230331_101629_1680228989478"
}