Rules

Reglas

Centro de datos y URL base

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

POST/v1/mail/<module>

Formato de solicitud de la API

https://email.api.engagelab.cc/v1/<module>/<action>

Módulo: nombre del módulo de funcionalidad, por ejemplo, el módulo mail, el módulo addresslist.

Acción: acción de cada módulo, por ejemplo, send, add.

Código de retorno de la API

La API devuelve resultados en formato JSON. El ejemplo es el siguiente:

              
              # request was successful
{
 
  "result": {}
}
# Authentication failed
{
  "code": 30000,
  "message": "Authentication failed",
}

# Data acquisition success
{
    
   "total": 28,
   "count": 28,
   "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-10T15:47:05+0800",
                "update_time": "2022-11-10T15:47:05+0800"
            }
        ]
    
}

            

• httpStatus: 200
• result: Información de datos

Código de estado HTTP

Descripción del formato de la dirección de correo electrónico

Formato de la dirección de correo electrónico: local_part@domain_part, compuesto por local_part, @ y domain_part. La dirección de correo electrónico válida debe cumplir las siguientes reglas:

• la longitud mínima de local_part@domain_part es de 6 caracteres y la longitud máxima es de 128 caracteres;
• la longitud máxima de la cadena de la parte local_part es de 96 caracteres y no puede contener el carácter @;
• domain_part solo puede contener a-zA-Z0-9 -. No puede empezar por - ni terminar por -. La longitud total no supera los 255 caracteres y cada segmento no supera los 63. El dominio de nivel superior solo puede contener entre 2 y 20 letras del alfabeto inglés en mayúsculas y minúsculas;

Diccionario de zonas horarias

Diccionario de zonas horarias del calendario

Diccionario de tasas

Condiciones de filtro

Estructura de la condición de filtro

              
              {
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "createTime",
                "op": ">=",
                "value": "2021-10-11"
            },
            {
                "field_name": "Name",
                "op": "contain",
                "value": "left"
            }
        ]
    }
}

# Filter condition: createTime >= '2021-10-11' or Name contains 'left'

            

Descripción de la condición de filtro