Address List

La lista de direcciones se utiliza normalmente al enviar correos de marketing.

Se puede consultar, agregar, modificar y eliminar la lista de direcciones, así como sus miembros.

Dirección de invocación

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, asegúrese de que el centro de datos seleccionado corresponda a la URL base adecuada.

POST /v1/address_lists

Consultar lista de direcciones (Batch)

URL

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

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

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	Sí	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-], valor predeterminado 0
limit	int	No	Cantidad, [0-100], valor predeterminado 100
name	string	No	Nombre de la lista de direcciones
address	string	No	Dirección de la lista de direcciones

Ejemplo de solicitud

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='

              
              curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='

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

Descripción de valores devueltos

Parámetro	Descripción
address_list_id	ID de la lista
name	Nombre de la lista de direcciones
address	Lista de direcciones de alias; se pueden invocar operaciones mediante la dirección de alias; el formato es xxx@maillist.email.engagelab.com
member_count	Número de direcciones en la lista
desc	Descripción de la lista de direcciones
create_time	Hora de creación de la lista de direcciones
update_time	Hora de modificación de la lista de direcciones

Ejemplo devuelto

Response-success

HTTP Status: 200

{ "result": [ { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } ], "total": 1, "count": 1 }

              
              {
  "result": [
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "Description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
        ],
        "total": 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

Consultar lista de direcciones

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

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

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

Ejemplo de solicitud

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Descripción de valores devueltos

Parámetro	Descripción
address_list_id	ID de la lista de direcciones
name	Nombre de la lista
address	Dirección de alias; se utiliza esta dirección de alias para la invocación; el formato es xxx@maillist.email.engagelab.com
member_count	Número de direcciones incluidas en la lista
desc	Descripción de la lista de direcciones
create_time	Hora de creación de la lista de direcciones
update_time	Hora de modificación de la lista de direcciones

Ejemplo devuelto

Response-success

HTTP Status: 200

{ "result": { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "Description": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } }

              
              {
  "result":
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "Description": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+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

Agregar lista de direcciones

URL

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

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

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

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: 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	Sí	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre de la lista. Longitud máxima: 48 caracteres
address	string	Sí	Ejemplo: marketing@maillist.email.engagelab.com
desc	string	No	Descripción de la lista

Ejemplo de solicitud

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@email.engagelab.com", "name":"hongKong", "desc":"" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'

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

Descripción de valores devueltos

Parámetro	Descripción
address_list_id	ID de la lista
address	Dirección de la lista
member_count	Número de miembros en la lista
name	Nombre de la lista
desc	Descripción de la lista de direcciones
create_time	Hora de creación de la lista de direcciones
update_time	Hora de modificación de la lista de direcciones

Ejemplo de valores devueltos

response success { "result": { "address_list_id": 65504, "address": "jg3@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 0, "desc": "desc", "create_time": "2022-11-15T16:25:02+0800", "update_time": "2022-11-15T16:25:02+0800" } } response error { "code": 30000, "message": "Authentication failed." }

              
              response success
{
     "result": {
            "address_list_id": 65504,
            "address": "jg3@maillist.email.engagelab.com",
            "name": "1113-mailist",
            "member_count": 0,
            "desc": "desc",
            "create_time": "2022-11-15T16:25:02+0800",
            "update_time": "2022-11-15T16:25:02+0800"
        }
}

response error
{ 
    "code": 30000,
    "message": "Authentication failed."
}

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

Eliminar lista de direcciones

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_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	Sí	Basic base64(api_user:api_key)

Ejemplo de solicitud

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

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

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

Descripción de valores devueltos

Parámetro	Descripción
count	Número de listas eliminadas

Ejemplo de valores devueltos

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 lista de direcciones

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}

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

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

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	Sí	Basic base64(api_user:api_key)

Descripción de parámetros

Parámetro	Tipo	Obligatorio	Descripción
address	string	No	Ejemplo: marketing@maillist.email.engagelab.com
name	string	No	Nombre de la lista modificada
desc	string	No	Descripción de la lista modificada

Tips:

【name】 or 【desc】can be modified individually or in combination

              
              【name】 or 【desc】can be modified individually or in combination

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

Ejemplo de solicitud

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"new@maillist.email.engagelab.com", "name":"GZ", "desc":"2" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"GZ",
"desc":"2"
}'

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

Descripción de valores devueltos

Response-success

HTTP Status: 200

Parámetro	Descripción
count	Número de listas modificadas

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

Consultar miembro de la lista

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

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	Sí	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-], valor predeterminado 0
limit	int	No	Cantidad, [0-100], valor predeterminado 100
email	string	No	Consultar la dirección de correo del miembro. Se admite búsqueda difusa
member_ids	string	No	Lista de ID de miembros separados por punto y coma (;). Máximo 100 miembros

Ejemplo de solicitud

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

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

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

Descripción de valores devueltos

Parámetro	Descripción
member_id	ID del miembro
email	Dirección de correo del miembro
name	Nombre del miembro
vars	Variables
create_time	Hora de creación de la lista de direcciones
update_time	Hora de modificación de la lista de direcciones

Ejemplo de valores devueltos

Response-success

HTTP Status: 200

{ "result": [ { "member_id": "11719293", "email": "example2@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-13 11:23:44", "update_time": "2022-11-13 11:23:44" }, { "member_id": "11719294", "email": "example5@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-15 16:34:47", "update_time": "2022-11-15 16:34:47" } ], "total": 2, "count": 2, "address_list_id": "65499" }

              
              {
    "result": [
        {
            "member_id": "11719293",
            "email": "example2@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-13 11:23:44",
            "update_time": "2022-11-13 11:23:44"
        },
        {
            "member_id": "11719294",
            "email": "example5@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-15 16:34:47",
            "update_time": "2022-11-15 16:34:47"
        }
    ],
    "total": 2,
    "count": 2,
    "address_list_id": "65499"
}

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

Agregar miembro de la lista

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

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	Sí	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
members	array[object]	Sí	Lista de miembros. Hasta 1000 miembros
email	string	Sí	Dirección de correo
name	string	No	Nombre del miembro. Longitud máxima: 128 caracteres
vars	string	No	Variables. El máximo es 1 KB

Tips:

1. When adding vars variables, note that the key does not need to be marked with '%', and the length of the key cannot exceed 32 characters. 2. In the vars variable, the variable whose key is name will be overwritten by the Parameter name. 3. When sending the address list, you can use the global variable recipient, whose value is the recipient's email address.

              
              1. When adding vars variables, note that the key does not need to be marked with '%', and the length of the key cannot exceed 32 characters.
2. In the vars variable, the variable whose key is name will be overwritten by the Parameter name.
3. When sending the address list, you can use the global variable recipient, whose value is the recipient's email address.

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

Ejemplo de solicitud

curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'

              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'

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

Descripción de valores devueltos

Campo	Descripción
count	Número de miembros agregados
invalid	Miembro no válido
invalidCount	Número de direcciones de correo que no se pudieron agregar
reasonList	Motivo por el que no se pudo agregar la dirección de correo (correspondiente a los detalles de la dirección)

Ejemplo de valores devueltos

Response-success

HTTP Status: 200

{ "result": { "count": 2, "invalidCount": 1, "invalid": [ "wang.@yahoo.com" ], "reasonList": [ "Member email format erorr" ] } }

              
              {
    "result": {
        "count": 2,
        "invalidCount": 1,
        "invalid": [
            "wang.@yahoo.com"
        ],
        "reasonList": [
            "Member email format erorr"
        ]
    }
}

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 miembro de la lista

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}

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

PUT

PUT

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

Encabezado de la solicitud

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

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio	Descripción
email	string	Sí	Dirección de correo
name	string	No	Nombre del miembro. Longitud máxima: 128 caracteres
vars	object	No	Variables. El máximo es 1 KB. La longitud de la clave no puede superar 32 caracteres

Ejemplo de solicitud

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"email":"x@engagelab.com","name":"jim"}'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"email":"x@engagelab.com","name":"jim"}'

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

Descripción de valores devueltos

Campo	Descripción
count	Número de direcciones modificadas
reason	Motivo por el que no se pudo actualizar la dirección de correo

Ejemplo de valores devueltos

Response-success

HTTP Status: 200

{ "count": 0, "reason": "Member email format erorr" }

              
              {
    "count": 0,
    "reason": "Member email format erorr" 
}

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 miembro de la lista

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members

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	Sí	Basic base64(api_user:api_key)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
member_ids	string	Sí	Lista de ID de miembros separados por punto y coma (;). Máximo 100 miembros

Ejemplo de solicitud

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Descripción de valores devueltos

Campo	Descripción
count	Número de direcciones eliminadas

Ejemplo de valores devueltos

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

Lista de direcciones

Dirección de invocación

Consultar lista de direcciones (Batch)

Consultar lista de direcciones

Agregar lista de direcciones

Eliminar lista de direcciones

Modificar lista de direcciones

Consultar miembro de la lista

Agregar miembro de la lista

Modificar miembro de la lista

Eliminar miembro de la lista