Route

Se puede utilizar la API para consultar, añadir, modificar y eliminar rutas de recepción.
La ruta configurada se debe registrar primero mediante la configuración de MX.
Se puede reenviar el mensaje de respuesta al buzón que se especifique o enviar el mensaje (push) a la URL especificada.

Dirección de llamada

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/routes

Consulta (lote)

URL

https://email.api.engagelab.cc/v1/routes

              
              https://email.api.engagelab.cc/v1/routes

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

Encabezado

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

Descripción de parámetros

Parámetro	Tipo	Obligatorio o no	Descripción
offset	int	no	posición de desplazamiento, [0-], el valor predeterminado es 0
limit	int	no	cantidad, [0-100], el valor predeterminado es 100

Ejemplo de solicitud

curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Descripción del valor devuelto

Parámetro	Descripción
route_id	ID de ruta
expression	ruta de recepción
action	URL/Email
api_user_route	Cuando action se establece en "Email", este parámetro es obligatorio.

Ejemplo de valor devuelto:

Response-success
HTTP Status: 200

{ "result": [ { "route_id": 1, "expression": "xjmfc", "action": "test@engagelab.com", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800", "api_user_route": "test" } ], "total": 1, "count": 1 }

              
              {
       "result": [
            {    
                "route_id": 1,
                "expression": "xjmfc",
                "action": "test@engagelab.com",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800",
                "api_user_route": "test"
            }
        ],
        "total": 1,
        "count": 1
 }

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

Consulta

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_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

Encabezado

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

Ejemplo de solicitud

curl -X GET "https://email.api.engagelab.cc/v1/routes/112" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json"

              
              curl -X GET "https://email.api.engagelab.cc/v1/routes/112" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json"

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

Descripción del valor devuelto

Parámetro	Descripción
route_id	ID de ruta
expression	ruta de recepción
action	URL/Email
api_user_route	Cuando action se establece en "Email", este parámetro es obligatorio.

Ejemplo de valor devuelto:

Response-success

HTTP Status: 200

{ "result": { "route_id": 1, "expression": "xjmfc", "action": "test@engagelab.com", "api_user_route": "sctest", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
       "result": {    
                "route_id": 1,
                "expression": "xjmfc",
                "action": "test@engagelab.com",
                "api_user_route": "sctest",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
          }
 }

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

Añadir

Un usuario puede añadir hasta 1000 rutas de recepción.

URL

https://email.api.engagelab.cc/v1/routes

              
              https://email.api.engagelab.cc/v1/routes

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

Encabezado

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

Descripción de parámetros

Parámetro	Tipo	Obligatorio o no	Descripción
expression	string	sí	ruta de recepción. El formato es 'expresión regular@dominio'; también puede ser una dirección de correo electrónico específica. El dominio/dominio de correo electrónico debe ser un dominio de envío verificado o utilizable.
action	string	sí	URL/Email
api_user_route	string	*	Cuando action se establece en "Email", este parámetro es obligatorio. Cuando se reenvía a un correo electrónico, este API-USER se utilizará para el reenvío y el envío.

Ejemplo de solicitud

curl -X POST "https://email.api.engagelab.cc/v1/routes" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "expression":"hongkong@aizl.net", "action":"test@engagelab.com" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/routes" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "expression":"hongkong@aizl.net",
  "action":"test@engagelab.com"
}'

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

Descripción del valor devuelto

Parámetro	Descripción
route_id	ID de ruta
expression	ruta de recepción
action	URL/Email
api_user_route	Cuando action se establece en "Email", este parámetro es obligatorio.

Ejemplo de valor devuelto:

{ "result": { "route_id": 598802, "expression": ".*@123.com", "action": "test@engagelab.com", "api_user_route": "test233", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              {
   "result": {
            "route_id": 598802,
            "expression": ".*@123.com",
            "action": "test@engagelab.com",
            "api_user_route": "test233",
            "create_time": "2022-11-14T14:27:34+0800",
            "update_time": "2022-11-14T14:27:34+0800"
    }
}

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

Modificar

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_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

Encabezado

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

Descripción de parámetros

Parámetro	Tipo	Obligatorio o no	Descripción
expression	string	*	ruta de recepción
action	string	*	URL/Email
api_user_route	string	*	Cuando action se establece en "Email", este parámetro es obligatorio.

Ejemplo de solicitud

curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "expression":"travel", "action":"test@engagelab.com" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "expression":"travel",
  "action":"test@engagelab.com"
}'

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

Descripción del valor devuelto

Parámetro	Descripción
count	recuento de rutas de recepción modificadas

Ejemplo de valor devuelto:

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-error

HTTP Status :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/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_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

Encabezado

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

Ejemplo de solicitud

curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Descripción del valor devuelto

Parámetro	Descripción
count	recuento de rutas de recepción eliminadas

Ejemplo de valor devuelto:

{ "count": 1 }

              
              {
    "count": 1
}

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

Ruta

Dirección de llamada

Consulta (lote)

Consulta

Añadir

Modificar

Eliminar