segments

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/lists/segments

Crear

URL

https://email.api.engagelab.cc/v1/marketing/lists/segments

              
              https://email.api.engagelab.cc/v1/marketing/lists/segments

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
segment_name	string	true	Nombre del segmento (máximo 48 caracteres; no admite los siguientes caracteres: ^, ?, +, ., *, \, [, ], (, ))
type	integer	true	Tipo de segmento (0 o 1) 0. por campo; 1. por campaña
condition	object	true	Condición del segmento
relation	string	true	Relación de condiciones (and u or)
items	object[]	true	Condiciones (se admiten hasta 10 condiciones de filtrado; todas las condiciones tienen la misma relación, ya sea todas and o todas or)
campaign_id	integer	false	ID de campaña Si field_name=campaign, este valor es obligatorio, y el estado de la campaña correspondiente debe estar en curso o completado
field_name	string	true	1. Si type=0 field_name es el nombre del campo; value es el valor del campo; cuando field_name es "tag", value=nombre de etiqueta 2. Si type=1 field_name debe ser campaign; value es uno de "sent","open","click","unopen","unclick","notsent"; en este caso campaign_id es obligatorio y corresponde al ID de la campaña
op	string	true	Operador (== , != , > , >= , < , <= , contain , does not contain) Cuando field_name=campaign, op debe ser ==; cuando field_name es un nombre de atributo o una etiqueta, consultar condiciones de filtrado para los operadores disponibles
value	string	true	Cuando field_name es "tag", value=tagName; Cuando field_name es un nombre de campo, consultar condiciones de filtrado para el formato; Cuando field_name = "campaign", value es uno de sent, open, click, unopen, unclick, notsent

Nota:

Consultar la relación correspondiente entre field_name y op en condiciones de filtrado.

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/lists/segments --data '{ "segment_name": "Hubei user", "type": 0, "condition": { "relation": "and", "items": [ { "field_name": "Name", "op": "contain", "value": "Lei Li" } ] } }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/segments --data '{
  "segment_name": "Hubei user",
  "type": 0,
  "condition": {
    "relation": "and",
    "items": [
     {
        "field_name": "Name",
        "op": "contain",
        "value": "Lei Li"
      }
    ]
  }
}'

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

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "result": { "segment_id": "6566f6392c16e71300b1b1e9", "user_id": 104201, "segment_name": "MyCustomField", "type": 0, "list_id": 96112, "status": "2", "create_time": "2023-11-29 16:28:41+0800", "update_time": "2023-11-29 16:33:58+0800", "member_total": 1, "condition": { "relation": "and", "items": [ { "field_name": "Name", "op": "contain", "value": "Lei li" } ] }, "process": { "statusDesc": "segmentation completed", "complete": true, "percent": 100 } } }

              
              {
    "result": {  
    "segment_id": "6566f6392c16e71300b1b1e9",
    "user_id": 104201,
    "segment_name": "MyCustomField",
    "type": 0,
    "list_id": 96112,
    "status": "2",
    "create_time": "2023-11-29 16:28:41+0800",
    "update_time": "2023-11-29 16:33:58+0800",
    "member_total": 1,
    "condition": {
    "relation": "and",
    "items": [
      {
        "field_name": "Name",
        "op": "contain",
        "value": "Lei li"
      }
    ]
 },
   "process": {  
      "statusDesc": "segmentation completed",
      "complete": true,
      "percent": 100
    }
  }
}

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

Response-Error

{ "code": 30035, "message": "[segment_name]:Special characters such as ^, ?, +, ., \\, [, ], (, ), cannot be used" }

              
              {
  "code": 30035,
  "message": "[segment_name]:Special characters such as ^, ?, +, ., \\, [, ], (, ), cannot be used"
}

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

Eliminar

URL

https://email.api.engagelab.cc/v1/marketing/lists/segments/{segment_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/segments/{segment_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/lists/segments/6566f12d1e9adc15e3efd4

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/segments/6566f12d1e9adc15e3efd4

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

{ "code": 30036, "message": "not found" }

              
              {
    "code": 30036,
    "message": "not found"
}

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

Actualizar

URL

https://email.api.engagelab.cc/v1/marketing/lists/segments/{segment_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/segments/{segment_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
segment_name	string	false	Nombre del segmento (hasta 48 caracteres)
type	integer	true	Tipo de segmento (0 o 1) 0. por campo (agrupado por atributo); 1. por campaña (agrupado por rendimiento)
condition	object	true	Condición del segmento
relation	string	true	Relación de condiciones (and u or)
items	object[]	true	Condiciones (admite hasta 10 condiciones de filtrado; todas deben tener la misma relación: o todas and o todas or)
campaign_id	integer	false	ID de campaña Si field_name=campaign, este valor es obligatorio y el estado de la campaña correspondiente debe estar en curso o completado
field_name	string	true	1. Si type=0 field_name es el nombre del atributo; value es el valor del atributo; cuando field_name es "tag", value=nombre de etiqueta 2. Si type=1 field_name debe ser campaign; value puede ser "sent", "open", "click", "unopen", "unclick", "notsent"; en este caso, campaign_id es obligatorio y debe corresponder al ID de la campaña
op	string	true	Operador (==, !=, >, >=, <, <=, contain, does not contain) Cuando field_name=campaign, op debe ser ==; cuando field_name es un nombre de atributo o una etiqueta, consultar condiciones de filtrado para las opciones disponibles
value	string	true	Cuando field_name es "tag", value=nombre de etiqueta; Cuando field_name es un nombre de atributo, consultar condiciones de filtrado para el formato; cuando field_name = "campaign", value debe ser uno de sent, open, click, unopen, unclick, notsent

Nota

Consultar la relación correspondiente entre field_name y op en condiciones de filtrado.

Parámetros de respuesta

Parámetro	Tipo	Descripción
segment_id	string	ID de segmento
segment_name	string	Nombre del segmento
list_id	integer	ID de lista asociada
status	string	Estado del segmento (-1: Error, 1: Actualizando, 2: Actualización completada)
create_time	string	Hora de creación (UTC+8)
update_time	string	Hora de actualización (UTC+8)
member_total	integer	Número total de miembros en el segmento
type	integer	Tipo de segmento (0 o 1)
condition	object	Condición del segmento
relation	string	Relación de condiciones (and, or)
items	object[]	Condiciones
campaign_id	integer	ID de campaña
field_name	string	Nombre de campo
op	string	Operador
value	string	Valor de campo
process	object	Progreso de procesamiento del segmento
status_desc	string	Descripción del estado de procesamiento
complete	Boolean	true: completado; false: no completado
percent	integer	Porcentaje de finalización

Lista de segmentos

Parámetros de respuesta

| Parámetro | Tipo | Descripción |

Lista de miembros del segmento

Ejemplo de respuesta

Response-Success

HttpStatus: 200

{ "result": [ { "id": "629d6650490f33c5eef1caa6", "list_id": 63486, "email": "paulchen0518@yahoo.com.tw", "phone": null, "name": "shanshan", "create_time": "2022-06-06T10:28:32+0800", "update_time": "2022-06-06T10:28:32+0800", "unsubscribe_time": null, "fields": { "Gender": "Female" }, "tags": null, "tag_names": [] } ], "total": 2 }

              
              {
    "result": [
        {
            "id": "629d6650490f33c5eef1caa6",
            "list_id": 63486,
            "email": "paulchen0518@yahoo.com.tw",
            "phone": null,
            "name": "shanshan",
            "create_time": "2022-06-06T10:28:32+0800",
            "update_time": "2022-06-06T10:28:32+0800",
            "unsubscribe_time": null,
            "fields": {
                "Gender": "Female"
            },
            "tags": null,
            "tag_names": []
        }
    ],
    "total": 2
}

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

Segmentos

Dirección de la llamada

Crear

Eliminar

Actualizar

Lista de segmentos

Lista de miembros del segmento