Campañas
Dirección de la 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/marketing/campaigns
Crear
URL
https://email.api.engagelab.cc/v1/marketing/campaigns
https://email.api.engagelab.cc/v1/marketing/campaigns
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 |
|---|---|---|---|
| campaign_type | integer | true | Tipo de campaña: 1 para prueba A/B, 2 para campaña estándar |
| name | string | true | Nombre de la campaña (hasta 64 caracteres) |
| to | object[] | true | Destinatarios; actualmente admite un array de longitud 1 |
| reply_to | string | false | Dirección de respuesta |
| sender_id | string | * | ID de remitente (solo compatible con campañas estándar) |
| template_invoke_name | string | * | Nombre de invocación de la plantilla (solo compatible con campañas estándar) |
| subject | string | * | Asunto del correo; tiene prioridad sobre el asunto integrado de la plantilla. Obligatorio si la prueba A/B es una prueba de contenido |
| send_time | string | * | Hora de envío (solo compatible con campañas estándar); formato: "YYYY-MM-DD HH:mm:ss" |
| time_zone | integer | * | Zona horaria predeterminada (+8 de forma predeterminada) |
| attachments | object[] | false | Adjuntos de correo (hasta 10 adjuntos) |
| filename | string | false | Nombre de archivo del adjunto, p. ej., example.pdf |
| content | string | false | Contenido del adjunto en codificación base64 |
| ab_test | object | * | Parámetros de configuración de prueba A/B (solo compatible con pruebas A/B) |
| google_track | object | false | Parámetros de configuración de Google Track (solo compatible con campañas estándar) |
| warm_up | object[] | false | Parámetros de configuración de envío de calentamiento (warm-up) (solo compatible con campañas estándar) |
Nota:
- El tamaño total de todos los archivos adjuntos no debe superar los 10 MB. Se debe tener en cuenta que el tamaño de los archivos aumenta ligeramente tras la codificación base64. El límite de 10 MB se refiere al tamaño antes de la codificación base64.
Los tres formatos del parámetro "to" son:
[
{
"type": "list",
"value": ["all"]
}
]
[
{
"type": "tag",
"value": ["tag1"]
}
]
[
{
"type": "segment",
"value": ["segment1"]
}
]
[
{
"type": "list",
"value": ["all"]
}
]
[
{
"type": "tag",
"value": ["tag1"]
}
]
[
{
"type": "segment",
"value": ["segment1"]
}
]
Este bloque de código se muestra en una ventana flotante
El formato del parámetro "ab_test" es el siguiente:
Cuando la campaña es una prueba A/B, el parámetro "ab_test" es obligatorio.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| ab_test | object | true | Datos de configuración de la prueba A/B |
| percent | integer | true | Configuración de porcentaje; rango [1, 100]. Por ejemplo, 20 significa que se selecciona el 20% de los contactos como destinatarios de prueba, mientras que el resto se envía en función de la condición ganadora |
| win_condition | object | true | Determina la condición ganadora de la prueba A/B |
| time_unit | string | true | Unidad de tiempo: day, hour |
| after_time | integer | true | Tiempo de espera antes de calcular la condición ganadora. Si la unidad es horas, el rango es [0-23]; si la unidad es días, el rango es [0-10] |
| compare | string | true | Campo de comparación. Valores posibles: open_percent, click_percent, uni_open_percent, uni_click_percent, delivered_percent |
| template_invoke_names | string[] | * | Prueba de plantilla. Se ignora el valor de template_invoke_name; subject es obligatorio |
| sender_ids | string[] | * | Prueba de ID de remitente. Se ignora el valor de sender_id |
| send_times | string[] | * | Prueba de hora de envío. Se ignora el valor de send_time |
| subjects | string[] | * | Prueba de asunto del correo. Se ignora el valor de subject |
Nota:
- La configuración de ab_test actualmente solo admite un único elemento de prueba.
El formato del parámetro google_track es el siguiente:
Al configurar los parámetros de google_track, el sistema añadirá estos parámetros a los enlaces de los correos electrónicos. Se permite hacer el seguimiento del tráfico de clientes desde las campañas hacia el sitio web, lo que habilita el análisis en Google Analytics.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| google_track | object | false | Parámetros de configuración de Google Track |
| campaign_name | string | false | Nombre de campaña (hasta 64 caracteres) |
| campaign_source | string | false | Fuente (hasta 64 caracteres) |
| campaign_medium | string | false | Medio (hasta 64 caracteres) |
| campaign_term | string | false | Palabra clave (hasta 64 caracteres) |
| campaign_content | string | false | Contenido (hasta 64 caracteres) |
Eliminar
Ejemplo de respuesta
Response-Success
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Este bloque de código se muestra en una ventana flotante
Detalles de la campaña
Parámetros de respuesta
| Parámetro | Tipo | Descripción |
|---|---|---|
| time_tone | integer | Zona horaria (consultar el diccionario de zonas horarias) |
(Nota: el nombre del parámetro se mantiene según lo devuelto por la API).
