GETTING STARTED - MENU
Créditos e Limites
Componentes Status Page
TES

Fallback API

Documentação técnica: Fallback API

Fallback API

Esta API permite a automação dos envios utilizando vários canais diferentes (SMS, email e voz) no sistema de fallback (os envios são estruturados em passos e caso um desses passos falhe será executado o próximo especificado).

É utilizado o protocolo HTTP com TLS e é aceito o método POST com os parametros via JSON.

Autenticação

Para efetuar envios e consultas em nossa API é necessária a autenticação por meio de usuário ou e-mail, em conjunto com um token.

Campo

Detalhes

Data Type

UserName

Seu usuário ou email

String

AuthenticationToken

Seu token de autenticação. Verifique aqui e leia as descrições de usuários abaixo.

String

Detalhes de conexão

Hostname

api-messaging.wavy.global

APIs

Envios individuais /v1/omni/send

Porta

443 (https)

Protocolo

HTTPS (encriptação TLS)

Autenticação

username + token

Portal

messaging.wavy.global

Codificação (encoding)

O Padrão de codificação utilizado é o UTF-8, todo conteúdo das mensagens deve seguir esse padrão.

É possível escapar os caracteres caso deseje ou codificar utilizando o formato HTTP

Ao lado estão alguns exemplos de codificação

“messageText”:“A combinação foi perfeita :)”

Ou você pode escapar os caracteres caso queira:

“messageText”:“A combina\u00e7\u00e3o foi perfeita :)”

Envio por método POST

curl --request POST \
--url 'http://{{channel-api-base-url}}/v1/omni/send' \
--header 'authenticationtoken: 56xdJ3zs_ses51KyGM1b8py1CxCsba2sTT334hrs' \
--header 'content-type: application/json' \
--header 'username: [email protected]' \
--data '{
"contacts":
[
{
"contactInfo": {
"phone1": "5516981562829",
"phone2": "5516981562829",
"email": "[email protected]",
"recipientName": "Bruno Azenha"
}
},
{
"contactInfo": {
"phone1": "0",
"phone2": "5511982994265",
"email": "[email protected]",
"recipientName": "Bruno Farias"
}
}
],
"template":
{
"campaignAlias": "Campain Alias",
"steps":
[
{
"type": "MT",
"destinationField": "phone1",
"messageText": "First message.",
"flashSms": false
},
{
"type": "VOICE",
"destinationField": "phone2",
"ttsMessage": "This is the third message",
"timeout": 3
},
{
"type": "MT",
"destinationField": "phone1",
"messageText": "Second Message as Flash",
"flashSms": true
},
{
"type": "EMAIL",
"destinationField": "email",
"recipientName": "recipientName",
"subject": "Third message",
"replyTo": "[email protected]",
"fromEmail": "[email protected]",
"fromName": "Your name",
"emailText": "Email content as simple plain text",
"emailHtml": "Email content as HTML"
}
]
}
}'

POST https://api-messaging.wavy.global/v1/omni/send Content-Type: application/json

O corpo da requisição precisa conter o objeto JSON com as informações conforme campos abaixo:

* Campo obrigatório

Campo

Detalhes

Tipo

contacts*

Array de contatos que será efetuado as tentativas de entrega

Array[]

contactInfo*

Texto da mensagem que será enviada

String

phone

Telefone para qual será enviada a mensagem (incluso código de país). Exemplo: 5511900000000

Long

email

Email do destinatário

String

emailName

template*

Template com as informações sobre o fluxo que será executado

Array[]

campaignAlias

Identificação do Fallback

String

Steps*

Passos que serão executados nos Envios

Array[]

type*

tipo de envio (Email, MT, Voice)

String

destinationField

Deverá ser passado as informações criadas no campo contactInfo

String

subject*

Utilizado para envios de email, assunto do envio a ser realizado

String

fromEmail*

Email de origem

String

emailHTML*

Conteúdo em HTML a ser passado no corpo do email

String

messageText

Conteúdo da mensagem para envio de SMS

String

ttsMessage

Verificar phone******

IMPORTANTE!

Para cada usuário existe um token de autenticação único

Respostas da requisição

A resposta do envio em lote conterá um arquivo JSON com as informações necessárias para rastreio, será gerado um id para o lote todo e um id e correlationId individual para cada mensagem:

Campo

Detalhes

Tipo

id

UUID gerado para os envios

String