Compartir a través de

Courier (Publicador independiente) (versión preliminar)

Courier es un servicio y estudio web para que los equipos de desarrollo administren todas las comunicaciones desencadenadas por el producto (correo electrónico, chat, en la aplicación, SMS, inserción, etc.) en un solo lugar. Courier está diseñado para desarrolladores que desean ofrecer una experiencia de notificación excepcional.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Troy Taylor
URL https://www.hitachisolutions.com
Correo Electrónico ttaylor@hitachisolutions.com
Metadatos del conector
Publicador Troy Taylor
Sitio web https://www.courier.com/
Directiva de privacidad https://www.courier.com/privacy/
Categorías Comunicación; Redes sociales

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Token (en el formato "Bearer yourToken") securestring Token (con el formato "Bearer yourToken") para esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar un perfil

Actualizaciones en una parte de un perfil.
Actualizar una lista

Crea o reemplaza una lista existente por los valores proporcionados.
Adición de usuarios a un trabajo masivo

Ingesta de datos de usuario en un trabajo masivo.
Agregar suscriptores a una lista

Agregue suscriptores adicionales a una lista.
Archivar un mensaje

Solicite que se archive un mensaje.
Cancelar la suscripción de un usuario de una lista

Elimina una suscripción a una lista por lista e identificadores de destinatario.
Creación de un perfil

Combine los valores proporcionados con un perfil existente o cree un nuevo perfil si aún no existe uno.
Creación de un trabajo masivo

Crea un trabajo masivo para los parámetros de mensaje proporcionados.
Creación de una marca

Crea una nueva marca a partir de la configuración proporcionada.
Crear o actualizar una audiencia

Crea o actualiza una audiencia basada en los parámetros y filtros proporcionados.
Ejecución de un trabajo masivo

Empiece a ejecutar un trabajo masivo.
Ejecución de una automatización ad hoc

Invoque una automatización en una ejecución ad hoc.
Ejecución de una automatización con plantilla

Invoque una ejecución de automatización desde una plantilla de automatización.
Eliminar un perfil

Elimina el perfil de destinatario especificado.
Eliminar una audiencia

Elimina la audiencia de destinatarios especificada.
Eliminar una lista

Elimina una lista por identificador de lista.
Enumerar marcas

Recupera una lista de marcas.
Enumerar mensajes

Recupere los estados de los mensajes enviados anteriormente.
Enumerar miembros de la audiencia

Recuperar una lista de miembros de una audiencia.
Enumerar notificaciones

Recupera una lista de notificaciones.
Enumerar todas las audiencias

Recupera todas las audiencias asociadas a tu cuenta.
Enviar un mensaje

Envía un mensaje a uno o varios destinatarios.
Obtención de un evento de auditoría

Recupere un evento de auditoría específico por identificador.
Obtención de un trabajo masivo

Recupere la información sobre un trabajo masivo.
Obtención de usuarios de un trabajo masivo

Recupere los usuarios de un trabajo masivo.
Obtener el contenido de un mensaje

Recupere el contenido de un mensaje enviado previamente.
Obtener el historial de un mensaje

Recupere los eventos de un mensaje enviado anteriormente.
Obtener las suscripciones de la lista

Recupera las suscripciones de una lista.
Obtener todas las listas de destinatarios

Recupere una lista de todas las listas de destinatarios.
Obtener todos los eventos de auditoría

Recupere una lista de eventos de auditoría.
Obtener un mensaje

Recupere el estado de un mensaje.
Obtener un perfil

Recupera el perfil de destinatario especificado.
Obtener una audiencia

Devuelve la audiencia especificada por identificador.
Obtener una lista

Recupere los elementos de una lista.
Obtener una marca

Recupere una marca específica por identificador.
Restaurar una lista

Restaura una lista existente por identificador.

Actualizar un perfil

Id. de la operación:
ProfilePatch

Actualizaciones en una parte de un perfil.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipient_id True string

Identificador del destinatario.
Operation
 op string

La operación.
Ruta
 path string

Ruta de acceso.
Importancia
 value string

Valor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Actualizar una lista

Id. de la operación:
ListPut

Crea o reemplaza una lista existente por los valores proporcionados.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.
Nombre
 name string

Nombre.

Devoluciones

response
string

Adición de usuarios a un trabajo masivo

Id. de la operación:
BulkJobUsersPost

Ingesta de datos de usuario en un trabajo masivo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del trabajo
 job_id True string

El identificador del trabajo.
Destinatario
 recipient string

Destinatario.

Devoluciones

response
string

Agregar suscriptores a una lista

Id. de la operación:
ListSubscribersPost

Agregue suscriptores adicionales a una lista.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.
Id. de destinatario
 recipientId string

Identificador del destinatario.

Devoluciones

response
string

Archivar un mensaje

Id. de la operación:
MessagePut

Solicite que se archive un mensaje.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de solicitud
 request_id True string

Identificador de solicitud.

Devoluciones

response
string

Cancelar la suscripción de un usuario de una lista

Id. de la operación:
ListSubscribeDelete

Elimina una suscripción a una lista por lista e identificadores de destinatario.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.
Id. de destinatario
 recipient_id True string

Identificador del destinatario.

Devoluciones

response
string

Creación de un perfil

Id. de la operación:
ProfilePost

Combine los valores proporcionados con un perfil existente o cree un nuevo perfil si aún no existe uno.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipient_id True string

Identificador del destinatario.
Correo Electrónico
 email string

Dirección de correo electrónico.
Número de teléfono
 phone_number string

Número de teléfono.
Formato
 formatted string

Dirección con formato.
Dirección de la calle
 street_address string

Dirección postal.
Localidad
 locality string

La localidad.
Región
 region string

La región.
Código postal
 postal_code string

El código postal.
País
 country string

El país.
Fecha de nacimiento
 birthdate string

Fecha de nacimiento.
Correo electrónico comprobado
 email_verified boolean

Indica si se ha comprobado el correo electrónico.
Número de teléfono comprobado
 phone_number_verified boolean

Indica si se ha comprobado el número de teléfono.
Nombre propio
 given_name string

Nombre especificado.
Nombre intermedio
 middle_name string

Nombre intermedio.
Apellido
 family_name string

Nombre de familia.
Nombre preferido
 preferred_name string

Nombre preferido.
Gender
 gender string

El género.
Configuración regional
 locale string

Configuración regional.
Imagen
 picture string

Imagen.
Profile
 profile string

Perfil.
Sustituto
 sub string

Sub.
Actualizado en
 updated_at string

Cuando se actualiza en .
Sitio web
 website string

El sitio web.
Información de zona
 zoneinfo string

Información de zona.
Usuario con nombre
 named_user string

Usuario con nombre.
Tipos de dispositivo
 device_types array of string

Los tipos de dispositivo.
APN
 apn string

The APN.
ARN de destino
 target_arn string

ARN de destino.
Id. de canal
 channel_id string

Identificador del canal.
Id. de usuario
 user_id string

Identificador de usuario.
Token
 token string

El token.
Tokens
 tokens array of string

Los tokens.
Id. de PS de Facebook
 facebookPSID string

Identificador de PS de Facebook.
Firebase Token
 firebaseToken string

Token de Firebase.
De
 from string

De.
identificación
 id string

Identificador.
Id. de usuario
 user_id string

Identificador de usuario.
Id. de la conversación
 conversation_id string

Identificador de conversación.
Id. de inquilino
 tenant_id string

Identificador de inquilino.
Dirección URL del servicio
 service_url string

Dirección URL del servicio.
Id. del reproductor de OneSignal
 oneSignalPlayerID string

Identificador de OneSignal Player.
Token de acceso
 access_token string

Token de acceso.
Channel
 channel string

Canal.
Correo Electrónico
 email string

Dirección de correo electrónico.
Id. de usuario
 user_id string

Identificador de usuario.
URL
 url string

Dirección URL.
URL
 url string

Dirección URL.
Método
 method string

Los métodos.
Mode
 mode string

Modo.
Nombre de usuario
 username string

Nombre de usuario.
Contraseña
 password string

La contraseña.
Token
 token string

El token.
Profile
 profile string

Perfil.

Devoluciones

response
string

Creación de un trabajo masivo

Id. de la operación:
BulkJobPost

Crea un trabajo masivo para los parámetros de mensaje proporcionados.

Parámetros

Nombre Clave Requerido Tipo Description
Event
 event string

Evento .
Marca
 brand string

La marca.
Template
 template string

Plantilla.
Identificador de marca
 brand_id string

Identificador de marca.
Método
 method string

Método .
Canales
 channels array of string

Los canales.
Event
 event string

Evento .
Etiquetas
 tags array of string

Las etiquetas.
Id. de seguimiento
 trace_id string

Identificador de seguimiento.
Campaña
 campaign string

La campaña.
Content
 content string

El contenido.
Mediana
 medium string

Medio.
Fuente
 source string

Origen.
Término
 term string

El término.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. del trabajo
 jobId string

El identificador del trabajo.

Creación de una marca

Id. de la operación:
BrandPost

Crea una nueva marca a partir de la configuración proporcionada.

Parámetros

Nombre Clave Requerido Tipo Description
identificación
 id string

Identificador.
Nombre
 name True string

Nombre.
Primary
 primary string

Principal.
Secondary
 secondary string

Secundario.
Terciario
 tertiary string

El terciario.
Color de la barra
 barColor string

Color de la barra.
HREF
 href string

The HREF.
Imagen
 image string

Imagen.
Markdown
 markdown string

Markdown.
URL
 url string

Dirección URL.
URL
 url string

Dirección URL.
URL
 url string

Dirección URL.
URL
 url string

Dirección URL.
URL
 url string

Dirección URL.
Deshabilitar icono de mensaje
 disableMessageIcon boolean

Indica si se va a deshabilitar el icono del mensaje.
Colocación
 placement string

Ubicación.
Productos
 items array of string

Los elementos.

Devoluciones

response
string

Crear o actualizar una audiencia

Id. de la operación:
AudiencePut

Crea o actualiza una audiencia basada en los parámetros y filtros proporcionados.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de audiencia
 audience_id True string

Identificador de audiencia.
Nombre
 name string

Nombre.
Ruta
 path string

Ruta de acceso.
Operator
 operator string

Operador .
Importancia
 value string

Valor.
Ruta
 path string

Ruta de acceso.
Operator
 operator string

Operador .
Importancia
 value string

Valor.

Devoluciones

Nombre Ruta de acceso Tipo Description
identificación
 id string

Identificador.
Nombre
 name string

Nombre.
Description
 description string

Descripción.
Operator
 filter.operator string

Operador .
Importancia
 filter.value string

Valor.
Ruta
 filter.path string

Ruta de acceso.
Filtros
 filter.filters array of object
Ruta
 filter.filters.path string

Ruta de acceso.
Operator
 filter.filters.operator string

Operador .
Importancia
 filter.filters.value string

Valor.

Ejecución de un trabajo masivo

Id. de la operación:
BulkJobRunPost

Empiece a ejecutar un trabajo masivo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del trabajo
 job_id True string

El identificador del trabajo.

Devoluciones

response
object

Ejecución de una automatización ad hoc

Id. de la operación:
AutomationAdHocPost

Invoque una automatización en una ejecución ad hoc.

Parámetros

Nombre Clave Requerido Tipo Description
Token de cancelación
 cancelation_token string

Token de cancelación.
Marca
 brand string

La marca.
Template
 template string

Plantilla.
Destinatario
 recipient string

Destinatario.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de ejecución
 runId string

El identificador de ejecución.

Ejecución de una automatización con plantilla

Id. de la operación:
AutomationTemplatedPost

Invoque una ejecución de automatización desde una plantilla de automatización.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de plantilla
 templateId True string

Identificador de plantilla.
Marca
 brand string

La marca.
Template
 template string

Plantilla.
Destinatario
 recipient string

Destinatario.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de ejecución
 runId string

El identificador de ejecución.

Eliminar un perfil

Id. de la operación:
ProfileDelete

Elimina el perfil de destinatario especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipient_id True string

Identificador del destinatario.

Devoluciones

Nombre Ruta de acceso Tipo Description
Estado
 status string

Estado.

Eliminar una audiencia

Id. de la operación:
AudienceDelete

Elimina la audiencia de destinatarios especificada.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de audiencia
 audience_id True string

Identificador de audiencia.

Devoluciones

response
string

Eliminar una lista

Id. de la operación:
ListDelete

Elimina una lista por identificador de lista.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.

Devoluciones

response
string

Enumerar marcas

Id. de la operación:
BrandsGet

Recupera una lista de marcas.

Parámetros

Nombre Clave Requerido Tipo Description
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Results
 results array of object
Creado
 results.created integer

Cuando se crea.
identificación
 results.id string

Identificador.
Nombre
 results.name string

Nombre.
Publicado
 results.published integer

Cuando se publica.
Actualizado
 results.updated integer

Cuando se actualiza.
Versión
 results.version string

La versión.
Primary
 results.settings.colors.primary string

Principal.
Secondary
 results.settings.colors.secondary string

Secundario.
Terciario
 results.settings.colors.tertiary string

El terciario.
Color de la barra
 results.settings.email.header.barColor string

Color de la barra.
HREF
 results.settings.email.header.logo.href string

The HREF.
Imagen
 results.settings.email.header.logo.image string

Imagen.
Markdown
 results.settings.email.footer.markdown string

Markdown.
URL
 results.settings.email.footer.social.facebook.url string

Dirección URL.
URL
 results.settings.email.footer.social.instagram.url string

Dirección URL.
URL
 results.settings.email.footer.social.linkedin.url string

Dirección URL.
URL
 results.settings.email.footer.social.medium.url string

Dirección URL.
URL
 results.settings.email.footer.social.twitter.url string

Dirección URL.
Deshabilitar icono de mensaje
 results.settings.inapp.disableMessageIcon boolean

Indica si se va a deshabilitar el icono del mensaje.
Colocación
 results.settings.inapp.placement string

Ubicación.
Productos
 results.snippets.items array of string

Los elementos.

Enumerar mensajes

Id. de la operación:
MessagesGet

Recupere los estados de los mensajes enviados anteriormente.

Parámetros

Nombre Clave Requerido Tipo Description
Archivado
 archived boolean

Si está archivado.
Cursor
 cursor string

Cursor.
Event
 event string

Evento .
List
 list string

Lista.
Id. de mensaje
 messageId string

Identificador del mensaje.
Notification
 notification string

Notificación.
Destinatario
 recipient string

Destinatario.
Estado
 status string

Estado.
Etiquetas
 tags string

Las etiquetas.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Results
 results array of object
identificación
 results.id string

Identificador.
Estado
 results.status string

Estado.
En cola
 results.enqueued integer

El objeto en cola.
Sent
 results.sent integer

El enviado.
Entregado
 results.delivered integer

El entregado.
Abierto
 results.opened integer

Abierto.
Clic
 results.clicked integer

El objeto en el que se hace clic.
Destinatario
 results.recipient string

Destinatario.
Event
 results.event string

Evento .
Notification
 results.notification string

Notificación.
Error
 results.error string

Error.
Motivo
 results.reason string

La razón.

Enumerar miembros de la audiencia

Id. de la operación:
AudienceMembersGet

Recuperar una lista de miembros de una audiencia.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de audiencia
 audience_id True string

Identificador de audiencia.
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Productos
 items array of object
Id. de miembro
 items.member_id string

Identificador de miembro.
Agregado en
 items.added_at string

Cuando se agrega a .
Id. de audiencia
 items.audience_id string

Identificador de audiencia.
Versión del público
 items.audience_version integer

La versión del público.
Motivo
 items.reason string

La razón.
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.

Enumerar notificaciones

Id. de la operación:
NotificationsGet

Recupera una lista de notificaciones.

Parámetros

Nombre Clave Requerido Tipo Description
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Results
 results array of object
Creado en
 results.created_at integer

Cuando se crea en .
identificación
 results.id string

Identificador.
Data
 results.tags.data array of object
identificación
 results.tags.data.id string

Identificador.
Nombre
 results.tags.data.name string

Nombre.
Title
 results.title string

Título.
Actualizado en
 results.updated_at integer

Cuando se actualiza en .

Enumerar todas las audiencias

Id. de la operación:
AudiencesGet

Recupera todas las audiencias asociadas a tu cuenta.

Parámetros

Nombre Clave Requerido Tipo Description
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Productos
 items array of object
identificación
 items.id string

Identificador.
Nombre
 items.name string

Nombre.
Description
 items.description string

Descripción.
Operator
 items.filter.operator string

Operador .
Importancia
 items.filter.value string

Valor.
Ruta
 items.filter.path string

Ruta de acceso.
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.

Enviar un mensaje

Id. de la operación:
MessageSendPost

Envía un mensaje a uno o varios destinatarios.

Parámetros

Nombre Clave Requerido Tipo Description
Idempotencia
 idempotency True string

Clave de idempoencia.
Title
 title string

Título.
Body
 body string

El cuerpo.
Id. de usuario
 user_id string

Identificador de usuario.
Id. de lista
 list_id string

Identificador de lista.
Id. de audiencia
 audience_id string

Identificador de audiencia.
Correo Electrónico
 email string

Dirección de correo electrónico.
Número de teléfono
 phone_number string

Número de teléfono.
Configuración regional
 locale string

Configuración regional.

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de solicitud
 requestId string

Identificador de solicitud.

Obtención de un evento de auditoría

Id. de la operación:
AuditEventGet

Recupere un evento de auditoría específico por identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Auditar id. de evento
 audit-event-id True string

Identificador de evento de auditoría.

Devoluciones

Nombre Ruta de acceso Tipo Description
Auditar id. de evento
 auditEventId string

Identificador de evento de auditoría.
identificación
 actor.id string

Identificador.
Correo Electrónico
 actor.email string

Dirección de correo electrónico.
identificación
 target.id string

Identificador.
Correo Electrónico
 target.email string

Dirección de correo electrónico.
Fuente
 source string

Origen.
Marca de tiempo
 timestamp string

Marca de tiempo.
Tipo
 type string

Tipo.

Obtención de un trabajo masivo

Id. de la operación:
BulkJobGet

Recupere la información sobre un trabajo masivo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del trabajo
 job_id True string

El identificador del trabajo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Event
 job.definition.event string

Evento .
En cola
 job.enqueued integer

El objeto en cola.
Fallas
 job.failures integer

Errores.
Cantidad.Recibida
 job.received integer

Cuando se recibe.
Estado
 job.status string

Estado.

Obtención de usuarios de un trabajo masivo

Id. de la operación:
BulkJobUsersGet

Recupere los usuarios de un trabajo masivo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del trabajo
 job_id True string

El identificador del trabajo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Productos
 items array of object
Destinatario
 items.recipient string

Destinatario.
Correo Electrónico
 items.email string

Dirección de correo electrónico.
Configuración regional
 items.locale string

Configuración regional.
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.

Obtener el contenido de un mensaje

Id. de la operación:
MessageContentGet

Recupere el contenido de un mensaje enviado previamente.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de mensaje
 message_id True string

Identificador del mensaje.

Devoluciones

Nombre Ruta de acceso Tipo Description
Results
 results array of object
Channel
 results.channel string

Canal.
Id. de canal
 results.channel_id string

Identificador del canal.
HTML
 results.content.html string

The HTML.
Asunto
 results.content.subject string

El asunto.
Mensaje de texto
 results.content.text string

Texto.
Bloques
 results.content.blocks array of object
Tipo
 results.content.blocks.type string

Tipo.
Mensaje de texto
 results.content.blocks.text string

Texto.

Obtener el historial de un mensaje

Id. de la operación:
MessageHistoryGet

Recupere los eventos de un mensaje enviado anteriormente.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de mensaje
 message_id True string

Identificador del mensaje.
Tipo
 type string

Tipo.

Devoluciones

Nombre Ruta de acceso Tipo Description
Results
 results array of object
Nombre
 results.data.name string

Nombre.
Event
 results.event string

Evento .
Destinatario
 results.recipient string

Destinatario.
TS
 results.ts integer

El TS.
Tipo
 results.type string

Tipo.
Id. del evento
 results.event_id string

Identificador de evento.
Id. de notificación
 results.notification_id string

Identificador de notificación.
identificación
 results.channel.id string

Identificador.
identificación
 results.integration.id string

Identificador.
Provider
 results.integration.provider string

Proveedor.

Obtener las suscripciones de la lista

Id. de la operación:
ListSubscriptionsGet

Recupera las suscripciones de una lista.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Productos
 items array of object
Id. de destinatario
 items.recipientId string

Identificador del destinatario.
Creado
 items.created string

Cuando se crea.

Obtener todas las listas de destinatarios

Id. de la operación:
ListsGet

Recupere una lista de todas las listas de destinatarios.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Results
 results array of object
Creado
 results.created string

Cuando se crea.
identificación
 results.id string

Identificador.
Nombre
 results.name string

Nombre.
Actualizado
 results.updated string

Cuando se actualiza.

Obtener todos los eventos de auditoría

Id. de la operación:
AuditEventsGet

Recupere una lista de eventos de auditoría.

Parámetros

Nombre Clave Requerido Tipo Description
Cursor
 cursor string

Cursor.

Devoluciones

Nombre Ruta de acceso Tipo Description
Cursor
 paging.cursor string

Cursor.
Más
 paging.more boolean

Si hay más.
Results
 results array of object
Auditar id. de evento
 results.auditEventId string

Identificador de evento de auditoría.
identificación
 results.actor.id string

Identificador.
Correo Electrónico
 results.actor.email string

Dirección de correo electrónico.
identificación
 results.target.id string

Identificador.
Correo Electrónico
 results.target.email string

Dirección de correo electrónico.
Fuente
 results.source string

Origen.
Marca de tiempo
 results.timestamp string

Marca de tiempo.
Tipo
 results.type string

Tipo.

Obtener un mensaje

Id. de la operación:
MessageGet

Recupere el estado de un mensaje.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de mensaje
 message_id True string

Identificador del mensaje.

Devoluciones

Nombre Ruta de acceso Tipo Description
identificación
 id string

Identificador.
Estado
 status string

Estado.
En cola
 enqueued integer

El objeto en cola.
Sent
 sent integer

El enviado.
Entregado
 delivered integer

El entregado.
Abierto
 opened integer

Abierto.
Clic
 clicked integer

El objeto en el que se hace clic.
Destinatario
 recipient string

Destinatario.
Event
 event string

Evento .
Notification
 notification string

Notificación.
Error
 error string

Error.
Motivo
 reason string

La razón.
Providers
 providers array of object
Sent
 providers.sent integer

El enviado.
Entregado
 providers.delivered integer

El entregado.
Clic
 providers.clicked integer

El objeto en el que se hace clic.
Abierto
 providers.opened integer

Abierto.
Error
 providers.error string

Error.
Provider
 providers.provider string

Proveedor.
Estado
 providers.status string

Estado.

Obtener un perfil

Id. de la operación:
ProfileGet

Recupera el perfil de destinatario especificado.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de destinatario
 recipient_id True string

Identificador del destinatario.

Devoluciones

Nombre Ruta de acceso Tipo Description
Correo Electrónico
 profile.email string

Dirección de correo electrónico.
Número de teléfono
 profile.phone_number string

Número de teléfono.

Obtener una audiencia

Id. de la operación:
AudienceGet

Devuelve la audiencia especificada por identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de audiencia
 audience_id True string

Identificador de audiencia.

Devoluciones

Nombre Ruta de acceso Tipo Description
identificación
 id string

Identificador.
Nombre
 name string

Nombre.
Description
 description string

Descripción.
Operator
 filter.operator string

Operador .
Importancia
 filter.value string

Valor.
Ruta
 filter.path string

Ruta de acceso.

Obtener una lista

Id. de la operación:
ListGet

Recupere los elementos de una lista.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.

Devoluciones

Nombre Ruta de acceso Tipo Description
Creado
 created string

Cuando se crea.
identificación
 id string

Identificador.
Nombre
 name string

Nombre.
Actualizado
 updated string

Actualizado.

Obtener una marca

Id. de la operación:
BrandGet

Recupere una marca específica por identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de marca
 brand_id True string

Identificador de marca.

Devoluciones

Nombre Ruta de acceso Tipo Description
Creado
 created integer

Cuando se crea.
identificación
 id string

Identificador.
Nombre
 name string

Nombre.
Publicado
 published integer

Cuando se publica.
Actualizado
 updated integer

Actualizado.
Versión
 version string

La versión.
Primary
 settings.colors.primary string

Principal.
Secondary
 settings.colors.secondary string

Secundario.
Terciario
 settings.colors.tertiary string

El terciario.
Color de la barra
 settings.email.header.barColor string

Color de la barra.
HREF
 settings.email.header.logo.href string

The HREF.
Imagen
 settings.email.header.logo.image string

Imagen.
Markdown
 settings.email.footer.markdown string

Markdown.
URL
 settings.email.footer.social.facebook.url string

Dirección URL.
URL
 settings.email.footer.social.instagram.url string

Dirección URL.
URL
 settings.email.footer.social.linkedin.url string

Dirección URL.
URL
 settings.email.footer.social.medium.url string

Dirección URL.
URL
 settings.email.footer.social.twitter.url string

Dirección URL.
Deshabilitar icono de mensaje
 settings.inapp.disableMessageIcon boolean

Indica si se va a deshabilitar el icono del mensaje.
Colocación
 settings.inapp.placement string

Ubicación.
Productos
 snippets.items array of string

Los elementos.

Restaurar una lista

Id. de la operación:
ListRestorePut

Restaura una lista existente por identificador.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de lista
 list_id True string

Identificador de lista.

Devoluciones

response
string

Definiciones

cuerda / cadena

Este es el tipo de datos básico "string".

objeto

Este es el tipo 'objeto'.