联系组API

概述

在 EffiLink 中添加、搜索与删除联系人名单。将联系人组织为静态或动态分组，并分页浏览你的所有名单。

添加组

POST /v5/lists/add 创建一个带可选描述的新联系人组。

请求体

string

必填

新联系人组的唯一名称。

string

对组用途或受众的简短描述。

boolean

为 true 时,操作被模拟且不创建任何组。

响应

int

成功时为 200。

string

成功时为空字符串;失败时为错误描述。

curl --request POST \
  --url https://api.effilink.co/v5/lists/add \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "listName": "VIP Customers",
    "listDescription": "High-value customer segment"
  }'

Response

{
  "code": 200,
  "message": ""
}

获取组

POST /v5/lists/get 返回属于您账户的分页、可选过滤的联系人组集合。

请求体

string

按名称过滤组。返回名称包含此字符串的所有组。

string

按组类型过滤:

"0" — 动态组(基于规则的成员资格)。
"1" — 静态组(手动管理的成员资格)。

string

结果的排序字段。可接受值:

"CreateDate" — 按创建日期排序。
"ModifyDate" — 按最后修改日期排序。

int

每页返回的组数。默认为 10。

int

从 1 开始的页码。默认为 1。

响应

int

成功时为 200。

string

成功时为空字符串;失败时为错误描述。

array[object]

匹配查询的组记录数组。

显示 list 对象

string

组的唯一标识符。

string

拥有组的团队标识符。

string

组名称。

int

组的当前状态(例如 1 = 活跃)。

int

0 表示动态组;1 表示静态组。

string

动态组的过滤条件。存在于动态组(ListType: 0);静态组为空或缺失。

int

创建组的用户 ID。

string

组创建时间的 ISO 8601 时间戳。

string

组最近一次更新的 ISO 8601 时间戳。

int

跨所有页面匹配查询的组总数。

curl --request POST \
  --url https://api.effilink.co/v5/lists/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "search": "VIP",
    "pageSize": 20,
    "pageIndex": 1
  }'

Response

{
  "code": 200,
  "message": "",
  "lists": [
    {
      "Id": "abc123",
      "TeamId": "team001",
      "listName": "VIP Customers",
      "ListStatus": 1,
      "ListType": 1,
      "CreateUserId": 42,
      "CreateDate": "2024-01-15T08:00:00.000Z",
      "ModifyDate": "2025-03-10T14:30:00.000Z"
    }
  ],
  "totalRecords": 1
}

删除组

POST /v5/lists/delete 按名称永久删除联系人组。组中的联系人不会被删除,仅移除组本身。

请求体

string

必填

要删除的联系人组名称。

boolean

为 true 时,操作被模拟且不删除任何组。

响应

int

成功时为 200。

string

成功时为空字符串;失败时为错误描述。

Response

{
  "code": 200,
  "message": ""
}

事务性邮件

营销邮件

短信

联系人与名单

Webhooks

身份验证

概述

添加组

请求体

响应

获取组

请求体

响应

删除组

请求体

响应

​概述

​添加组

​请求体

​响应

​获取组

​请求体

​响应

​删除组

​请求体

​响应

概述

添加组

请求体

响应

获取组

请求体

响应

删除组

请求体

响应