云直播公司白名单管理
云直播公司白名单管理接口,主要为用户提供白名单管理功能。包括
- 公司级白名单导入、新增、修改与删除
- 支持同步、异步导入公司白名单
- 支持全量、增量导入公司白名单
- 支持实时查看导入状态
创建公司白名单
1. 接口描述
接口名称:
/eventopenapi/mcenter/whitelist/add
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
groupId | Long | 是 | 分组ID |
name | String | 是 | 名称 |
company | String | 否 | 公司名称 |
mobile | String | 否 | 电话信息(电话信息和邮箱至少二选一) |
String | 否 | 邮箱 |
mobile 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
country_code | String | 否 | 国家码 |
phone_number | String | 是 | 电话号码 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
contact_id | Long | 白名单ID |
customer_code | String | 客户编码 |
group_id | Long | 分组ID |
group_name | String | 分组名称 |
name | String | 姓名 |
company | String | 公司 |
mobile | Json | 电话信息 |
String | 邮箱 | |
update_time | Long | 更新时间(没有更新时返回null) |
mobile 参数说明
参数 | 类型 | 说明 |
---|---|---|
country_code | String | 国家码 |
phone_number | String | 电话号码 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"groupId": 12208065,
"name": "name9-1",
"mobile": {
"country_code": "029",
"phone_number": "1600000092"
},
"company": "quanshi.com",
"email": "name9-1@quanshi.com"
}
输出示例
{
"timeStamp": 1642324815531,
"code": 200,
"msg": "Successfully to create the company whitelist!",
"data": {
"contact_id": 13622233,
"customer_code": "153857",
"group_id": 12208065,
"group_name": null,
"name": "name9-1",
"company": "quanshi.com",
"mobile": {
"country_code": "029",
"phone_number": "1600000092"
},
"email": "name9-1@quanshi.com",
"update_time": null
},
"requestId": "10.255.0.106_20220116_172015_1642324815394"
}