退会
ユーザーがメールの配信停止を選択すると、そのメールアドレスはこのリストに追加されます。
このリストに含まれるメールアドレスには、今後メールが送信されません。
このリストに対して、クエリ、削除、またはエントリの追加を行うことができます。
クエリ
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | はい | Basic base64(api_user:api_key) |
クエリパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| start_date | string | * | 開始日 (形式: yyyy-MM-dd) |
| end_date | string | * | 終了日 (形式: yyyy-MM-dd) |
| string | * | メールアドレス, 例: 22@gmail.com |
|
| api_user | string | いいえ | 指定されたAPIユーザー、デフォルトはall |
| offset | int | いいえ | 開始位置 [0-], デフォルトは0 |
| limit | int | いいえ | 数量 [0-100], デフォルトは100 |
注意:
- クエリ期間は3か月を超えることはできません。
- 特定のメールアドレスで検索する場合、時間範囲パラメータは無視されます。
リクエスト例:
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| パラメータ | 説明 |
|---|---|
| メールアドレス | |
| api_user | APIユーザー |
| type | 配信停止の種類 (0, 1, 2, 3) |
| unsubscribe_time | 配信停止が発生した時間 |
| expire_time | 配信停止ブロックの有効期限 |
| 種類 | 説明 |
|---|---|
| 0 | このようなメールを受け取りたくない |
| 1 | これは自分が登録したものではない |
| 2 | これはスパムです |
| 3 | これは詐欺メールであり、報告したい |
レスポンス例:
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
追加
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type:
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | はい | Basic base64(api_user:api_key) |
リクエストボディパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| string | はい | 追加するメールアドレス | |
| expire_time | string | はい | 配信停止ブロックの有効期限 (形式: yyyy-MM-dd) |
リクエスト例:
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| パラメータ | 説明 |
|---|---|
| メールアドレス | |
| api_user | API_USER |
| unsubscribe_time | 配信停止時間 |
| expire_time | 有効期限 |
レスポンス例:
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
このコードブロックはフローティングウィンドウ内に表示されます
削除
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
DELETE
DELETE
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | はい | Basic base64(api_user:api_key) |
リクエストボディパラメータの説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| string | * | 削除するメールアドレス | |
| start_date | string | * | 開始日 (形式: yyyy-MM-dd) |
| end_date | string | * | 終了日 (形式: yyyy-MM-dd) |
リクエスト例:
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| パラメータ | 説明 |
|---|---|
| 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."
}
このコードブロックはフローティングウィンドウ内に表示されます
