senders

Dirección de petición

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, se debe verificar que el centro de datos seleccionado corresponda a la URL base adecuada.

POST/v1/marketing/senders

Crear

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
from_name	string	true	Nombre del remitente
email	string	true	Dirección de correo electrónico del remitente. Debe tener formato de correo electrónico y un nombre de dominio con el sufijo domain_name.
domain_name	string	true	Nombre de dominio (según la configuración)
api_user	string	true	Nombre de ApiUser

Nota:

domain_name y api_user deben coincidir.

Ejemplo de solicitud

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"
}'

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

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"
    }
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Eliminar

URL

https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

DELETE

              
              DELETE

Este bloque de código se muestra en una ventana flotante

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count":1 }

              
              {
    "count":1
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Actualizar

URL

https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
from_name	string	false	Nombre del remitente
email	string	false	Dirección del remitente; debe tener formato de correo electrónico con domainName como sufijo de dominio
domain_name	string	false	Dominio (según la configuración)
api_user	string	false	Nombre de ApiUser

Nota:

Los valores de from_name, email, domain_name y api_user no pueden ser cadenas vacías ni caracteres nulos.

Ejemplo de solicitud

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"
}'

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "count":1 }

              
              {
    "count":1
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Detalle del remitente

URL

https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

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"
    }
}

Este bloque de código se muestra en una ventana flotante

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Lista de remitentes

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	string	true	Basic base64(api_user:api_key)

Parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
limit	integer	false	Número de registros que se van a recuperar; intervalo: [1-100], valor predeterminado: 10
offset	integer	false	Posición inicial para la consulta; intervalo: [0-], valor predeterminado: 0

Ejemplo de solicitud

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

Este bloque de código se muestra en una ventana flotante

Parámetros de respuesta

Parámetros	Tipo	Descripción
list	array[object]	Lista de remitentes
sender_id	integer	ID de remitente
name	string	Nombre del remitente
email	string	Dirección de correo del remitente
domain_id	integer	ID de dominio
domain_name	string	Nombre de dominio
api_user	string	Nombre de ApiUser
create_time	string	Hora de creación
update_time	string	Hora de actualización
total	integer	Número total de registros

Ejemplo de respuesta

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
}

Este bloque de código se muestra en una ventana flotante

Response-Error

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

Este bloque de código se muestra en una ventana flotante

Remitente

Dirección de petición

Crear

Eliminar

Actualizar

Detalle del remitente

Lista de remitentes