AppPush
WebPush
WhatsApp
Email
SMS
OTP
邮件标签
最新更新：2023-03-14
标签为用户发送邮件提供了另一个维度的统计方式。
你可以使用 API 对标签进行查询，添加，删除，修改操作。
查询 ( 批量查询 )
返回标签的列表信息
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
此代码块在浮窗中显示
HTTP 请求方式
GET
GET
此代码块在浮窗中显示
请求 Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Query 请求参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| offset | int | 否 | 查询起始位置，取值区间 [0-], 默认为 0 |
| limit | int | 否 | 查询个数，取值区间 [0-100], 默认为 100 |
| label_name | string | 否 | 模糊查询 |
请求示例
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| label_id | 标签 ID |
| label_name | 标签名称 |
| create_time | 标签创建时间 |
| update_time | 标签修改时间 |
响应示例
Response-success
HTTP Status: 200
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
]
}
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
]
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
此代码块在浮窗中显示
查询
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_id}
此代码块在浮窗中显示
HTTP 请求方式
GET
GET
此代码块在浮窗中显示
请求 Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
请求示例
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| label_id | 标签 ID |
| label_name | 标签名称 |
| create_time | 标签创建时间 |
| update_time | 标签修改时间 |
响应示例
Response-success
HTTP Status: 200
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao"
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao"
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
此代码块在浮窗中显示
添加
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
此代码块在浮窗中显示
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 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| label_name | string | 是 | 需要添加的标签名称。最长 64 个字符。 |
说明： label 创建限制上限为 10 万个
请求示例
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"beijing user",
}'
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"beijing user",
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| label_id | 标签 ID |
| label_name | 标签名称 |
| create_time | 创建时间 |
| update_time | 更新时间 |
响应示例
Response-success
HTTP Status: 200
{
"result": {
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:34+0800",
"update_time": "2022-11-14T14:27:34+0800"
}
}
{
"result": {
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:34+0800",
"update_time": "2022-11-14T14:27:34+0800"
}
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
此代码块在浮窗中显示
删除
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_id}
此代码块在浮窗中显示
HTTP 请求方式
DELETE
DELETE
此代码块在浮窗中显示
请求 Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
请求示例
curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122"
--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": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
此代码块在浮窗中显示
修改
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_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 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| label_name | string | 是 | 新的标签名称。最长 64 个字符。 |
请求示例
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel",
}'
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel",
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| count | 修改成功的个数 |
响应示例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
此代码块在浮窗中显示
