Créditos e Limites
GETTING STARTED - MENU
Componentes Status Page
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

1
curl --request POST \
2
--url 'http://{{channel-api-base-url}}/v1/omni/send' \
3
--header 'authenticationtoken: 56xdJ3zs_ses51KyGM1b8py1CxCsba2sTT334hrs' \
4
--header 'content-type: application/json' \
5
--header 'username: [email protected]' \
6
--data '{
7
"contacts":
8
[
9
{
10
"contactInfo": {
11
"phone1": "5516981562829",
12
"phone2": "5516981562829",
13
"email": "[email protected]",
14
"recipientName": "Bruno Azenha"
15
}
16
},
17
{
18
"contactInfo": {
19
"phone1": "0",
20
"phone2": "5511982994265",
21
"email": "[email protected]",
22
"recipientName": "Bruno Farias"
23
}
24
}
25
],
26
"template":
27
{
28
"campaignAlias": "Campain Alias",
29
"steps":
30
[
31
{
32
"type": "MT",
33
"destinationField": "phone1",
34
"messageText": "First message.",
35
"flashSms": false
36
},
37
{
38
"type": "VOICE",
39
"destinationField": "phone2",
40
"ttsMessage": "This is the third message",
41
"timeout": 3
42
},
43
{
44
"type": "MT",
45
"destinationField": "phone1",
46
"messageText": "Second Message as Flash",
47
"flashSms": true
48
},
49
{
50
"type": "EMAIL",
51
"destinationField": "email",
52
"recipientName": "recipientName",
53
"subject": "Third message",
54
"replyTo": "[email protected]",
55
"fromEmail": "[email protected]",
56
"fromName": "Your name",
57
"emailText": "Email content as simple plain text",
58
"emailHtml": "Email content as HTML"
59
}
60
]
61
}
62
}'
Copied!
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