简体中文
English
繁體中文
简体中文
にほんご
ภาษาไทย
登录 注册
icon AppPush icon WebPush icon WhatsApp icon Email icon SMS icon OTP
EngageLab 文档 > Email > REST API > 地址列表
EngageLab 文档 > Email > REST API > 地址列表

地址列表

最新更新：2023-03-14

地址列表为用户批量发送时使用。

你可以使用 API 对地址列表进行查询， 添加， 修改， 删除操作。

也可以对地址列表中地址成员进行查询，添加， 修改，删除操作。

查询地址列表 ( 批量查询 )

URL

https://email.api.engagelab.cc/v1/address_lists
          https://email.api.engagelab.cc/v1/address_lists
此代码块在浮窗中显示

HTTP 请求方式

GET
          GET
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Query 参数说明

参数 类型 必须 说明
offset int 否 查询起始位置，取值区间 [0-], 默认为 0。
limit int 否 查询个数，取值区间 [0-100], 默认为 100。
name string 否 列表名称。模糊查询。
address striing 否 别称地址。精确查询。

请求示例

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
          curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
此代码块在浮窗中显示

响应说明

字段 说明
address_list_id 地址列表 id
name 列表名称
address 别称地址，使用该别称地址进行调用，格式为 xxx@maillist.email.engagelab.com。
member_count 地址列表包含的地址个数
desc 地址列表描述
create_time 地址列表创建时间
update_time 地址列表修改时间

响应示例

Response-success

HTTP Status: 200

{ "result": [ { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } ], "total": 1, "count": 1 }
          {
  "result": [
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
        ],
        "total": 1,
        "count": 1
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

查询地址列表

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
此代码块在浮窗中显示

HTTP 请求方式

GET
          GET
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

请求示例

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
address_list_id 地址列表 id
name 列表名称
address 别称地址，使用该别称地址进行调用，格式为 xxx@maillist.email.engagelab.com。
member_count 地址列表包含的地址个数
desc 地址列表描述
create_time 地址列表创建时间
update_time 地址列表修改时间

响应示例

Response-success

HTTP Status: 200

{ "result": { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } }
          {
  "result":
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

添加地址列表

URL

https://email.api.engagelab.cc/v1/address_lists
          https://email.api.engagelab.cc/v1/address_lists
此代码块在浮窗中显示

Content-Type:

application/json; charset=utf-8
          application/json; charset=utf-8
此代码块在浮窗中显示

HTTP 请求方式

POST
          POST
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Body 参数

参数 类型 必须 说明
name string 是 列表名称。最长 48 字符。
address string 是 别称地址。邮箱地址格式，例如：marketing@maillist.email.engagelab.com。
desc string 否 描述信息。最长 255 字符。

请求示例

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@maillist.email.engagelab.com", "name":"Beijing", "desc":"" }'
          curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@maillist.email.engagelab.com",
"name":"Beijing",
"desc":""
}'
此代码块在浮窗中显示

响应说明

字段 说明
address_list_id 列表 id
name 列表名称
address 别称地址
member_count 列表中地址数
desc 列表描述信息
create_time 地址列表创建时间
update_time 地址列表修改时间

响应示例

Response-success

HTTP Status: 200

{ "result": { "address_list_id": 65504, "address": "jg3@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 0, "desc": "desc", "create_time": "2022-11-15T16:25:02+0800", "update_time": "2022-11-15T16:25:02+0800" } }
          
{
     "result": {
            "address_list_id": 65504,
            "address": "jg3@maillist.email.engagelab.com",
            "name": "1113-mailist",
            "member_count": 0,
            "desc": "desc",
            "create_time": "2022-11-15T16:25:02+0800",
            "update_time": "2022-11-15T16:25:02+0800"
        }
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

删除地址列表

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
此代码块在浮窗中显示

HTTP 请求方式

DELETE
          DELETE
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

请求示例

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

参数 说明
count 成功删除的个数

响应示例

Response-success

HTTP Status: 200

{ "count": 1 }
          {
  "count": 1   
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

修改地址列表

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
此代码块在浮窗中显示

HTTP 请求方式

PUT
          PUT
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Body 参数说明

参数 类型 必须 说明
address string 否 别称地址，使用该别称地址进行调用，格式为 xxx@@maillist.email.engagelab.com
name string 否 修改后的列表名称。最长 48 字符。
desc string 否 修改后的列表描述信息。最长 255 字符。

说明

【name】或者【desc】的组合
          【name】或者【desc】的组合
此代码块在浮窗中显示

请求示例

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"new@maillist.email.engagelab.com", "name":"北京用户 2", "desc":"2" }'
          curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"北京用户 2",
"desc":"2"
}'
此代码块在浮窗中显示

响应说明

字段 说明
count 成功修改的个数

响应示例

Response-success

HTTP Status: 200

{ "count": 1 }
           { 
   "count": 1
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

查询列表成员

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
此代码块在浮窗中显示

HTTP 请求方式

GET
          GET
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Query 参数说明

参数 类型 必须 说明
offset int 否 查询起始位置，取值区间 [0-], 默认为 0。
limit int 否 查询个数，取值区间 [0-100], 默认为 100。
email string 否 查询成员邮箱地址。支持模糊搜索。
member_ids string 否 成员 ID 多个用；号分隔。最多 100 个。

请求示例

curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
member_id 成员 ID
email 成员邮箱地址
name 成员姓名
vars 变量
create_time 创建时间
update_time 更新时间

响应示例

Response-success

HTTP Status: 200

{ "result": [ { "member_id": "11719293", "email": "example2@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-13T11:23:44+0800", "update_time": "2022-11-13T11:23:44+0800" }, { "member_id": "11719294", "email": "example5@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-15T16:34:47+0800", "update_time": "2022-11-15T16:34:47+0800" } ], "total": 2, "count": 2, "address_list_id": "65499" }
          {
    "result": [
        {
            "member_id": "11719293",
            "email": "example2@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-13T11:23:44+0800",
            "update_time": "2022-11-13T11:23:44+0800"
        },
        {
            "member_id": "11719294",
            "email": "example5@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-15T16:34:47+0800",
            "update_time": "2022-11-15T16:34:47+0800"
        }
    ],
    "total": 2,
    "count": 2,
    "address_list_id": "65499"
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

添加列表成员

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
此代码块在浮窗中显示

Content-Type:

application/json; charset=utf-8
          application/json; charset=utf-8
此代码块在浮窗中显示

HTTP 请求方式

POST
          POST
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Body 参数说明

参数 类型 必须 说明
members array[object] 是 成员。最多 1000 个成员。
email string 是 成员邮箱地址，邮件地址格式。
name string 否 昵称。最长 128 个字符。
vars object 否 变量。最大不超过 1KB。

说明

1. 添加 vars 变量，注意 key 不需要 带上 '%'，key 长度不得超过 32 个字符。 2. vars 变量中，key 为 name 的变量会被参数 name 覆盖 3. 地址列表发送时，可以使用全局变量 recipient, 值为收件人的邮箱地址
          1. 添加 vars 变量，注意 key 不需要 带上 '%'，key 长度不得超过 32 个字符。
2. vars 变量中，key 为 name 的变量会被参数 name 覆盖
3. 地址列表发送时，可以使用全局变量 recipient, 值为收件人的邮箱地址
此代码块在浮窗中显示

请求示例

curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
          curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
此代码块在浮窗中显示

响应说明

字段 说明
count 添加成功的地址数
invalid 添加失败的地址

响应示例

Response-success

HTTP Status: 200

{ "result": { "count": 1, "invalid": [] } }
          {
    "result": {
        "count": 1,
        "invalid": []
    }
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

修改列表成员

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
          https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
此代码块在浮窗中显示

Content-Type:

application/json; charset=utf-8
          application/json; charset=utf-8
此代码块在浮窗中显示

HTTP 请求方式

PUT
          PUT
此代码块在浮窗中显示

请求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Body 参数说明

参数 类型 必须 说明
member object 是 成员
email string 否 成员邮箱地址，邮件地址格式。
name string 否 昵称。最长 128 个字符。
vars string 否 变量。最大不超过 1KB。key 长度不得超过 32 个字符。

请求示例

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"member":{"email":"x@engagelab.com","name":"jim"}}'
          curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"member":{"email":"x@engagelab.com","name":"jim"}}'
此代码块在浮窗中显示

响应说明

字段 说明
count 成功修改地址数

响应示例

Response-success

HTTP Status: 200

{ "result": { "count": 1 } }
          {
    "result": {
        "count": 1
    }
}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示

删除列表成员

URL

https://email.engagelab.com/v1/address_lists/{address_list_id}/members
          https://email.engagelab.com/v1/address_lists/{address_list_id}/members
此代码块在浮窗中显示

HTTP 请求方式

DELETE
          DELETE
此代码块在浮窗中显示

請求 Headers

Header 类型 必须 说明
Authorization string true Basic base64(api_user:api_key)

Query 参数说明

参数 类型 必须 说明
member_ids string 是 需要删除成员的地址，多个地址用 ; 分隔，最多 100 个成员。

请求示例

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
          curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
count 成功删除地址数

响应示例

Response-success

HTTP Status: 200

{ "count": 1}
           { "count": 1}
此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }
          { 
    "code": 30000,
    "message": "Unauthorized."
}
此代码块在浮窗中显示
在文档中心打开