Courier (Editora Independente) (Pré-visualização)
Courier é um serviço e estúdio web para equipes de desenvolvimento para gerenciar todas as comunicações acionadas por produtos (e-mail, chat, in-app, SMS, push, etc.) em um só lugar. O Courier foi criado para desenvolvedores que desejam oferecer uma experiência de notificação excecional.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://www.courier.com/ |
| Política de privacidade | https://www.courier.com/privacy/ |
| Categorias | Comunicação; Redes Sociais |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token (na forma 'Bearer yourToken') | securestring | O Token (na forma 'Bearer yourToken') para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar assinante(s) a uma lista |
Adicione mais subscritores a uma lista. |
| Adicionar usuários a um trabalho em massa |
Ingerir dados do usuário em um trabalho em massa. |
| Arquivar uma mensagem |
Solicite que uma mensagem seja arquivada. |
| Atualizar um perfil |
Atualizações em uma parte de um perfil. |
| Atualizar uma lista |
Cria ou substitui uma lista existente pelos valores fornecidos. |
| Cancelar a inscrição de um usuário de uma lista |
Exclui uma assinatura de uma lista por lista e identificadores de destinatário. |
| Criar ou atualizar um público |
Cria ou atualiza um público com base nos parâmetros e filtros fornecidos. |
| Criar um perfil |
Mescle os valores fornecidos com um perfil existente ou crie um novo perfil, se ainda não existir. |
| Criar um trabalho em massa |
Cria um trabalho em massa para os parâmetros de mensagem fornecidos. |
| Criar uma marca |
Cria uma nova marca a partir das configurações fornecidas. |
| Eliminar uma lista |
Exclui uma lista por identificador de lista. |
| Enviar uma mensagem |
Envia uma mensagem para um ou mais destinatários. |
| Excluir um perfil |
Exclui o perfil de destinatário especificado. |
| Excluir um público |
Exclui o público destinatário especificado. |
| Executar um trabalho em massa |
Comece a executar um trabalho em massa. |
| Executar uma automação ad-hoc |
Invoque uma automação em uma execução ad-hoc. |
| Executar uma automação modelada |
Invoque uma execução de automação a partir de um modelo de automação. |
| Listar marcas |
Recupere uma lista de marcas. |
| Listar membros do público |
Recuperar uma lista de membros de uma audiência. |
| Listar mensagens |
Recupere os status de mensagens enviadas anteriormente. |
| Listar notificações |
Recupera uma lista de notificações. |
| Listar todos os públicos |
Recupere todos os públicos associados à sua conta. |
| Obter o conteúdo de uma mensagem |
Recuperar o conteúdo de uma mensagem enviada anteriormente. |
| Obter o histórico de uma mensagem |
Recupere os eventos de uma mensagem enviada anteriormente. |
| Obter subscrições da lista |
Recupera as assinaturas de uma lista. |
| Obter todas as listas de destinatários |
Recupere uma lista de todas as listas de destinatários. |
| Obter todos os eventos de auditoria |
Recupere uma lista de eventos de auditoria. |
| Obter um evento de auditoria |
Recupere um evento de auditoria específico por identificador. |
| Obter um perfil |
Recupera o perfil de destinatário especificado. |
| Obter um público |
Retorna a audiência especificada por identificador. |
| Obter um trabalho em massa |
Recupere as informações sobre um trabalho em massa. |
| Obter uma lista |
Recuperar os itens de uma lista. |
| Obter uma marca |
Recupere uma marca específica por identificador. |
| Obter usuários de um trabalho em massa |
Recupere os usuários de um trabalho em massa. |
| Receber uma mensagem |
Recuperar o status de uma mensagem. |
| Restaurar uma lista |
Restaura uma lista existente por identificador. |
Adicionar assinante(s) a uma lista
Adicione mais subscritores a uma lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
|
ID do destinatário
|
recipientId | string |
O identificador de destinatário. |
Devoluções
- response
- string
Adicionar usuários a um trabalho em massa
Ingerir dados do usuário em um trabalho em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
O identificador de trabalho. |
|
Recipient
|
recipient | string |
O destinatário. |
Devoluções
- response
- string
Arquivar uma mensagem
Solicite que uma mensagem seja arquivada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de solicitação
|
request_id | True | string |
O identificador de solicitação. |
Devoluções
- response
- string
Atualizar um perfil
Atualizações em uma parte de um perfil.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipient_id | True | string |
O identificador de destinatário. |
|
Funcionamento
|
op | string |
A operação. |
|
|
Caminho
|
path | string |
O caminho. |
|
|
Valor
|
value | string |
O valor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
O status. |
Atualizar uma lista
Cria ou substitui uma lista existente pelos valores fornecidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
|
Nome
|
name | string |
O nome. |
Devoluções
- response
- string
Cancelar a inscrição de um usuário de uma lista
Exclui uma assinatura de uma lista por lista e identificadores de destinatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
|
ID do destinatário
|
recipient_id | True | string |
O identificador de destinatário. |
Devoluções
- response
- string
Criar ou atualizar um público
Cria ou atualiza um público com base nos parâmetros e filtros fornecidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do público
|
audience_id | True | string |
O identificador de audiência. |
|
Nome
|
name | string |
O nome. |
|
|
Caminho
|
path | string |
O caminho. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Valor
|
value | string |
O valor. |
|
|
Caminho
|
path | string |
O caminho. |
|
|
Operator
|
operator | string |
O operador. |
|
|
Valor
|
value | string |
O valor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
|
Operator
|
filter.operator | string |
O operador. |
|
Valor
|
filter.value | string |
O valor. |
|
Caminho
|
filter.path | string |
O caminho. |
|
Filtros
|
filter.filters | array of object | |
|
Caminho
|
filter.filters.path | string |
O caminho. |
|
Operator
|
filter.filters.operator | string |
O operador. |
|
Valor
|
filter.filters.value | string |
O valor. |
Criar um perfil
Mescle os valores fornecidos com um perfil existente ou crie um novo perfil, se ainda não existir.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipient_id | True | string |
O identificador de destinatário. |
|
Email
|
string |
O endereço de e-mail. |
||
|
Número de Telefone
|
phone_number | string |
O número de telefone. |
|
|
Formatado
|
formatted | string |
O endereço formatado. |
|
|
Endereço
|
street_address | string |
O endereço. |
|
|
Localidade
|
locality | string |
A localidade. |
|
|
Região
|
region | string |
A região. |
|
|
Código Postal
|
postal_code | string |
O código postal. |
|
|
Country
|
country | string |
O país. |
|
|
Data de nascimento
|
birthdate | string |
A data de nascimento. |
|
|
E-mail verificado
|
email_verified | boolean |
Se o e-mail foi verificado. |
|
|
Número de telefone verificado
|
phone_number_verified | boolean |
Se o número de telefone foi verificado. |
|
|
Nome Próprio
|
given_name | string |
O nome próprio. |
|
|
Segundo Nome
|
middle_name | string |
O nome do meio. |
|
|
Nome de família
|
family_name | string |
O nome de família. |
|
|
Nome preferido
|
preferred_name | string |
O nome preferido. |
|
|
Sexo
|
gender | string |
O género. |
|
|
Localidade
|
locale | string |
A localidade. |
|
|
Imagem
|
picture | string |
A imagem. |
|
|
Profile
|
profile | string |
O perfil. |
|
|
Substituto
|
sub | string |
O sub. |
|
|
Atualizado em
|
updated_at | string |
Quando atualizado em. |
|
|
Sítio Web
|
website | string |
O sítio Web. |
|
|
Informação da Zona
|
zoneinfo | string |
As informações da zona. |
|
|
Usuário nomeado
|
named_user | string |
O usuário nomeado. |
|
|
Tipos de dispositivos
|
device_types | array of string |
Os tipos de dispositivos. |
|
|
APN
|
apn | string |
A APN. |
|
|
ARN alvo
|
target_arn | string |
O ARN alvo. |
|
|
ID do canal
|
channel_id | string |
O identificador do canal. |
|
|
ID de utilizador
|
user_id | string |
O identificador do usuário. |
|
|
Símbolo
|
token | string |
O token. |
|
|
Tokens
|
tokens | array of string |
Os tokens. |
|
|
Facebook PS ID
|
facebookPSID | string |
O identificador PS do Facebook. |
|
|
Firebase Token
|
firebaseToken | string |
O token do Firebase. |
|
|
De
|
from | string |
o de. |
|
|
ID
|
id | string |
O identificador. |
|
|
ID de utilizador
|
user_id | string |
O identificador do usuário. |
|
|
ID da conversação
|
conversation_id | string |
O identificador de conversa. |
|
|
ID do inquilino
|
tenant_id | string |
O identificador do locatário. |
|
|
URL do serviço
|
service_url | string |
O endereço URL do serviço. |
|
|
ID do jogador OneSignal
|
oneSignalPlayerID | string |
O identificador OneSignal Player. |
|
|
Token de Acesso
|
access_token | string |
O token de acesso. |
|
|
Channel
|
channel | string |
O canal. |
|
|
Email
|
string |
O endereço de e-mail. |
||
|
ID de utilizador
|
user_id | string |
O identificador do usuário. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
Método
|
method | string |
Os métodos. |
|
|
Mode
|
mode | string |
O modo. |
|
|
Nome de utilizador
|
username | string |
O nome de usuário. |
|
|
Palavra-passe
|
password | string |
A senha. |
|
|
Símbolo
|
token | string |
O token. |
|
|
Profile
|
profile | string |
O perfil. |
Devoluções
- response
- string
Criar um trabalho em massa
Cria um trabalho em massa para os parâmetros de mensagem fornecidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Event
|
event | string |
O evento. |
|
|
Marca
|
brand | string |
A marca. |
|
|
Template
|
template | string |
O modelo. |
|
|
ID da marca
|
brand_id | string |
O identificador da marca. |
|
|
Método
|
method | string |
O método. |
|
|
Channels
|
channels | array of string |
Os canais. |
|
|
Event
|
event | string |
O evento. |
|
|
Etiquetas
|
tags | array of string |
As tags. |
|
|
ID de rastreamento
|
trace_id | string |
O identificador de rastreamento. |
|
|
Campanha
|
campaign | string |
A campanha. |
|
|
Content
|
content | string |
O conteúdo. |
|
|
Médio
|
medium | string |
O médium. |
|
|
Fonte
|
source | string |
A fonte. |
|
|
Term
|
term | string |
O termo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do trabalho
|
jobId | string |
O identificador de trabalho. |
Criar uma marca
Cria uma nova marca a partir das configurações fornecidas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
|
Nome
|
name | True | string |
O nome. |
|
Primary
|
primary | string |
O primário. |
|
|
Secundária
|
secondary | string |
O secundário. |
|
|
Terciário
|
tertiary | string |
O terciário. |
|
|
Cor da barra
|
barColor | string |
A cor da barra. |
|
|
HREF
|
href | string |
O HREF. |
|
|
Imagem
|
image | string |
A imagem. |
|
|
Markdown
|
markdown | string |
O markdown. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
URL
|
url | string |
O endereço URL. |
|
|
Desativar ícone de mensagem
|
disableMessageIcon | boolean |
Se o ícone de mensagem deve ser desativado. |
|
|
Colocação
|
placement | string |
A colocação. |
|
|
Itens
|
items | array of string |
Os itens. |
Devoluções
- response
- string
Eliminar uma lista
Exclui uma lista por identificador de lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
Devoluções
- response
- string
Enviar uma mensagem
Envia uma mensagem para um ou mais destinatários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Idempotência
|
idempotency | True | string |
A chave de idempotência. |
|
Title
|
title | string |
O título. |
|
|
Body
|
body | string |
O corpo. |
|
|
ID de utilizador
|
user_id | string |
O identificador do usuário. |
|
|
ID da lista
|
list_id | string |
O identificador da lista. |
|
|
ID do público
|
audience_id | string |
O identificador de audiência. |
|
|
Email
|
string |
O endereço de e-mail. |
||
|
Número de Telefone
|
phone_number | string |
O número de telefone. |
|
|
Localidade
|
locale | string |
A localidade. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de solicitação
|
requestId | string |
O identificador de solicitação. |
Excluir um perfil
Exclui o perfil de destinatário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipient_id | True | string |
O identificador de destinatário. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
O status. |
Excluir um público
Exclui o público destinatário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do público
|
audience_id | True | string |
O identificador de audiência. |
Devoluções
- response
- string
Executar um trabalho em massa
Comece a executar um trabalho em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
O identificador de trabalho. |
Devoluções
- response
- object
Executar uma automação ad-hoc
Invoque uma automação em uma execução ad-hoc.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Token de cancelamento
|
cancelation_token | string |
O token de cancelamento. |
|
|
Marca
|
brand | string |
A marca. |
|
|
Template
|
template | string |
O modelo. |
|
|
Recipient
|
recipient | string |
O destinatário. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de execução
|
runId | string |
O identificador de execução. |
Executar uma automação modelada
Invoque uma execução de automação a partir de um modelo de automação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId | True | string |
O identificador do modelo. |
|
Marca
|
brand | string |
A marca. |
|
|
Template
|
template | string |
O modelo. |
|
|
Recipient
|
recipient | string |
O destinatário. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de execução
|
runId | string |
O identificador de execução. |
Listar marcas
Recupere uma lista de marcas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Results
|
results | array of object | |
|
Criado
|
results.created | integer |
Quando criado. |
|
ID
|
results.id | string |
O identificador. |
|
Nome
|
results.name | string |
O nome. |
|
Publicado
|
results.published | integer |
Quando publicado. |
|
Updated
|
results.updated | integer |
Quando atualizado. |
|
Versão
|
results.version | string |
A versão. |
|
Primary
|
results.settings.colors.primary | string |
O primário. |
|
Secundária
|
results.settings.colors.secondary | string |
O secundário. |
|
Terciário
|
results.settings.colors.tertiary | string |
O terciário. |
|
Cor da barra
|
results.settings.email.header.barColor | string |
A cor da barra. |
|
HREF
|
results.settings.email.header.logo.href | string |
O HREF. |
|
Imagem
|
results.settings.email.header.logo.image | string |
A imagem. |
|
Markdown
|
results.settings.email.footer.markdown | string |
O markdown. |
|
URL
|
results.settings.email.footer.social.facebook.url | string |
O endereço URL. |
|
URL
|
results.settings.email.footer.social.instagram.url | string |
O endereço URL. |
|
URL
|
results.settings.email.footer.social.linkedin.url | string |
O endereço URL. |
|
URL
|
results.settings.email.footer.social.medium.url | string |
O endereço URL. |
|
URL
|
results.settings.email.footer.social.twitter.url | string |
O endereço URL. |
|
Desativar ícone de mensagem
|
results.settings.inapp.disableMessageIcon | boolean |
Se o ícone de mensagem deve ser desativado. |
|
Colocação
|
results.settings.inapp.placement | string |
A colocação. |
|
Itens
|
results.snippets.items | array of string |
Os itens. |
Listar membros do público
Recuperar uma lista de membros de uma audiência.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do público
|
audience_id | True | string |
O identificador de audiência. |
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
items | array of object | |
|
ID de Membro
|
items.member_id | string |
O identificador de membro. |
|
Adicionado em
|
items.added_at | string |
Quando adicionado em. |
|
ID do público
|
items.audience_id | string |
O identificador de audiência. |
|
Versão para o público
|
items.audience_version | integer |
A versão para o público. |
|
Reason
|
items.reason | string |
O motivo. |
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
Listar mensagens
Recupere os status de mensagens enviadas anteriormente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Arquivado
|
archived | boolean |
Se arquivado. |
|
|
Cursor
|
cursor | string |
O cursor. |
|
|
Event
|
event | string |
O evento. |
|
|
List
|
list | string |
A lista. |
|
|
ID da mensagem
|
messageId | string |
O identificador da mensagem. |
|
|
Notification
|
notification | string |
A notificação. |
|
|
Recipient
|
recipient | string |
O destinatário. |
|
|
Situação
|
status | string |
O status. |
|
|
Etiquetas
|
tags | string |
As tags. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
O identificador. |
|
Situação
|
results.status | string |
O status. |
|
Enfileirado
|
results.enqueued | integer |
O enfileirado. |
|
Enviado
|
results.sent | integer |
O enviado. |
|
Entregues
|
results.delivered | integer |
O entregue. |
|
Aberto
|
results.opened | integer |
O aberto. |
|
Clicou
|
results.clicked | integer |
O clicado. |
|
Recipient
|
results.recipient | string |
O destinatário. |
|
Event
|
results.event | string |
O evento. |
|
Notification
|
results.notification | string |
A notificação. |
|
Erro
|
results.error | string |
O erro. |
|
Reason
|
results.reason | string |
O motivo. |
Listar notificações
Recupera uma lista de notificações.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Results
|
results | array of object | |
|
Criado em
|
results.created_at | integer |
Quando criado em. |
|
ID
|
results.id | string |
O identificador. |
|
Data
|
results.tags.data | array of object | |
|
ID
|
results.tags.data.id | string |
O identificador. |
|
Nome
|
results.tags.data.name | string |
O nome. |
|
Title
|
results.title | string |
O título. |
|
Atualizado em
|
results.updated_at | integer |
Quando atualizado em. |
Listar todos os públicos
Recupere todos os públicos associados à sua conta.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
items | array of object | |
|
ID
|
items.id | string |
O identificador. |
|
Nome
|
items.name | string |
O nome. |
|
Description
|
items.description | string |
A descrição. |
|
Operator
|
items.filter.operator | string |
O operador. |
|
Valor
|
items.filter.value | string |
O valor. |
|
Caminho
|
items.filter.path | string |
O caminho. |
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
Obter o conteúdo de uma mensagem
Recuperar o conteúdo de uma mensagem enviada anteriormente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
message_id | True | string |
O identificador da mensagem. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Channel
|
results.channel | string |
O canal. |
|
ID do canal
|
results.channel_id | string |
O identificador do canal. |
|
HTML
|
results.content.html | string |
O HTML. |
|
Assunto
|
results.content.subject | string |
O assunto. |
|
Texto
|
results.content.text | string |
O texto. |
|
Blocos
|
results.content.blocks | array of object | |
|
Tipo
|
results.content.blocks.type | string |
O tipo. |
|
Texto
|
results.content.blocks.text | string |
O texto. |
Obter o histórico de uma mensagem
Recupere os eventos de uma mensagem enviada anteriormente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
message_id | True | string |
O identificador da mensagem. |
|
Tipo
|
type | string |
O tipo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Nome
|
results.data.name | string |
O nome. |
|
Event
|
results.event | string |
O evento. |
|
Recipient
|
results.recipient | string |
O destinatário. |
|
TS
|
results.ts | integer |
O TS. |
|
Tipo
|
results.type | string |
O tipo. |
|
ID do Evento
|
results.event_id | string |
O identificador de evento. |
|
ID da notificação
|
results.notification_id | string |
O identificador de notificação. |
|
ID
|
results.channel.id | string |
O identificador. |
|
ID
|
results.integration.id | string |
O identificador. |
|
Provider
|
results.integration.provider | string |
O provedor. |
Obter subscrições da lista
Recupera as assinaturas de uma lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Itens
|
items | array of object | |
|
ID do destinatário
|
items.recipientId | string |
O identificador de destinatário. |
|
Criado
|
items.created | string |
Quando criado. |
Obter todas as listas de destinatários
Recupere uma lista de todas as listas de destinatários.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Results
|
results | array of object | |
|
Criado
|
results.created | string |
Quando criado. |
|
ID
|
results.id | string |
O identificador. |
|
Nome
|
results.name | string |
O nome. |
|
Updated
|
results.updated | string |
Quando atualizado. |
Obter todos os eventos de auditoria
Recupere uma lista de eventos de auditoria.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
O cursor. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
|
Results
|
results | array of object | |
|
ID do evento de auditoria
|
results.auditEventId | string |
O identificador de evento de auditoria. |
|
ID
|
results.actor.id | string |
O identificador. |
|
Email
|
results.actor.email | string |
O endereço de e-mail. |
|
ID
|
results.target.id | string |
O identificador. |
|
Email
|
results.target.email | string |
O endereço de e-mail. |
|
Fonte
|
results.source | string |
A fonte. |
|
Data e Hora
|
results.timestamp | string |
O carimbo de data/hora. |
|
Tipo
|
results.type | string |
O tipo. |
Obter um evento de auditoria
Recupere um evento de auditoria específico por identificador.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do evento de auditoria
|
audit-event-id | True | string |
O identificador de evento de auditoria. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do evento de auditoria
|
auditEventId | string |
O identificador de evento de auditoria. |
|
ID
|
actor.id | string |
O identificador. |
|
Email
|
actor.email | string |
O endereço de e-mail. |
|
ID
|
target.id | string |
O identificador. |
|
Email
|
target.email | string |
O endereço de e-mail. |
|
Fonte
|
source | string |
A fonte. |
|
Data e Hora
|
timestamp | string |
O carimbo de data/hora. |
|
Tipo
|
type | string |
O tipo. |
Obter um perfil
Recupera o perfil de destinatário especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
recipient_id | True | string |
O identificador de destinatário. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Email
|
profile.email | string |
O endereço de e-mail. |
|
Número de Telefone
|
profile.phone_number | string |
O número de telefone. |
Obter um público
Retorna a audiência especificada por identificador.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do público
|
audience_id | True | string |
O identificador de audiência. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
|
Operator
|
filter.operator | string |
O operador. |
|
Valor
|
filter.value | string |
O valor. |
|
Caminho
|
filter.path | string |
O caminho. |
Obter um trabalho em massa
Recupere as informações sobre um trabalho em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
O identificador de trabalho. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Event
|
job.definition.event | string |
O evento. |
|
Enfileirado
|
job.enqueued | integer |
O enfileirado. |
|
Falhas
|
job.failures | integer |
As falhas. |
|
Recebido
|
job.received | integer |
Quando recebido. |
|
Situação
|
job.status | string |
O status. |
Obter uma lista
Recuperar os itens de uma lista.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado
|
created | string |
Quando criado. |
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Updated
|
updated | string |
O atualizado. |
Obter uma marca
Recupere uma marca específica por identificador.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brand_id | True | string |
O identificador da marca. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado
|
created | integer |
Quando criado. |
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Publicado
|
published | integer |
Quando publicado. |
|
Updated
|
updated | integer |
O atualizado. |
|
Versão
|
version | string |
A versão. |
|
Primary
|
settings.colors.primary | string |
O primário. |
|
Secundária
|
settings.colors.secondary | string |
O secundário. |
|
Terciário
|
settings.colors.tertiary | string |
O terciário. |
|
Cor da barra
|
settings.email.header.barColor | string |
A cor da barra. |
|
HREF
|
settings.email.header.logo.href | string |
O HREF. |
|
Imagem
|
settings.email.header.logo.image | string |
A imagem. |
|
Markdown
|
settings.email.footer.markdown | string |
O markdown. |
|
URL
|
settings.email.footer.social.facebook.url | string |
O endereço URL. |
|
URL
|
settings.email.footer.social.instagram.url | string |
O endereço URL. |
|
URL
|
settings.email.footer.social.linkedin.url | string |
O endereço URL. |
|
URL
|
settings.email.footer.social.medium.url | string |
O endereço URL. |
|
URL
|
settings.email.footer.social.twitter.url | string |
O endereço URL. |
|
Desativar ícone de mensagem
|
settings.inapp.disableMessageIcon | boolean |
Se o ícone de mensagem deve ser desativado. |
|
Colocação
|
settings.inapp.placement | string |
A colocação. |
|
Itens
|
snippets.items | array of string |
Os itens. |
Obter usuários de um trabalho em massa
Recupere os usuários de um trabalho em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
O identificador de trabalho. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
items | array of object | |
|
Recipient
|
items.recipient | string |
O destinatário. |
|
Email
|
items.email | string |
O endereço de e-mail. |
|
Localidade
|
items.locale | string |
A localidade. |
|
Cursor
|
paging.cursor | string |
O cursor. |
|
Saber mais
|
paging.more | boolean |
Se há mais. |
Receber uma mensagem
Recuperar o status de uma mensagem.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
message_id | True | string |
O identificador da mensagem. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Situação
|
status | string |
O status. |
|
Enfileirado
|
enqueued | integer |
O enfileirado. |
|
Enviado
|
sent | integer |
O enviado. |
|
Entregues
|
delivered | integer |
O entregue. |
|
Aberto
|
opened | integer |
O aberto. |
|
Clicou
|
clicked | integer |
O clicado. |
|
Recipient
|
recipient | string |
O destinatário. |
|
Event
|
event | string |
O evento. |
|
Notification
|
notification | string |
A notificação. |
|
Erro
|
error | string |
O erro. |
|
Reason
|
reason | string |
O motivo. |
|
Providers
|
providers | array of object | |
|
Enviado
|
providers.sent | integer |
O enviado. |
|
Entregues
|
providers.delivered | integer |
O entregue. |
|
Clicou
|
providers.clicked | integer |
O clicado. |
|
Aberto
|
providers.opened | integer |
O aberto. |
|
Erro
|
providers.error | string |
O erro. |
|
Provider
|
providers.provider | string |
O provedor. |
|
Situação
|
providers.status | string |
O status. |
Restaurar uma lista
Restaura uma lista existente por identificador.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da lista
|
list_id | True | string |
O identificador da lista. |
Devoluções
- response
- string
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.
objecto
Este é o tipo 'objeto'.