创建公司白名单联系人

1. 接口描述

接口名称:

/eventopenapi/mcenter/whitelist/contacts/add

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
groupId Long 分组ID
name String 名称
company String 公司名称
mobile String 电话信息(电话信息和邮箱至少二选一)
email String 邮箱
forceUpdate Int 是否强制覆盖已有记录信息 0: 否; 1: 是(默认1)

mobile 参数说明

参数 类型 必须 说明
country_code String 国家码
phone_number String 电话号码

3. 输出参数

参数 类型 说明
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)
code Int 返回的状态码
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json 返回数据

data 参数说明

参数 类型 说明
customerCode String 客户编码
namespaceId Long 白名单名称ID
groupId Long 分组ID
groupIds Array 分组ID列表(当联系人属于多个分组时)
groupName String 分组名称
contactId Long 白名单联系人ID
name String 名称
company String 公司名称
email 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": 12208065,
    "name": "name9-1",
    "mobile": {
        "country_code": "029",
        "phone_number": "1600000092"
    },
    "company": "quanshi.com",
    "email": "name9-1@quanshi.com"
}

输出示例

{
    "timeStamp": 1680229251951,
    "code": 200,
    "msg": "Successfully to create the company whitelist contacts!",
    "data": {
        "contactId": 17230167,
        "group_name": "G1",
        "groupId": 12208065,
        "mobile": {
            "country_code": "86",
            "phone_number": "1600000092"
        },
        "customerCode": "154327",
        "contact_id": 17230167,
        "groupName": "G1",
        "namespace_id": 76432,
        "namespaceId": 76432,
        "group_id": 12208065,
        "groupIds": [
            12208065
        ],
        "name": "name9-1",
        "company": "quanshi.com",
        "email": "name9-1@quanshi.com"
    },
    "requestId": "172.10.85.75_20230331_102051_1680229251852"
}