Email Label

La etiqueta proporciona otra forma de obtener estadísticas de los correos electrónicos.

Se pueden consultar, añadir, eliminar y modificar etiquetas mediante la API.

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

Consulta (lote)

Lista de etiquetas devueltas

URL

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

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

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 de la solicitud

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

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio	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
label_name	string	no	consulta difusa

Ejemplo de solicitud

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

              
              curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&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
label_id	ID de etiqueta
label_name	nombre de la etiqueta
create_time	hora de creación de la etiqueta
update_time	hora de modificación de la etiqueta

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "total": 28, "count": 28, "result": [ { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } ] }

              
              {
       
       "total": 28,
        "count": 28,
        "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "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

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

Consulta

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	true	Basic base64(apiUser:apiKey)

Ejemplo de solicitud

curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/labels/89" --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
label_id	ID de etiqueta
label_name	nombre de la etiqueta
create_time	hora de creación de la etiqueta
update_time	hora de modificación de la etiqueta

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "result": { "label_id": 598100, "label_name": "xiaoxiao" "create_time": "2022-08-09T13:49:46+0800", "update_time": "2022-11-12T14:12:12+0800" } }

              
              {
        "result": {
            "label_id": 598100,
            "label_name": "xiaoxiao"
            "create_time": "2022-08-09T13:49:46+0800",
            "update_time": "2022-11-12T14:12:12+0800"
          }
    
}

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

Añadir

URL

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

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

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

Método de solicitud HTTP

POST

              
              POST

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

Encabezado de la solicitud

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

Descripción de parámetros del body

Parámetro	Tipo	Obligatorio	Descripción
label_name	string	sí	nombre de la etiqueta que se va a añadir. Máximo 64 caracteres.

Consejos:
El límite máximo de creación de etiquetas es 100.000.

Ejemplo de solicitud

curl -X POST "https://email.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"hongkong", }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/labels" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"hongkong",
}'

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

Descripción del valor devuelto

Parámetro	Descripción
label_id	ID de etiqueta
label_name	nombre de la etiqueta
create_time	hora de creación de la etiqueta
update_time	hora de modificación de la etiqueta

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              
{
    "result": {
            "label_id": 598802,
            "label_name": "xjm226",
            "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

Response-error

HTTP Status :400

{ "code": 30105, "message": "The label name should be 1-255 characters" }

              
              {
    "code": 30105,
    "message": "The label name should be 1-255 characters"
}

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

Eliminar

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_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 de la solicitud

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/labels/21122" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/labels/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	cantidad de etiquetas eliminadas

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

Modificar

URL

https://email.api.engagelab.cc/v1/labels/{label_id}

              
              https://email.api.engagelab.cc/v1/labels/{label_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 de la solicitud

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

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
label_name	string	sí	nuevo nombre de la etiqueta. Máximo 64 caracteres.

Ejemplo de solicitud

curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name":"travel", }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "label_name":"travel",
}'

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

Descripción del valor devuelto

Parámetro	Descripción
count	cantidad de etiquetas 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

Etiqueta de correo electrónico

Dirección de llamada

Consulta (lote)

Consulta

Añadir

Eliminar

Modificar