送信者管理
送信者の作成
URL
https://email.api.engagelab.cc/v1/marketing/senders
https://email.api.engagelab.cc/v1/marketing/senders
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
from_name | string | true | 送信者名 |
string | true | 送信者アドレス。メール形式である必要があり、ドメインのサフィックスはdomain_nameと一致する必要があります | |
domain_name | string | true | ドメイン(設定済みかつ承認済み) |
api_user | string | true | ApiUser名 |
注意:
- domain_nameとapi_userは対応している必要があります。
リクエスト例
Request-Example
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "126.com",
"api_user": "test_abc"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "126.com",
"api_user": "test_abc"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"result": {
"sender_id": 449,
"name": "Qiaofeng2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
{
"result": {
"sender_id": 449,
"name": "Qiaofeng2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
送信者の削除
URL
https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
DELETE
DELETE
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
リクエスト例
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count":1
}
{
"count":1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
送信者の更新
URL
https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
PUT
PUT
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
from_name | string | false | 送信者名 |
string | false | 送信者アドレス。メール形式である必要があり、ドメインのサフィックスはdomain_nameと一致する必要があります | |
domain_name | string | false | ドメイン(設定済みかつ承認済み) |
api_user | string | false | API_USER名 |
注意:
- from_name、email、domain_name、api_userの値は空文字列またはnull文字ではいけません。
リクエスト例
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "test.com",
"api_user": "test_abc"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "test.com",
"api_user": "test_abc"
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"count":1
}
{
"count":1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: `401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
送信者の詳細
URL
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
リクエスト例
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス例
Response-Success
HttpStatus: 200
{
"result": {
"sender_id": 449,
"name": "乔峰2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
{
"result": {
"sender_id": 449,
"name": "乔峰2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます
送信者リスト
URL
https://email.api.engagelab.cc/v1/marketing/senders
https://email.api.engagelab.cc/v1/marketing/senders
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
クエリパラメーター
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
limit | integer | false | クエリするレコード数。範囲は[1-100]、デフォルトは10 |
offset | integer | false | クエリの開始位置。範囲は[0-]、デフォルトは0 |
リクエスト例
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
パラメーター | タイプ | 説明 |
---|---|---|
list | array[object] | 送信者リスト |
sender_id | integer | 送信者ID |
name | string | 送信者名 |
string | 送信者アドレス | |
domain_id | integer | ドメインID |
domain_name | string | ドメイン名 |
api_user | string | APIUSER名 |
create_time | string | 作成時間 |
update_time | string | 更新時間 |
total | integer | 総レコード数 |
レスポンス例
Response-Success
HttpStatus: 200
{
"result": [
{
"sender_id": 388,
"name": "xjmfc",
"email": "xjmfc@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
],
"total": 3,
"count": 1
}
{
"result": [
{
"sender_id": 388,
"name": "xjmfc",
"email": "xjmfc@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
],
"total": 3,
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-Error
{
"code": 30000,
"message": "Authentication failed"
}
{
"code": 30000,
"message": "Authentication failed"
}
このコードブロックはフローティングウィンドウ内に表示されます