AppPush
WebPush
WhatsApp
Email
SMS
OTP
API_USER
最新更新：2023-03-14
API_USER 是用户在 EngageLab 中发信的验证帐号。
你可以使用 API 进行 API_USER 的查询, 添加操作。
查询 ( 批量查询 )
通过此接口查询 API_USER 的基本信息
URL
https://email.api.engagelab.cc/v1/api_users
https://email.api.engagelab.cc/v1/api_users
此代码块在浮窗中显示
HTTP 请求方式
GET
GET
此代码块在浮窗中显示
请求 Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Query 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| email_type | int | 否 | API_USER 的邮件类型: 0(触发), 1(批量) |
| api_user_type | int | 否 | API_USER 的类型: 0(测试), 1(普通) |
| domain_name | string | 否 | API_USER 绑定的域名名称 |
请求示例
curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| api_user | API_USER 名称 |
| api_user_type | API_USER 类型 |
| email_type | API_USER 的邮件类型 |
| domain_name | API_USER 绑定的域名 |
| click_tracking | 是否开启点击追踪: false(关闭), true(开启) |
| open_tracking | 是否开启阅读追踪: false(关闭), true(开启) |
| unsubscribe_tracking | 是否开启取消订阅: false(关闭), true(开启) |
响应示例
Response-success
HTTP Status: 200
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": false
}
],
"count": 85
}
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": false
}
],
"count": 85
}
此代码块在浮窗中显示
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代码块在浮窗中显示
添加
通过此接口添加 API_USER
URL
https://email.api.engagelab.cc/v1/api_users
https://email.api.engagelab.cc/v1/api_users
此代码块在浮窗中显示
HTTP 请求方式
POST
POST
此代码块在浮窗中显示
请求 Headers
| Header | 类型 | 必须 | 说明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
Body 参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| api_user | string | 是 | API_USER 的名称。1~64个字符，只能含有A-Z,a-z,0-9,_,@,-。 |
| email_type | int | 是 | API_USER 的邮件类型: 0(触发), 1(批量) |
| domain_name | string | 是 | API_USER 绑定的域名名称 |
| track_domain_name | string | 否 | API_USER 绑定的追踪域名 |
| click_tracking | boolean | 否 | 是否开启阅读追踪: false(关闭), true(开启). 默认: false |
| open_tracking | boolean | 否 | 是否开启点击追踪: false(关闭), true(开启). 默认:false |
| unsubscribe_tracking | boolean | 否 | 是否开启取消订阅: false(关闭), true(开启). 默认: true |
说明:
取消订阅追踪(unsubscirbe)， 系统对于 免费用户 会强制开启。
请求示例
curl -X POST "https://email.api.engagelab.cc/v1/api_users"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"api_user":"batch_edm",
"email_type":1,
"domain_name":"aizl.net"
}'
curl -X POST "https://email.api.engagelab.cc/v1/api_users"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"api_user":"batch_edm",
"email_type":1,
"domain_name":"aizl.net"
}'
此代码块在浮窗中显示
响应说明
| 字段 | 说明 |
|---|---|
| api_user | API_USER 名称 |
| api_user_type | API_USER 类型 |
| email_type | API_USER 的邮件类型 |
| domain_name | API_USER 绑定的域名 |
| click_tracking | 是否开启点击追踪 |
| open_tracking | 是否开启阅读追踪 |
| unsubscribe_tracking | 是否开启取消订阅 |
响应示例
Response-success
HTTP Status: 200
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": true
}
],
"count": 89
}
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": true
}
],
"count": 89
}
此代码块在浮窗中显示
Response-error
HTTP Status :400
{
"code": 31110,
"message": "api_user cannot be empty."
}
{
"code": 31110,
"message": "api_user cannot be empty."
}
此代码块在浮窗中显示
