{% endhint %} ### Vamos começar? Para a primeira ativação o ticket é aberto automaticamente após assinatura de contrato, então fique tranquilo que vamos te contatar para iniciar. Para as demais ativações , é necessário abrir um ticket na nossa plataforma de Customer Service: [LATAM / ](https://tickets.sinch.com/plugins/servlet/desk/portal/3?requestGroup=103)[GLOBAL Applications | Help Center (sinch.com)](https://tickets.sinch.com/plugins/servlet/desk/portal/3?requestGroup=103). Ao entrar no Customer Service, cadastre-se; 2\. Após o cadastro, selecione Onboarding; 3\. Na sequência, clique em "[**I Want to connect with Sinch**](https://tickets.sinch.com/plugins/servlet/desk/portal/3?requestGroup=149)" 4\. Preencha o formulário; 5\. Clique em criar; 6\. Acompanhe o ticket na plataforma ou por email para ser informado dos próximos passos.
| API HTTPS | Permite o envio e recebimento de mensagens e status através do protocolo HTTPS utilizando os métodos GET ou POST |
| API SMPP | Protocolo especifico para troca de mensagens SMS, permite manter uma conexão ativa constante com nosso servidor SMPP, e é indicado para clientes com tráfego superior a 5 milhões de mensagens por mês |
| API SFTP | Protocolo utilizado para transferência de arquivos, é indicado para envios de mensagens em massa (lote). Os arquivos são transferidos pelo cliente para nossos servidores, e são imediatamente processados |
| Websphere MQ | Utilizado para transferência de mensagens entre servidores Websphere MQ, é indicado para clientes com tráfego superior a 30 milhões de mensagens por mês, principalmente para bancos financeiros, onde o cliente já possui este sistema em funcionamento para mensagens internas. Esta opção de integração possui um valor de setup e manutenção de ambiente, fixados em R$50.000,00 e R$2.000,00 respectivamente |
| MT | Mobile Terminated | É o termo utilizado para mensagens que possuem o usuário (aparelho) como destino. Ou seja, mensagens que foram originadas por sua empresa, com destino ao usuário (aparelho). |
| Response | Resposta sincrona da Sinch | É a resposta imediata de uma requisição feita em nossa API, onde informamos se a mensagem foi aceita ou não por nossa plataforma. |
| Callback | Sent status ou status de envio | É o primeiro status de envio que retornamos, onde informamos se foi possível, ou não, fazer a entrega da mensagem para a operadora. |
| DR ou DLR | Delivery Receipt | É o segundo status de envio que retornamos, onde informamos se foi possível, ou não, fazer a entrega para o aparelho. As operadoras enviam para a Sinch esta informação, e nós repassamos para o cliente. O tempo de entrega é variável, por exemplo, se o aparelho estava desligado no momento do envio, e o usuário ligou 2 horas depois, este status DLR será entregue para o cliente, com duas horas de atraso. Obs1: Esta confirmação de entrega no aparelho existirá somente para os casos em que a mensagem foi entregue com sucesso na operadora, ou seja, o primeiro status (callback) foi de sucesso. Obs2: É muito importante ressaltar, que, infelizmente, as operadoras OI e Sercomtel não possuem esta funcionalidade, ou seja, não nos retornam a informação de entrega no aparelho. Os envios feitos para números destas operadoras, terão somente a informação de entrega na operadora (callback) |
| MO | Mobile Originated | É o termo utilizado para mensagens que possuem sua empresa como destino. Ou seja, mensagens que foram originadas pelo usuário (aparelho). É utilizado por exemplo, em fluxos de pergunta e respostas via SMS, quando é necessário uma confirmação por parte do usuário. |
| LA | Short Code | Número curto de 5 ou 6 dígitos, utilizado para envio e recebimento de mensagens SMS. São designados pelas operadoras para integradores homologados (Sinch), e possuem regras anti-fraude e anti-spam |
| Retorno de chamada ou IDR | Status enviado | O primeiro status de entrega (ou Intermediate Delivery Status) que devolvemos, onde informamos se foi possível entregar a mensagem à transportadora, ou não. |
| Campo | Detalhes | Data Type |
|---|---|---|
| Campo | Detalhes | Data Type |
| UserName | Seu usuário ou email | String |
| Authentication Token | Seu token de autenticação. Adquira o seu aqui (mesmo link). | String |
| TemplateID | Identificador de modelo de SMS. O texto da mensagem será recuperado e deve ser criado primeiro por meio do Portal do Messaging. | Long |
| TemplateName | Nome do modelo de SMS. Pode não ser exclusivo, resultando em erro se mais de um modelo for encontrado para o nível de acesso do usuário. O texto da mensagem será recuperado e deve ser criado primeiro por meio do Portal do Messaging. | String |
| Campo | Detalhes |
|---|---|
| Hostname | api-messaging.wavy.global |
| API's | Envios individuais /v1/send-sms Envios em lote /v1/send-bulk-sms |
| Porta | 443 (https) |
| Protocolo | HTTPS (encriptação TLS) |
| Autenticação | username + token |
| Portal | messaging.wavy.global |
| Campo | Detalhes | Tipo |
|---|---|---|
| destination* | Telefone para qual será enviada a mensagem (incluido código de país). Exemplo: 5511900000000 | String |
| messageText* | Texto da mensagem que será enviada (max 1280 chars). | String |
| correlationId | Um ID único definido por você para batimento com os status de envio (callback e DLR). Este parâmetro é opcional, e você pode utilizar o ID gerado pela Wavy para este batimento (max 64 chars). | String |
| extraInfo | Qualquer informação extra que você deseja adicionar a mensagem (max 255 chars). | String |
| timeWindow | Mensagens serão enviadas apenas no horário especificado. Por exemplo, Se você configurar uma janela [11, 12, 18], as mensagens serão enviadas entre 11:00 e 11:59, 12:00 e 12:59 e 18:00 e 18:59, este parâmetro deve ser definido na raiz do objeto JSON | Integer[] |
| expiresAt | A mensagem não será enviada após esta data. O formato utilizado é o Unix time . Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| expiresInMinutes | A mensagem será expirada após o tempo informado neste campo. O tempo passa a ser ontabilizado assim que a mensagem é recebida pela Wavy.. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| expiresDate | A mensagem não será enviada após esta data. O campo aceita o seguinte formato yyyy-MM-dd’T'HH:mm:ss. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | String |
| scheduledAt | A mensagem não será enviada após esta data. IMPORTANTE! É possivel realizar o agendamento apenas em um periodo superior a 30 minutos, pois é processado por um fluxo diferenciado do envio sem agendamento. O formato utilizado é o Unix time. Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| delayedInMinutes | Minutos depois que a requisição é feita que a mensagem será enviada. Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| scheduledDate | A mensagem não será enviada antes desta data. O campo suporta o seguinte formato yyyy-MM-dd’T'HH:mm:ss. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | String |
| timeZone | Especifica o timezone que será utilizado diretamente nos campos: expiresDate, scheduledDate and timeWindow (que será modificado caso seja utilizado timezones dinamicos, como os com horário de verão). Se o timezone não estiver presente na requisição o sistema irá verificar o timezone do usuário - se presente - ou o timezone do país do usuário em último caso. Se nenhuma das opções estiverem presentes, o sistema irá utlizar o horário UTC | String |
| campaignAlias | Identificação de campanha criada previamente. Clique aqui para registar uma nova campanha, este parâmetro deve ser definido na raiz do objeto JSON | String |
| flashSMS | Flash SMS, use esta opção para enviar uma mensagem pop-up no telefone do usuário. Para enviar uma mensagem Flash passe o parametro true. | Boolean |
| flowId | Identificador do fluxo de Bot. O texto da mensagem virá do fluxo selecionado | String |
| subAccount | Referência da subconta. Ela só pode ser utilizada por usuários Administradores | String |
| params | Mapa de placeholders que serão substituídos no texto da mensagem. Se um ou mais parâmetros estiverem incorretos, a mensagem será marcada como inválida, mas o envio não será cancelado. É necessário enviar o flowId para utilizar os parâmetros | Map |
| Campo | Detalhes | Tipo |
|---|---|---|
| destination* | Telefone para qual será enviada a mensagem (incluido código de país). Exemplo: 5511900000000 | String |
| messageText* | Texto da mensagem que será enviada (max 1280 chars). | String |
| correlationId | Um ID único definido por você para batimento com os status de envio (callback e DLR). Este parâmetro é opcional, e você pode utilizar o ID gerado pela Wavy para este batimento (max 64 chars). | String |
| extraInfo | Qualquer informação extra que você deseja adicionar a mensagem (max 255 chars). | String |
| timeWindow | Mensagens serão enviadas apenas no horário especificado. Por exemplo, Se você configurar uma janela [11, 12, 18], as mensagens serão enviadas entre 11:00 e 11:59, 12:00 e 12:59 e 18:00 e 18:59 | Integer[] |
| expiresAt | A mensagem não será enviada após esta data. O formato utilizado é o Unix time . Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| expiresInMinutes | A mensagem será expirada após o tempo informado neste campo. O tempo passa a ser ontabilizado assim que a mensagem é recebida pela Wavy.. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| expiresDate | A mensagem não será enviada após esta data. O campo aceita o seguinte formato yyyy-MM-dd’T'HH:mm:ss. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | String |
| scheduledAt | A mensagem não será enviada após esta data. O formato utilizado é o Unix time. Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| delayedInMinutes | Minutos depois que a requisição é feita que a mensagem será enviada. Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | Long |
| scheduledDate | A mensagem não será enviada antes desta data. O campo suporta o seguinte formato yyyy-MM-dd’T'HH:mm:ss. Obs: Os campos expiresAt, expiresInMinutes e expiresDate são mutuamente exclusivos (use somente um deles) | String |
| timeZone | Especifica o timezone que será utilizado diretamente nos campos: expiresDate, scheduledDate and timeWindow (que será modificado caso seja utilizado timezones dinamicos, como os com horário de verão). Se o timezone não estiver presente na requisição o sistema irá verificar o timezone do usuário - se presente - ou o timezone do país do usuário em último caso. Se nenhuma das opções estiverem presentes, o sistema irá utlizar o horário UTC | String |
| campaignAlias | Identificação de campanha criada previamente. Clique aqui para registar uma nova campanha | String |
| flashSMS | Flash SMS, use esta opção para enviar uma mensagem pop-up no telefone do usuário. Para enviar uma mensagem Flash passe o parametro true. | Boolean |
| flowId | Identificador do fluxo de Bot. O texto da mensagem virá do fluxo selecionado | String |
| subAccount | Referência da subconta. Ela só pode ser utilizada por usuários Administradores | String |
| params | Mapa de placeholders que serão substituídos no texto da mensagem. Se um ou mais parâmetros estiverem incorretos, a mensagem será marcada como inválida, mas o envio não será cancelado. É necessário enviar o flowId para utilizar os parâmetros | Map |
| Campo | Detalhes | Tipo |
|---|---|---|
| id | UUID gerado para este lote | String |
| messages | Este campo é um array com as respostas das mensanges individuais do lote, contém o id e o correlationId de cada mensagem enviada | SingleSMSResponse[] |
| Grupo | Descrição |
|---|---|
| 2xx | Sucesso |
| 4xx | Erro Cliente |
| 5xx | Erro Servidor |
| Código | Descrição |
|---|---|
| 200 | Sucesso |
| 400 | Requisição errada |
| 401 | Sem autorização |
| 403 | Proibido |
| 404 | Não encontrado |
| 500 | Erro Interno do Servidor |
| 503 | Serviço indiponível |
| 504 | Gateway Timeout |
| Campo | Descrição |
|---|---|
| id | UUID gerado da mensagem |
| correlationId | Sua identificação desta mensagem |
| carrierId | Identificador da operadora |
| carrierName | Nome da operadora |
| destination | Número de telefone da mensagem enviada |
| sentStatusCode | Código de status gerado pelo Sinch para mensagem indicando o status de envio. Verifique em códigos de status para mais informações |
| sentStatus | Descrição do status de envio. Verifique em códigos de status para mais informações |
| sentAt | Hora do envio, formato utilizado é o Unix_time |
| sentDate | Data que a mensagem foi enviada. Formato: yyyy-MM-dd’T'HH:mm:ssZ |
| campaignId | Identificador de campanha caso exista |
| extraInfo | Qualquer informação extra adicionada pelo cliente no envio da mensagem |
| multipartCount | Total de partes que teve o disparo |
| partId | O UUID da parte da mensagem enviada a operadora |
| part | O número da parte enviada a operadora |
| Campo | Descrição |
|---|---|
| id | UUID gerado da mensagem |
| correlationId | Sua identificação desta mensagem |
| carrierId | Identificador da operadora |
| carrierName | Nome da operadora |
| destination | Número de telefone da mensagem enviada |
| sentStatusCode | Código de status gerado pela Sinch para mensagem indicando o status de envio. Verifique em códigos de status para mais informações |
| sentStatus | descrição do status de envio. Verifique em códigos de status para mais informações |
| sentAt | Hora do envio, formato utilizado é o Unix_time |
| sentDate | Data que a mensagem foi enviada. Formato: yyyy-MM-dd’T'HH:mm:ssZ |
| deliveredStatusCode | Código de status gerado pelo Sinch para mensagem indicando o status de envio. Verifique em códigos de status para mais informações |
| deliveredStatus | descrição do status de envio. Verifique em códigos de status para mais informações |
| deliveredAt | Hora do envio, formato utilizado é o Unix_time |
| deliveredDate | Data que a mensagem foi enviada. Formato: yyyy-MM-dd’T'HH:mm:ssZ |
| campaignId | Identificador de campanha caso exista |
| extraInfo | Qualquer informação extra adicionada pelo cliente no envio da mensagem |
| Campo | Detalhes | Tipo |
|---|---|---|
| id | UUID gerado na requisição para a mensagem | String |
| correlationId | Mesmo correlationId da requisição | String |
| carrierId | ID da operadora, para mais informações consulte código de erro | Long |
| carrierName | Nome da operadora | String |
| destination | Número de telefone da mensagem enviada | String |
| sentStatusCode | Código de status enviado. Verifique os códigos de status enviados para obter mais informações | Long |
| sentStatus | Código de status enviado. Verifique os códigos de status enviados para obter mais informações | String |
| sentStatusAt | Quando a mensagem foi enviada. É uma data de época | Long |
| sentStatusDate | Quando a mensagem foi enviada. Formato aaaa-MM-dd’T'HH:mm:ssZ. Formato de data com hora e fuso horário (ISO 8601) | String |
| deliveredStatusCode | Código de status entregue. Verifique os códigos de status entregues para obter mais informações | Long |
| deliveredStatus | Código de status entregue. Verifique os códigos de status entregues para obter mais informações | String |
| deliveredAt | Quando a mensagem foi enviada. É uma data de época | Long |
| deliveredDate | Quando a mensagem foi enviada. Formato aaaa-MM-dd’T'HH:mm:ssZ. Formato de data com hora e fuso horário (ISO 8601) | String |
| campaignId | Identificador de campanha | Long |
| extraInfo | Qualquer informação extra definida pelo usuário quando a mensagem foi enviada | String |
| Perfil | Permissão |
|---|---|
| Regular | cada requisição realizada na MO API só irá retornar os MOs correspondentes a subconta que o usuário pertence. Não é possível a um usuário regular recuperar MOs de outras subcontas. |
| Administrador | o comportamento padrão para o usuário administrador é recuperar todos os MOs de todas as subcontas. Se um administrador desejar recuperar os MOs de apenas uma das subcontas é necessário especificar a subconta no parametro subAccount com o id da subconta desejada. |
| Campo | Detalhes | Tipo |
|---|---|---|
| total | O número total de MOs retornadas pela requisição | Integer |
| start | O limite minimo da query | String |
| end | O limite máximo da query | String |
| messages | Listagem dos objetos | List |
**MTs tem a seguinte estrutura**
| Campo | Detalhes | Tipo |
|---|---|---|
| id | Id da MT | String |
| correlationId | CorrelationID enviado na MT | String |
| username | Username do usuário responsável por enviar a MT | String |
| Email do responsavel por enviar a MT | String |
# Códigos de Status de Envio Existem dois níveis de status, que são enviados independentemente. 1. Primeiro status (**sent\_status - Status de envio = Callback**) Status de entrega **na operadora**, este é o primeiro status que retornamos, e todas as operadoras possuem.
| Código | Mensagem | Significado |
|---|---|---|
| 2 | SENT_SUCCESS | Entregue na operadora com exito (Este é o status que deve ser considerado para efeito de cobrança.) |
| 101 | EXPIRED | Expirado antes de ser entregue na operadora. |
| 102 | CARRIER_COMMUNICATION_ERROR | Erro de comunicação com a operadora |
| 103 | REJECTED_BY_CARRIER | Operadora rejeitou a mensagem, e isso ocorre por diversos motivos como: Fila cheia da operadora, número inválido da operadora ou parâmetros ausentes. |
| 202 | INVALID_DESTINATION_NUMBER | O número de destino é inválido (Não é um número de celular válido). |
| 203 | BLACKLISTED | O número de destino está na lista bloqueada, e foi inserido manualmente por sua empresa. |
| 204 | DESTINATION_BLOCKED_BY_OPTOUT | O número de destino solicitou opt-out, e não quer receber mais mensagens desta sub conta. (Este status é específico para contas de mobile marketing). |
| 207 | INVALID_MESSAGE_TEXT | O texto da mensagem contém palavras que não são aceitas pela operadora. Estas palavras podem ser de baixo calão, ou, caso sua conta seja de Mobile Marketing, podem ser de grandes marcas. |
| 213 | COUNTRY_NOT_ALLOWED_FOR_CUSTOMER | O cliente não tem permissão para enviar mensagens para o país do número receptor desejado. |
| 214 | INVALID_CUSTOMER_CONFIGURATION | Algumas configurações do cliente estão inválidas ou faltando. |
| 215 | CUSTOMER_QUOTA_BLOCKED | O quota do cliente está bloqueado ou atingiu seu limite. |
| 301 | INTERNAL_ERROR | Um ou mais problemas ocorreram com a nossa plataforma, assim as mensagens não puderam ser processadas e enviadas. |
| Código | Mensagem | Significado |
|---|---|---|
| 4 | DELIVERED_SUCCESS | Mensagem enviada com sucesso para operadora (contêiner), mas não entregue ao dispositivo do usuário. Pode ser que o dispositivo esteja fora do alcance, o número pode estar desativado ou bloqueado. |
| 104 | NOT_DELIVERED | A operadora aceitou a mensagem, mas não conseguiu entregar no aparelho. Possíveis causas: Aparelho desligado ou fora de área de serviço por tempo determinado (normalmente 24 horas, mas algumas operadoras, como a Vivo, este tempo é de tentativa é de 8 horas). Número válido, mas inativo (algumas operadoras retornam este tipo de erro somente neste segundo nível de status). |
| 201 | NOT_DELIVERED | A mensagem foi rejeitada porque não havia crédito suficiente na conta. |
| 401 | MESSAGE_SPLIT | Ocorre quando a mensagem de SMS atinge seu formato válido; de 160 caractéres sem acento ou 70 sem acentuação. A mensagem final será formatada de acordo com o limite de caracteres, e aparecerá nos relatórios finais de acordo com essa formatação. |
| Informação | Detalhes |
|---|---|
| Hostname | smpp-messaging.wavy.global Ao configurar seu sistema SMPP, é obrigatório a utilização do domínio como destino, ao invés de IPs. Este domínio possui 4 proxies de entrada com round robin DNS e health check, e multiplos servidores backend. Baseado no volume de mensagens que sua empresa trafegará, vamos aumentar o número de binds(conexões) permitidos simultâneamente. |
| Porta | 2444 (SMPP over TLS) ou 2443 (VPN) |
| Versão SMPP | 3.4 |
| Número de binds | Mínimo 4. O estabelecimento de pelo menos 4 binds é mandatório para obtenção de alta-disponibilidade e balanceamento de carga. |
| Codificação dos caracteres | GSM7 - Default (data_coding = 0) (GSM3.38 extended table is not supported by carriers.) LATIN1 (data_coding = 1) UCS2 (data_coding=8). Atenção: Verifique AQUI detalhes de caracteres e cobranças. |
| Flash SMS | Supported data_coding=0x10 para GSM7 e data_coding 0x18 para UCS2 Quando recebemos mensagens flashSMS de nossos clientes, elas são enviadas para as operadoras como flahsSMS, se a operadora não suportar flashSMS, ela é entregue como um SMS normal. |
| Enquire-link | Minimo: 30 segundos / Máximo: 59 segundos. |
| Concatenação | UDH 8-bit e 16-bit são suportados / UDH Headers. |
| Default addr_ton | 1 |
| Default addr_npi | 1 |
| window size | 10 |
| 2way | Suportado |
| SMPP bind type | Transceiver(Recomendado). Binds transmit/receiver separados também são aceitos. |
| SMPP system_type | MovileSMSC |
| SMPP source addr (senderID) | Quando seu serviço necessitar respostas de usuários (MO), o source address deve ser igual ao system_id, ou seja, o nome do usuário. Quando o serviço não precisar de MOs, você pode utilizar qualquer coisa neste campo. |
| Max MO vazão | 80 por bind |
| Max MT vazão | 80 por bind |
| Server Timezone | UTC |
| Formato de ID | UUID |
| Default validity_period | 24 hours |
| stat | err | TLV (0x1403) | TLV (0x1404) | Significado |
|---|---|---|---|---|
| ACCEPTD | 000 | 2 | SENT_SUCCESS | Entregue na operadora com sucesso (Este é o status que deve ser considerado para efeito de cobrança.) |
| EXPIRED | 101 | 101 | EXPIRED | Expirado antes de ser entregue ao aparelho. |
| REJECTD | 102 | 102 | CARRIER_COMMUNICATION_ERROR | Erro de comunicação com a operadora. |
| REJECTD | 103 | 103 | REJECTED_BY_CARRIER | Operadora rejeitou a mensagem. |
| REJECTD | 201 | 201 | NO_CREDIT | O limite de mensagens setado pelo administrador de sua empresa, para sua conta ou sub conta, foi excedido. Ou, caso sua empresa utilize o modelo pré-pago de créditos, ele terminou. |
| REJECTD | 202 | 202 | INVALID_DESTINATION_NUMBER | O número de destino é inválido (Não é um número de celular válido). |
| REJECTD | 203 | 203 | BLOCKLISTED | O número de destino está na lista bloqueada, e foi inserido manualmente por sua empresa. |
| REJECTD | 204 | 204 | DESTINATION_BLOCKED_BY_OPTOUT | O número de destino solicitou opt-out, e não quer receber mais mensagens desta sub conta. (Este status é específico para contas de mobile marketing). |
| REJECTD | 205 | 205 | DESTINATION_MESSAGE_LIMIT_REACHED | O número de destino já recebeu a quantidade máxima de mensagens que uma mesma empresa pode enviar, dentro de um período de tempo. (Este status é específico para contas de Mobile Marketing, e esta é uma regra das operadoras). |
| REJECTD | 207 | 207 | INVALID_MESSAGE_TEXT | O texto da mensagem contém palavras que não são aceitas pela operadora. Estas palavras podem ser de baixo calão, ou, caso sua conta seja de Mobile Marketing, podem ser de grandes marcas. |
| REJECTD | 301 | 301 | INTERNAL_ERROR | Ocorreu um erro na plataforma da Wavy. |
| UNKNOWN | 301 | 301 | INTERNAL_ERROR | Ocorreu um erro na plataforma da Wavy. |
| stat | err | TLV (0x1403) | TLV (0x1404) | TLV (0x1405) | TLV (0x1406) | Significado |
|---|---|---|---|---|---|---|
| DELIVRD | 000 | 2 | SENT_SUCCESS | 4 | DELIVERED_SUCCESS | Entregue no aparelho com sucesso. |
| UNDELIV | 104 | 2 | SENT_SUCCESS | 104 | NOT_DELIVERED | A operadora aceitou a mensagem, mas não conseguiu entregar no aparelho. Possíveis causas: Aparelho desligado ou fora de área de serviço por tempo determinado (normalmente 24 horas, mas algumas operadoras, como a Vivo, este tempo é de tentativa é de 8 horas). Número válido, mas inativo (algumas operadoras retornam este tipo de erro somente neste segundo nível de status). |
| Hostname | ftp-messaging.wavy.global |
| Porta | 2222 |
| Protocolo | SFTP (transferência sobre ssh, provendo criptografia entre cliente-servidor) |
| Autenticação | username + senha (fornecido pelo suporte) |
| Portal | messaging.wavy.global |
| Nome | Host |
|---|---|
| Hostname | ftp-messaging.wavy.global |
| IPs | IP primário: 200.219.220.54 IP secundário: 45.236.179.22 |
| Ports | 21 (ftps) 2222 (sftp) |
| Authentication | username + password |
| Nome do host | api-messaging.wavy.global |
| Apis | Solicitação de lote /v1/carrier/lookup |
| Porta | 443 (https) |
| Protocolo | HTTPS (criptografia TLS) |
| Autenticação | nome de usuário + token |
| Portal | mensagens.wavy.global |
{% endtab %} {% tab title="Python" %} ``` import requests url = "https://api-messaging.wavy.global/v1/carrier/lookup" payload = "{\n\t\"destinations\": [\"+55(19)997712322\", \"5519997712322\", \"2312312\"]\n}" headers = { 'Content-Type': "application/json", 'authenticationtoken': "
{% endtab %} {% endtabs %} ### Solicitar resposta A resposta de consulta em lote conterá um arquivo JSON com as informações individuais sobre cada número consultado: | Campo | Detalhes | Tipo | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | id | UUID para referência de messge | String | | destinations | Este campo é uma matriz com as respostas das consultas em lote individuais, contém o id e correlationId de cada número de consulta | IndividualResponse\[] | | destination | Número de telefone pesquisado | Long | | active | status do número do operador (atualmente só verifique se o número pertence ao operador, não ativo / em uso) | Boolean | | carrier | Operador e país ao qual pertence o número consultado | array\[] | | name | Nome da transportadora | String | | countryCode | código do país | String | Resposta chamada em formato JSON {% tabs %} {% tab title="cURL" %} ``` { "id": "aadb5130-7dd7-11e7-baac-a6aabe61edb5", "destinations": [ { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "2312312", "active": false, "carrier": { "name": "UNKNOWN" } } ] } ``` > The last number in the example is an invalid number to demonstrate how the query returns the JSON in these cases. > {% endtab %} {% tab title="Ruby" %} ``` { "id": "aadb5130-7dd7-11e7-baac-a6aabe61edb5", "destinations": [ { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "2312312", "active": false, "carrier": { "name": "UNKNOWN" } } ] } ``` > The last number in the example is an invalid number to demonstrate how the query returns the JSON in these cases. > {% endtab %} {% tab title="Python" %} ``` { "id": "aadb5130-7dd7-11e7-baac-a6aabe61edb5", "destinations": [ { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "2312312", "active": false, "carrier": { "name": "UNKNOWN" } } ] } ``` > The last number in the example is an invalid number to demonstrate how the query returns the JSON in these cases. > {% endtab %} {% tab title="PHP" %} ``` { "id": "aadb5130-7dd7-11e7-baac-a6aabe61edb5", "destinations": [ { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "2312312", "active": false, "carrier": { "name": "UNKNOWN" } } ] } ``` > The last number in the example is an invalid number to demonstrate how the query returns the JSON in these cases. > {% endtab %} {% tab title="Java" %} ``` { "id": "aadb5130-7dd7-11e7-baac-a6aabe61edb5", "destinations": [ { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "5519997712322", "active": true, "carrier": { "name": "VIVO", "countryCode": "BR" } }, { "destination": "2312312", "active": false, "carrier": { "name": "UNKNOWN" } } ] } ``` > The last number in the example is an invalid number to demonstrate how the query returns the JSON in these cases. > {% endtab %} > {% endtabs %} # Introdução ao Messaging - SMS O messaging é nossa plataforma de gerenciamento de mensagens, é a partir dela que você consegue enviar e metrificar todos os seus disparos. ## Como acessar o Messaging? Para acessar a plataforma, clique no link a seguir: [**Messaging - MM2**](https://messaging.wavy.global/)**,** você será direcionado para uma página como essa:
Tela de login
reset de senha
dados de acesso
| destination | name | info | correlationid |
|---|---|---|---|
| destination | name | info | correlationid |
| 5511987654321 | André | Sinch | campanha_X |
| 5511912345678 | Mozart | Sinch | campanha_Y |
campanhas
| Space | ( | 0 | 8 | @ | H | P | X | ` | h | p | x |
| ! | ) | 1 | 9 | A | I | Q | Y | a | i | q | y |
| “ | * | 2 | : | B | J | R | Z | b | j | r | z |
| # | + | 3 | ; | C | K | S | { | c | k | s | ~ |
| $ | , | 4 | < | D | L | T | \ | d | l | t | |
| % | - | 5 | = | E | M | U | } | e | m | u | |
| & | . | 6 | > | F | N | V | ^ | f | n | v | |
| ‘ | / | 7 | ? | G | O | W | _ | g | o | w |
envio por número
todos os números
nome do template
| Destination | Nome | Produto | Empresa |
|---|---|---|---|
| 5511912345678 | Renata Iaconelli | SMS | sinch |
| 5511987654321 | FULANA Ciclana | SinCh | |
| 5511912345678 | Ciclana MARIA | Sms | SINCH |
SMS
mensagens enviadas
| Status | Descrição |
|---|---|
| Entregue | Mensagem entregue no aparelho |
| Enviada com sucesso | Mensagem enviada com sucesso para a transportadora ou corretora. A operadora respondeu aceitando a mensagem. |
| Tempo de vida expirada (TTL) | A mensagem expirou na plataforma Sinch, antes de ser enviada para a operadora. (Mensagem não enviada). |
| Erro de comunicação com a operadora | Falha de comunicação com a operadora. |
| Rejeitada pela operadora | Mensagem rejeitada pela operadora. A operadora pode rejeitar a mensagem por vários motivos. Os mais comuns são devido a instabilidade temporária ou destinatário incapacitado. |
| Não entregue | A mensagem foi enviada com êxito para a operadora, mas não pode ser entregue ao dispositivo. Alguns dos motivos são dispositivo fora da rede e destinatário desabilitado. |
| Não entregue por opt-out | Destino bloqueado por opt-out |
| Erro interno | Erro interno, procure nossa equipe de suporte. |
| Parâmetro/Contato inválido | Dados de destino inválidos |
| Blocklist | A mensagem não é enviada porque o número do destinatário foi bloqueado pelo cliente na plataforma Sinch. |
| Mensagem de texto inválida | O texto da mensagem contém algum conteúdo inválido, como palavras impróprias, fraude ou conteúdo falso. |
| Conteúdo inválido | O conteúdo da mensagem é inválido porque os parâmetros de um modelo de texto estão ausentes ou incorretos. |
| Expirada pela operadora | A mensagem expirou por operadora. Falha após a operadora tentar enviar a mensagem em 24 horas para o celular. |
| Mensagem duplicada | Mensagem para o mesmo número com algum conteúdo foi rejeitada devido a repetições excessivas |
| Status | Descrição |
|---|---|
| Entregue | Mensagem entregue no aparelho |
| Enviada com sucesso | Mensagem enviada com sucesso para a transportadora ou corretora. A operadora respondeu aceitando a mensagem. |
| Tempo de vida expirada (TTL) | A mensagem expirou na plataforma Sinch, antes de ser enviada para a operadora. (Mensagem não enviada). |
| Erro de comunicação com a operadora | Falha de comunicação com a operadora. |
| Rejeitada pela operadora | Mensagem rejeitada pela operadora. A operadora pode rejeitar a mensagem por vários motivos. Os mais comuns são devido a instabilidade temporária ou destinatário incapacitado. |
| Não entregue | A mensagem foi enviada com êxito para a operadora, mas não pode ser entregue ao dispositivo. Alguns dos motivos são dispositivo fora da rede e destinatário desabilitado. |
| Não entregue por opt-out | Destino bloqueado por opt-out |
| Erro interno | Erro interno, procure nossa equipe de suporte. |
| Parâmetro/Contato inválido | Dados de destino inválidos |
| Blocklist | A mensagem não é enviada porque o número do destinatário foi bloqueado pelo cliente na plataforma Sinch. |
| Mensagem de texto inválida | O texto da mensagem contém algum conteúdo inválido, como palavras impróprias, fraude ou conteúdo falso. |
| Conteúdo inválido | O conteúdo da mensagem é inválido porque os parâmetros de um modelo de texto estão ausentes ou incorretos. |
| Expirada pela operadora | A mensagem expirou por operadora. Falha após a operadora tentar enviar a mensagem em 24 horas para o celular. |
| Mensagem duplicada | Mensagem para o mesmo número com algum conteúdo foi rejeitada devido a repetições excessivas |
| Status | Descrição |
|---|---|
| Entregue | Mensagem entregue no aparelho |
| Enviada com sucesso | Mensagem enviada com sucesso para a transportadora ou corretora. A operadora respondeu aceitando a mensagem. |
| Tempo de vida expirada (TTL) | A mensagem expirou na plataforma Sinch, antes de ser enviada para a operadora. (Mensagem não enviada). |
| Erro de comunicação com a operadora | Falha de comunicação com a operadora. |
| Rejeitada pela operadora | Mensagem rejeitada pela operadora. A operadora pode rejeitar a mensagem por vários motivos. Os mais comuns são devido a instabilidade temporária ou destinatário incapacitado. |
| Não entregue | A mensagem foi enviada com êxito para a operadora, mas não pode ser entregue ao dispositivo. Alguns dos motivos são dispositivo fora da rede e destinatário desabilitado. |
| Não entregue por opt-out | Destino bloqueado por opt-out |
| Erro interno | Erro interno, procure nossa equipe de suporte. |
| Parâmetro/Contato inválido | Dados de destino inválidos |
| Blocklist | A mensagem não é enviada porque o número do destinatário foi bloqueado pelo cliente na plataforma Sinch. |
| Mensagem de texto inválida | O texto da mensagem contém algum conteúdo inválido, como palavras impróprias, fraude ou conteúdo falso. |
| Conteúdo inválido | O conteúdo da mensagem é inválido porque os parâmetros de um modelo de texto estão ausentes ou incorretos. |
| Expirada pela operadora | A mensagem expirou por operadora. Falha após a operadora tentar enviar a mensagem em 24 horas para o celular. |
| Mensagem duplicada | Mensagem para o mesmo número com algum conteúdo foi rejeitada devido a repetições excessivas |
image1
image2
* Mensagem enviada * Erro no envio * Entregue * Não entregue * Lido Eles são simplificados para deixar a experiência mais fluída no universo das Campanhas. Caso tenha o interesse em saber mais informações, se atente ao campo de Status Description (ou descrição do status). Aqui trouxemos alguns exemplos de status mais comuns que podem aparecer, para uma **mensagem não ter sido entregue**:
| STATUS DESCRIPTION | SIGNIFICADO DO STATUS |
|---|---|
| Mensagem não entregue: endereço de destino inválido. | Endereço de destinatário inválido, verifique sua base e a mantenha limpa e atualizada. |
| Mensagem não entregue: falha no envio do SMS pelo canal de origem. | Falha inesperada para processar o envio (possível intermitência). |
| Mensagem não entregue: limite de envio atingido. | Possível falha na comunicação entre a plataforma de envio e a operadora. Contate o time de Suporte para análise. |
| Mensagem não entregue: destinatário ausente ou fora de cobertura. | Destinatário ausente ou fora de cobertura. |
| Mensagem não entregue: contém palavra bloqueada. | Mensagem não entregue por bloqueio de palavra. Verifique sua listagem de permissão de palavras. |
| Mensagem não entregue: destinatário bloqueou o recebimento. | Seu destinatário bloqueou o recebimento da mensagem. Sempre que possível, garanta um fluxo de opt-in no canal de comunicação com seu cliente. |
| Mensagem não entregue: destinatário bloqueado. | Destinatário bloqueado. Verifique o arquivo enviado e tente manter a sua base sempre limpa e atualizada. |
| Mensagem não entregue: número de telefone inválido ou mal formatado. | Endereço de destinatário inválido, verifique sua base e a mantenha limpa e atualizada. |
| Mensagem não entregue: conta bloqueada no canal de envio. | Conta bloqueada, contate seu Executivo da Conta para averiguar. |
| The underlying channel reported: Message: (#132012) Parameter format does not match format in the created template (type: OAuthException, code: 132012, details: header component parameter should not be empty) | Quando encontrar um erro similar a este, somente em inglês, significa que o erro está trazendo uma variável. O significado varia muito dependendo do caso, solicite ajuda de Suporte para um melhor entendimento. |
| Mensagem não entregue: remetente não autorizado pelo destinatário. | Remetente não autorizou o recebimento desta mensagem (ativação da configuração antispam pelo usuário). |
| Mensagem não entregue: serviço de mensagens não habilitado para o destinatário. | Serviço de mensagens não está habilitado para o destinatário, a linha não está configurada para receber mensagens de texto. |
| Mensagem não entregue: número de telefone inexistente ou inválido | Endereço de destinatário inválido, verifique sua base e a mantenha limpa e atualizada. |
| Mensagem não entregue: recurso não suportado pelo destinatário. | Remetente fora da área de cobertura (em roaming). Você pode tentar reenviar a mensagem em outro momento. |
| Mensagem não entregue: problema na configuração do remetente. | Remetente não reconhecido. Verifique sua base e a mantenha limpa e atualizada. |
| Mensagem não entregue: destinatário fora de alcance. | Destinatário indisponível para recebimento de mensagens no momento. Você pode tentar reenviar a mensagem em outro momento. |
| Mensagem não entregue: erro interno. | Falha interna que afetou o envio desta mensagem. |
| Mensagem não entregue: rejeitada pelo destinatário. | Instabilidade ao processar recebimento da confirmação da mensagem. |
| Mensagem não entregue: serviço bloqueado para o destinatário. | Operadora bloqueou o recebimento da mensagem. |
| Mensagem não entregue: bloqueio por localização do destinatário. | O destinatário encontra-se em uma área não configurada para envio. |
| Mensagem não entregue: endereço do remetente ou destinatário inválido. | Endereço de destinatário inválido, verifique sua base e a mantenha limpa e atualizada. |
| Mensagem não entregue: erro permanente do destinatário. | Contate o time de Suporte para validação das configurações da sua conta. |
| Mensagem não entregue: destinatário não identificado. | Destinatário não existe ou está inativo. Mantenha sua base sempre limpa e atualizada. |
| Mensagem não entregue: problemas na configuração. | Contate o time de Suporte para validação das configurações da sua conta. |
| Mensagem não entregue: destinatário não é assinante do serviço de mensagens. | Problema de roteamento na rede de telefonia, provavelmente causado por portabilidade numérica. |
| Mensagem não entregue: destinatário indisponível no momento. | Destinatário indisponível para recebimento de mensagens no momento. |
| Mensagem não entregue: remetente desativado ou não registrado. | Falha interna que afetou o envio desta mensagem. Se for um erro constante para este remetente, contate o time de Suporte para maiores esclarecimentos. |
| Mensagem não entregue: origem do remetente não corresponde à esperada. | Contate o time de Suporte para validação das configurações da sua conta. |
| Mensagem não entregue: falha na entrega do destinatário. | Falha na identificação da rota do destinatário. Verifique se o código de área e telefone estão certos. |
| Mensagem não entregue: destinatário fora da área. | Falha de compatibilidade entre a rede de telefonia e provedor. Contate o time de Suporte para saber mais. |
| Mensagem não entregue: erro desconhecido. | Falha da operadora de telefonia, contendo código de erro desconhecido (não documentado e não específico). |
| Mensagem não entregue: endereço do remetente inválido. | Endereço de destinatário inválido, verifique sua base e a mantenha limpa e atualizada. |
**Regra para Basic:** * até 160 caracteres **Regra para Single:** * mais de 160 caracteres * ou uso de botão
| Tipo | Característica |
|---|---|
| Imagem | Até 2MB |
| Vídeo | Até 10MB |
| URL (botão para website) | URL de até 2.048 caracteres |
| Tipo | Característica |
|---|---|
| Imagem | Até 1MB |
| Vídeo | Até 5MB |
| URL | URL de até 2048 caracteres |
### Relatório Consolidado
Filtros:
- Subconta: possível selecionar mais de uma subconta. Digite o ID da subconta ou nome da subconta.
- Usuário: digite o userID ou nome do usuário
- Campanha: é possível selecionar mais de uma campanha. Digite o ID da campanha ou nome da campanha.
- País: digite o nome do país
- Status: pode selecionar entre Mensagem Enviada / Erro no Envio / Entregue / Não Entregue / Lido
**1.** Neste relatório, você conseguirá visualizar informações detalhadas de MT e de MO separadamente.\ **2.** Também é possível visualizar informações **COM** ou **SEM** fallback.\ **3.** A seleção da periodicidade acontece apenas via calendário.\ **4.** Por ser um relatório que proporciona mais informações, você pode personalizar da maneira que desejar. Ou seja, você pode selecionar apenas campos que deseja visualizar e a respectiva ordem deles.\ **5.** Pode exportar o relatório como CSV, XLSX ou PDF da página. | Filtros Detalhado | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Tipo de Relatório:** Detalhado | | **Origem:** MT ou MO | | **Visualizar relatório com dados de fallback:** você pode escolher visualizar os dados **COM** ou **SEM** fallback, para facilitar o entendimento do engajamento do canal | | **Periodicidade:** apenas via calendário | | **Personalização de relatório:** escolha as colunas que deseja visualizar e altere sua respectiva ordem, arrastando o bloco. Quando você seleciona o que deseja visualizar, o bloco fica verde. | |
Filtros:
- Subconta: possível selecionar mais de uma subconta. Digite o ID da subconta ou nome da subconta.
- Usuário: digite o userID ou nome do usuário
- Campanha: é possível selecionar mais de uma campanha. Digite o ID da campanha ou nome da campanha.
- País: digite o nome do país
- Status: pode selecionar entre Mensagem Enviada / Erro no Envio / Entregue / Não Entregue / Lido
- Destinatário: digite o telefone com DDD + DDI + telefone
- Lote ID: campo aberto, corresponde ao ID do disparo
- Correlation ID: campo aberto
- Operadora: este campo só irá aparecer para cenário de SMS fallback.
### 1. Período
| Período | Significado | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Mês Atual** |
Dados do mês atual, com exceção do dia atual.
Exemplo: se hoje é dia 08 de Abril, vai trazer dados de 1 à 7 de Abril.
Mês anterior, com exceção do mês atual.
Exemplo: se estamos no mês de Abril, ele vai trazer Março.
| | **60 dias** |Últimos 2 meses, com exceção do mês atual.
Exemplo: se estamos no mês de Abril, ele vai trazer Fevereiro e Março.
| | **Últimos 15 dias** | Últimos 15 dias, com exceção do dia atual | | **Ontem** | D-1 | ### 2. Indicadores# RCS Analytics O **RCS Analytics** é o relatório do canal RCS Nativo. Ele traz informações caso tenha o canal de SMS Fallback configurado.\ \ Quando comparamos com o relatório de SMS to RCS, vemos um layout totalmente repaginado, pensado em atender as suas necessidades e trazendo uma experiência muito mais fluida.\ \ Logo após clicar no menu lateral > RCS > RCS Analytics, vemos a área para você gerar seu **relatório Consolidado**. É possível escolher visualizar os dados com informações de SMS fallback ou não.\ \ No campo de calendário, é possível escolher algum período específico (dia, semana, mês) ou visualizar por blocos de meses (últimos 60, 90, 120 ou 180 dias).\ Repare que esta visão é o consolidado de MT + MO. Se desejar visualizar estas informações separadas, basta ir no **relatório** **Detalhado**.
* Praticamente todos os filtros se mantiveram * O RCS Analytics traz novos filtros, como: **Descrição do Status** (trazendo maiores detalhes relativos ao status da sua mensagem), **Tipo de mensagem** (se é um richcard, carrossel, mensagem texto) e **Sender ID**. * o filtro de **Shortcode** não existe mais, já que é possível configurar subcontas por shortcodes. * filtros como: **Agendado para**, **Lido**, **Criado em** e **original\_UUID** não existem mais. As informações que eles traziam já estão contempladas nos filtros atuais do RCS Analytics! # Documentação Técnica - WhatsApp Esta documentação fornece informações sobre como sua aplicação poderá enviar as mensagens de Whatsapp via API. Você também encontrará aqui informações sobre **Webhooks**, que são retornos de chamada HTTP definidos pelo usuário, que são acionados por eventos específicos. Sempre que ocorrer um evento de acionamento, a API da Sinch coletará os dados e imediatamente enviará uma notificação (solicitação HTTP) para URL fornecida pelo cliente, atualizando o status das mensagens enviadas ou indicando quando você receber uma mensagem do usuário final (MO). A Sinch Messaging WhatsApp API permite o envio de mensagens únicas ou em lote. A API possui integração REST, utilizando o protocolo HTTP com TLS, suportando o método POST com os parâmetros enviados em formato JSON. # Termos importantes ### Termos Importantes
| MT | Mobile Terminated | É o termo utilizado para mensagens que possuem o usuário (aparelho) como destino. Ou seja, mensagens que foram originadas por sua empresa, com destino ao usuário (aparelho). |
| Response | Resposta síncrona da Sinch | É a resposta imediata de uma requisição feita em nossa API, onde informamos se a mensagem foi aceita ou não por nossa plataforma. |
| Callback | Sent status ou status de envio | É o status de envio que retornamos, onde informamos se foi possível, ou não, fazer a entrega da mensagem para o WhatsApp, se foi entregue para o Usuário e se a mensagem foi lida. |
| MO | Mobile Originated | É o termo utilizado para mensagens que possuem sua empresa como destino. Ou seja, mensagens que foram originadas pelo usuário (aparelho). |
| Campo | Detalhes | Tipo de dado |
|---|---|---|
| UserName | Nome ou e-mail válido para identificação do usuário no ChatClub. | String |
| AuthenticationToken | Token de autenticação gerado pela nossa plataforma. Encontre aqui ou consulte o suporte. aqui | String |
| Hostname | api-messaging.wavy.global |
| Porta | 443 (https) |
| Protocolo | HTTPS (TLS encryption) |
| Autenticação | UserName e AuthenticationToken |
| Encoding | UTF-8 |
| POST | /v1/whatsapp/send HTTP/1.1 |
| Host: | api-messaging.wavy.global |
| UserName: | user_name |
| AuthenticationToken: | aaaaaa-bbbbbbbbbbbbbXXXXX12 |
| Content-Type: | application/json |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| destinations | Sim | Lista de Destinos | Destino[] |
| message | Sim | Mensagem de Texto que será enviada a todos os destinos | Mensagem |
| flowId | Não | Identificador de Fluxo do Bot | String |
| defaultExtraInfo | Não | Dados adicionais que identifiquem o envio, serão vinculados a todos os destinatários que receberão a mensagem | String |
| campaignAlias | Não | ID da campanha, é linkado com todas as mensagens enviadas | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| correlationId | Não | Id definido por voce que será retornado na configuração da mensagem (callback). Isto é útil em casos quando é necessário rastear os envios das mensagens, pois é possivel definir ids diferentes para diferentes mensagens. | String |
| destination | Sim | Número de telefone (código do país — 55 para Brasil — e DDD devem estar presentes) que receberá a mensagem. Exemplos:5519900001111, +5519900001111, +55(19) 900001111. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| messageText | Sim | Campo usado quando for necessário enviar uma mensagem personalizada em resposta a uma mensagem recebida. | text |
| image | Sim | Campo utilizado quando for necessário o envio de uma imagem. | Image |
| audio | Sim | Campo utilizado quando for necessário o envio de uma áudio. | Audio |
| document | Sim | Campo utilizado quando for necessário o envio de uma documento. | Document |
| location | Sim | Campo utilizado quando for necessário o envio de uma localização. | Location |
| contacts | Sim | Campo utilizado quando for necessário o envio de contato(s). | Contact[] |
| previewFirstUrl | Não | Controla a exibição no app da primeira URL enviada ao usuário | Boolean |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| messageText | Sim | Texto que será enviado ao usuário |
| Campo | Obrigatório | Detalhes | Type |
|---|---|---|---|
| tipo | Sim | Tipo/extensão da imagem que será enviada na mensagem. Opções disponiveis: JPG, JPEG, PNG. | String |
| caption | Não | Texto que será apresentado ao usuário embaixo da imagem | String |
| url | Sim | URL que hospeda o arquivo a ser enviado. | String |
| data | Sim | conteúdo encodado em Base64 | String |
{% endtab %} {% tab title="Ruby" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "url": "http://...jpg", "caption": "image description" } } } ```
{% endtab %} {% tab title="Python" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "url": "http://...jpg", "caption": "image description" } } } ``` {% endtab %} {% tab title="PHP" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "url": "http://...jpg", "caption": "image description" } } } ``` {% endtab %} {% tab title="Java" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "url": "http://...jpg", "caption": "image description" } } } ``` {% endtab %} {% endtabs %} > Exemplo de requisição com Imagem (Base 64) {% tabs %} {% tab title="cURL" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "data": "ZmlsZQ==" } } } ``` {% endtab %} {% tab title="Ruby" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "data": "ZmlsZQ==" } } } ``` {% endtab %} {% tab title="Python" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "data": "ZmlsZQ==" } } } ``` {% endtab %} {% tab title="PHP" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "data": "ZmlsZQ==" } } } ``` {% endtab %} {% tab title="Java" %} ``` { "destination": [{ "correlationId": "MyCorrelationId", "destination": "5519900001111" }], "message": { "image": { "type": "JPG", "data": "ZmlsZQ==" } } } ``` {% endtab %} {% endtabs %} ### Audio
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| type | Sim | Tipo/extensão do audio que será enviado na mensagem. Opções disponiveis: AAC, MP4, AMR, MP3, OGG. | String |
| url | Sim | URL que hospeda o arquivo a ser enviado. | String |
| data | Sim | conteúdo encodado em Base64 | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| addresses | Não | Endereço(s) completo(s) do contato. | Address[] |
| birthday | Não | Data de aniversário com formato YYYY-MM-DD. | String |
| emails | Não | Endereço(s) de e-mail de contato. | Email[] |
| name | Sim | Nome completo do contato. | Name |
| org | Não | Informações da organização do contato. | Org |
| phones | Não | Número(s) de telefone do contato. | Phone[] |
| urls | Não | URL(s) do contato. | Url[] |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| street | Não | Nome e número da rua. | String |
| city | Não | Nome da cidade. | String |
| state | Não | Sigla do Estado. | String |
| zip | Não | CEP. | String |
| country | Não | Nome completo do país. | String |
| country_code | Não | Abreviação de país (Duas letras). | String |
| type | Não | Valores Padrões: HOME, WORK. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| Não | Endereço de e-mail. | String | |
| type | Não | Valores Padrões: HOME, WORK. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| first_name | Não | Primeiro nome. | String |
| last_name | Não | Último nome. | String |
| middle_name | Não | Nome do meio. | String |
| name_suffix | Não | Sufixo do nome. | String |
| name_prefix | Não | Prefixo do nome. | String |
| formatted_name | Sim | Nome completo como normalmente aparece. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| company | Não | Nome da organização do contato. | String |
| department | Não | Nome do departamento do contato. | String |
| title | Não | Título corporativo do contato. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| phone | Não | Número de telefone formatado. | String |
| type | Não | Valores padrões: CELL, MAIN, IPHONE, HOME, WORK. | String |
| wa_id | Não | Identficador WhatsApp. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| phone | Não | URL do contato. | String |
| type | Não | Valores padrões: HOME, WORK. | String |
| Field | Required | Details | Type |
|---|---|---|---|
| destinations | Sim | Lista de destinatários | Destination[] |
| message | Sim | Mensagem de texto que será enviada para a lista de destinatários | Message |
| flowId | Não | Identificação do fluxo do bot | String |
| defaultExtraInfo | Não | Dados adicionais que identifiquem o envio serão vinculados a todos os destinatários que receberão a mensagem | String |
| campaignAlias | Não | ID da campanha, está vinculado a todas as mensagens de envio | String |
| Field | Required | Details | Type |
|---|---|---|---|
| correlationId | Não | Seu ID definido será retornado em uma mensagem de confirmação (retorno de chamada). Isso é útil nos casos em que você deseja acompanhar a mensagem enviada, já que você pode definir ids diferentes para mensagens diferentes. | String |
| destination | Sim | O número de telefone (código do país — 55 para o Brasil — e o estado devem estar presentes) para o qual a mensagem será enviada. Exemplos:5519900001111, +5519900001111, +55(19) 900001111 | String |
| Field | Required | Details | Type |
|---|---|---|---|
| messageText | Sim | campo usado para caso você queira enviar uma mensagem personalizada em resposta a uma mensagem recebida. | text |
| image | Sim | Campo usado para o caso de você querer enviar um conteúdo de imagem. | Image |
| audio | Sim | Campo usado para o caso de você querer enviar um conteúdo de áudio | Audio |
| video | Sim | Campo usado para o caso de você querer enviar um conteúdo de vídeo. | Video |
| document | Sim | Campo usado para o caso de você querer enviar um arquivo de documento. | Document |
| location | Sim | Campo usado para o caso de você querer enviar um local. | Location |
| contacts | Sim | Campo utilizado para o caso de você querer enviar contato(s). | Contact[] |
| previewFirstUrl | Não | Controlar a visualização do primeiro URL enviado pelo aplicativo | Boolean |
| Field | Required | Details | Type |
|---|---|---|---|
| type | Sim | Tipo/extensão da imagem a ser enviada na mensagem. Opções disponíveis: JPG, JPEG, PNG. | String |
| caption | Não | Texto a ser apresentado ao usuário sob a imagem. | String |
| url | Sim | URL onde o conteúdo a ser enviado está hospedado. | String |
| data | Sim | Conteúdo codificado em Base64 | String |
| Field | Required | Details | Type |
|---|---|---|---|
| type | Sim | Tipo/extensão do áudio a ser enviado na mensagem. Opções disponíveis: AAC, MP4, AMR, MP3, OGG. | String |
| url | Não | URL onde o conteúdo a ser enviado está hospedado. | String |
| data | Sim | Conteúdo codificado em Base64 | String |
| Field | Required | Details | Type |
|---|---|---|---|
| type | Sim | Tipo/extensão do vídeo a ser enviado na mensagem. Opções disponíveis: MP4, 3gpp. | String |
| caption | Não | Texto a ser apresentado ao usuário sob o vídeo. | String |
| URL | Sim | URL onde o conteúdo a ser enviado está hospedado. | String |
| data | Sim | Conteúdo codificado em Base64 | String |
| Field | Required | Details | Type |
|---|---|---|---|
| type | Sim | Tipo/extensão do documento a ser enviado na mensagem. Opções disponíveis: PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX | String |
| caption | Sim | Texto a ser apresentado ao usuário sob o documento. | String |
| url | Sim | URL onde o conteúdo a ser enviado está hospedado. | String |
| data | Sim | Conteúdo codificado em Base64 | String |
| Field | Required | Details | Type |
|---|---|---|---|
| geopoint | Sim | O geoponto do lugar. O formato deve ser: "latitude,longitude" | String |
| address | Não | Endereço do local. | String |
| name | Não | Nome do local. | String |
| Field | Required | Details | Type |
|---|---|---|---|
| addresses | Não | Endereço(s) de contato completo(s). | Address[] |
| birthday | Não | Data de aniversário como cadeia de caracteres formatada AAAA-MM-DD. | String |
| emails | Não | Endereço(s) de e-mail de contato. | Email[] |
| name | Não | Nome completo do contato. | Name |
| org | Não | Informações da organização de contato. | Org |
| phones | Não | Telefone(s) de contato. | Phone[] |
| urls | Não | URL(s) de contato. | Url[] |
| Field | Required | Details | Type |
|---|---|---|---|
| street | Não | Número e nome da rua. | String |
| city | Não | Nome da cidade | String |
| state | Não | Abreviação do estado | String |
| zip | Não | Código postal | String |
| country | Não | Nome completo do país | String |
| country_code | Não | Abreviatura do país com duas letras | String |
| type | Não | Valores padrão: CASA, TRABALHO | String |
| Field | Required | Details | Type |
|---|---|---|---|
| Não | Endereço de email | String | |
| type | Não | Valores padrão: CASA, TRABALHO | String |
| Field | Required | Details | Type |
|---|---|---|---|
| first_name | Não | Primeiro nome | String |
| last_name | Não | Apelido | String |
| middle_name | Não | Nome do meio | String |
| name_suffix | Não | Sufixo do nome | String |
| name_prefix | Não | Prefixo do nome | String |
| formatted_name | Não | Nome completo | String |
| Field | Required | Details | Type |
|---|---|---|---|
| company | Não | Nome da empresa do contato. | String |
| department | Não | Nome do departamento do contato. | String |
| title | Não | Título comercial do contato. | String |
| Field | Required | Details | Type |
|---|---|---|---|
| phone | Não | Número de telefone formatado. | String |
| type | Não | Valores Padrão: CELULAR, PRINCIPAL, IPHONE, CASA, TRABALHO. | String |
| wa_id | Não | ID do WhatsApp. | String |
| Field | Required | Details | Type |
|---|---|---|---|
| phone | Não | URL de contato. | String |
| type | Não | Valores Padrão: CASA, TRABALHO. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| destinations | Sim | Detalhes sobre os identificadores do envio e destino | Destination[] |
| message | Sim | Detalhes sobre o objeto MESSAGE que será enviado | mensagem |
| defaultExtraInfo | Não | Dados adicionais que identificam a submissão que será relacionada a todos que receberem a mensagem | String |
| campaignAlias | Não | Campaign ID, é relacionada a todas as mensagens enviadas | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| correlationId | Não | Id definido pelo cliente que será retornado no status da mensagem (callback). Você pode usar esse id para rastrear envios de mensagens de maneira personalizada. | String |
| destination | Sim | Número de telefone que receberá a mensagem (código do país (55 para Brasil) e DDD são obrigatórios). Exemplos: 5519900001111, +5519900001111, +55(19) 900001111. | String |
| Campo | Obrigatório | Detalhes | Type |
|---|---|---|---|
| template | Sim | Detalhes sobre o objeto TEMPLATE que será enviado. | Template |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| elementName | Sim | Nome do modelo cadastrado e aprovado. | String |
| header | Sim, quando o Template possuir parâmetro no header | Objetos do cabeçalho com seus parâmetros | Header |
| bodyParameters | Sim (caso o template use variáveis) | A soma de todos os caracteres do corpo, considerando campos fixos e dinâmicos, é limitada a 1024 caracteres se o modelo registrado tiver apenas o corpo. É limitado a 160 caracteres se você tiver um cabeçalho ou rodapé. | Lista de strings |
| languageCode | Sim, quando houver mais de um idioma cadastrado para o mesmo template. | Codes: pt_BR, en, es, en_US, en_GB, pt_PT, es_AR, es_ES, es_MX, it, fr | String |
| buttons | Sim (Quando há no template) | A aprovação dos botões no template | Buttons |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| parameters | Opcional | Lista de parâmetros que serão substituídos no texto do cabeçalho. Nota: Caso esteja presente, o cabeçalho não deve ter título nem nenhum elemento. | String |
| title | Opcional | O título deve ter até 60 caracteres | String |
| (element) | Sim | Opções: text (padrão), image, audio, document, video. | Object |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| url | Sim | URL da mídia. Use somente com URLs HTTP/HTTPS. | String |
| type | Sim | Tipo da midia (JPEG, MP3, PDF, etc) | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| type | Sim | Tipo do botão (URL, QUICK_REPLY, CALL, ORDER_DETAILS, FLOW) | String |
| flowDetails | Sim se type for FLOW | Estrutura e conteúdo os detalhes do FLOW a ser iniciado. | flowDetails |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| type | Sim | Define o tipo da ação do fluxo. Atualmente, o único valor suportado é action. | String |
| action | Sim | Objeto que contém os dados e o token do fluxo. | action |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| flowToken | Opcional | Um token único para identificar a sessão deste fluxo específico. Se não for fornecido, um valor padrão "unused" será adicionado | String |
| flowActionData | Opcional | Conteúdo usado para pré-preencher dados nas telas do seu fluxo. É útil para iniciar o fluxo com informações contextuais (ex: nome do produto, detalhes de um pedido). Não necessário caso seu Flow consulte o ponto de extremidade para obter os dados através do INIT. | String |
| Campo | Necessário | Detalhes | Tipo |
|---|---|---|---|
| interativo | Sim | Campo usado para enviar uma mensagem interativa | Interativo |
| Field | Required | Details | Type |
|---|---|---|---|
| messageInteractiveType | Sim | Tipo da mensagem interativa. Opções disponíveis: , e PRODUCT_LISTLISTREPLY_BUTTON | String |
| header | Necessário para mensagens de vários produtos. Negado para mensagens de produto único. Opcional para outros tipos | Conteúdo do cabeçalho | Header |
| body | Sim, exceto para mensagens de produto único | Texto principal | Body |
| footer | Não | Texto do rodapé | Footer |
| productListAction | Quando o tipo interativo é PRODUCT_LIST | Contém os parâmetros de tipo interativo | ProductListAction |
| listAction | Quando o tipo interativo é LIST | Contém os parâmetros de tipo interativo | ListAction |
| replyButtonAction | Quando o tipo interativo é REPLY_BUTTON | Contém os parâmetros de tipo interativo | ReplyButtonAction |
| alternativeText | Não | Texto que será enviado caso o destino não suporte Mensagem Interativa | String |
| Field | Required | Details | Type |
|---|---|---|---|
| text | Sim | Não pode ser uma String vazia. Permite Emojis & markdown. Corpo: Max 1024 caracteres, espaço em branco é cortado. Rodapé: Max 60 caracteres. | String |
| Field | Required | Details | Type |
|---|---|---|---|
| title | Sim | Texto da seção exibido. | String |
| productItems | Sim | Matriz de pelo menos um item de produto. Máximo de 30 produtos em todas as seções. | ProductItem[] |
| Field | Required | Details | Type |
|---|---|---|---|
| productRetailerId | Sim | A ID do produto configurada no Gerenciador de Negócios | String |
| Field | Required | Details | Type |
|---|---|---|---|
| button | Sim | Conteúdo do botão para mensagem | String |
| sections | Sim | Matriz de seções. Deve haver pelo menos 1 seção | Section[] |
| Field | Required | Details | Type |
|---|---|---|---|
| title | Sim | Título da seção que será exibido para o usuário. Máximo de 24 caracteres. Só é necessário se você tiver mais de uma seção | String |
| rows | Sim | Matriz de linhas. Deve haver pelo menos 1 linha e no máximo 10 linhas em todas as seções | Row[] |
| Field | Required | Details | Type |
|---|---|---|---|
| identifier | Sim | Identificador exclusivo da linha | String |
| title | Sim | Conteúdo do título da linha | String |
| description | Não | Conteúdo da descrição da linha | String |
| Field | Required | Details | Type |
|---|---|---|---|
| buttons | Sim | Matriz de um, dois ou três botões | Button[] |
| Field | Details | Type |
|---|---|---|
| total | Número de retornos de chamada na chamada. | String |
| data | Lista de retorno de chamada. | Data[] |
| clientInfo | Informações ao Cliente | ClientInfo |
| Field | Details | Type |
|---|---|---|
| id | ID da última mensagem. | String |
| correlationId | Um ID exclusivo definido por você para corresponder ao status da mensagem (retorno de chamada e DLR). Esse parâmetro é opcional e você pode usar o ID gerado pelo ChatClub para essa correspondência. | String |
| destination | Telefone para o qual a mensagem foi enviada (incluindo o código do país). Exemplo: 5511900000000. | String |
| origin | Telefone que identifica a conta do WhatsApp (incluindo o código do país). Exemplo: 5511900000000. | String |
| campaignId | ID de campanha definido anteriormente. | String |
| campaignAlias | Alias de campanha definidos anteriormente. | String |
| extraInfo | Informações extras enviadas com a mensagem original. | String |
| sent | Indica se a mensagem foi enviada. | Boolean |
| sentStatusCode | Código de status gerado pelo ChatClub para mensagem indicando o status de envio. | Number |
| sentStatus | Descrição do status enviado. | Boolean |
| sentDate | Data em que a mensagem foi enviada. Formato: aaaa-MM-dd'T'HH:mm:ssZ. | String |
| sentAt | Hora em que a mensagem foi enviada, usando o formato Unix_time | Number |
| delivered | Indica se a mensagem foi entregue ao destino. | Boolean |
| deliveredStatusCode | Código de status gerado pelo ChatClub para mensagem indicando que a mensagem foi entregue. | Number |
| deliveredStatus | Descrição do status de entrega. | String |
| deliveredDate | Data em que a mensagem foi entregue. Formato:: aaaa-MM-dd'T'HH:mm:ssZ | String |
| deliveredAt | Hora em que a mensagem foi entregue, usando Unix_time formato | Number |
| read | Indica se a mensagem foi lida pelo destino. | Boolean |
| readDate | Data em que a mensagem foi lida. Formato: aaaa-MM-dd'T'HH:mm:ssZ | String |
| readAt | Hora em que a mensagem foi lida, usando o formato Unix_time | String |
| updatedDate | Data em que o status da mensagem foi atualizado. Formato: aaaa-MM-dd'T'HH:mm:ssZ | String |
| updatedAt | Data em que o status da mensagem foi atualizado, usando o formato Unix_time | String |
| type | O tipo de entidade sobre o qual esse objeto de status se refere. Atualmente, a única opção disponível é "mensagem". | String |
| conversation | O objeto de conversação, que contém em si id, origin.type e expiration. Esse objeto estava relacionado ao novo modelo faturável de mensagens de whatsapp. Veja a conversa do Whatsapp. | Conversation |
| Code | Name | Short Description | Detailed Description |
|---|---|---|---|
| 1 | ROUTED_SUCCESS | Routed | Status de roteamento interno intermediário. As mensagens não são persistentes com esse status, portanto, não temos mensagens em relatórios com esse status |
| 2 | SENT_SUCCESS | Sent | Mensagem enviada com sucesso para operadora ou contêiner do WhatsApp. |
| 3 | CARRIER_ACCEPTED_SUCCESS | Carrier Accepted | Status de roteamento intermediário na transportadora. As mensagens não são persistentes com esse status, portanto, não temos mensagens em relatórios com esse status |
| 4 | DELIVERED_SUCCESS | Delivered | Mensagem entregue com sucesso da operadora ou do contêiner do WhatsApp para o dispositivo do destinatário. |
| 5 | READ_SUCCESS | Message read | Mensagem aberta e exibida para o usuário no aplicativo WhatsApp. Não temos esse status no SMS |
| 101 | EXPIRED | Expired | A mensagem TTL expirou. |
| 102 | CARRIER_COMMUNICATION_ERROR | Carrier communication error | Status indicando que estávamos tendo problemas para estabelecer comunicação com a operadora ou com o contêiner do WhatsApp e a mensagem não pôde ser enviada. |
| 103 | REJECTED_BY_CARRIER | Rejected by carrier | Status indicando que a operadora ou o contêiner do WhatsApp rejeitou a mensagem. Pode ser devido a vários motivos, como uma fila cheia na operadora, um número inválido para a operadora, um modelo de WhatsApp sem o idioma ou parâmetros ausentes. Ou qualquer outro erro interno do transportador ou do contêiner |
| 104 | NOT_DELIVERED | Message not delivered | Mensagem enviada com sucesso para operadora ou contêiner do WhatsApp, mas não entregue no dispositivo do usuário. Pode ser porque o dispositivo do usuário está fora de alcance; o número foi desativado ou bloqueado; Para o WhatsApp pode ser porque o conteúdo (mídia) não pode ser enviado ao usuário ou porque o destinatário não pode receber a mensagem devido a limites ou spam. |
| 105 | WA_MO_MEDIA_UNRETRYABLE_EXCEPTION | Retryable media error | Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner e não há necessidade de tentar novamente. |
| 106 | WA_MO_MEDIA_RETRYABLE_EXCEPTION | Not retryable media error | Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner, mas é possível tentar novamente |
| 107 | WA_MO_MEDIA_UNKNOWN_EXCEPTION | Media message unknown error | Status do WhatsApp MO que contém mídia. Esse status indica que uma mídia não pode ser baixada do contêiner e o erro é desconhecido. |
| 108 | WA_MO_MEDIA_MESSAGE_WITHOUT_FILE_ID_EXCEPTION | Media message without content | A mídia não pode ser processada corretamente quando enviada ao Felix, devido ao seu conteúdo vazio. |
| 109 | WA_MT_UNKNOWN_EXCEPTION | Unknown error (MT) | MT Error Status, indica que ocorreu um erro não relacionado ao conteúdo da mensagem em si, como tempo limite de conexão, conexão interrompida, erro interno ou erro com autenticação ssl. |
| 110 | WA_DATABASE_ERROR | Error with WhatsApp container’s database | Indica que ocorreu um erro com o banco de dados de contêiner (WhatsApp) |
| 111 | WA_MT_BLOCKED_BY_SPAM_RATE_LIMIT | Blocked for exceeding the amount of shipments (MT) | Bloqueio quando muitas mensagens idênticas são enviadas mais de uma vez para um determinado usuário, então o contêiner é bloqueado e as mensagens não são enviadas. |
| 112 | WA_MT_DESTINATION_INCAPABLE | Recipient unable to receive messages (MT) | O destinatário da mensagem não tem uma versão mais atualizada do WhatsApp ou, por algum outro motivo, não pode receber a mensagem enviada |
| 201 | NO_CREDIT | No credit | A verificação de crédito é feita no momento da solicitação de envio. Portanto, não temos esse status em mensagens persistentes. Acredito que esse status só é usado no B2C para shortcodes que são cobrados, então a mensagem pode ser recusada se o usuário não tiver crédito. |
| 202 | INVALID_DESTINATION_NUMBER | Invalid destination number | O número do destinatário é inválido e a mensagem não será enviada para a operadora ou contêiner do WhatsApp |
| 203 | BLACKLISTED | Destination in blocklist | O cliente adicionou o número à lista de bloqueio e a mensagem não será enviada para a operadora ou contêiner do WhatsApp |
| 204 | DESTINATION_BLOCKED_BY_OPTOUT | Destination in optOut | O usuário enviou o comando "exit" e foi adicionado à lista de opt-out. A mensagem não será enviada. |
| 205 | DESTINATION_MESSAGE_LIMIT_REACHED | Message limit reached | Indica que o contêiner está sobrecarregado e não pode receber mais mensagens. |
| 207 | INVALID_MESSAGE_TEXT | Message text is invalid | Envios de modelo que não estão habilitados na conta do cliente. Ou até mesmo parâmetros inválidos para a mensagem. Não temos palavras proibidas para o WhatsApp. |
| 209 | INVALID_CONTENT | Invalid message content | Indica que algum parâmetro de mensagem é inválido ou ausente. |
| 210 | INVALID_SESSION | Invalid session | Indica que foi feita uma tentativa de enviar um texto ou mídia sem que a sessão tenha sido aberta por um MO. Somente modelos são permitidos com a sessão fechada. |
| 211 | DESTINATION_BLOCKED_BY_OPT_IN | Destination blocked by optIn | O número não está na lista de opt-in e, portanto, a mensagem não será enviada. |
| 212 | DESTINATION_BLOCKED_BY_WHITELIST | Destination blocked by allowlist | O número não está na lista de números permitidos e, portanto, a mensagem não será enviada.. |
| 215 | CUSTOMER_QUOTA_BLOCKED | Client blocked by quota limit | Status que indica que o cliente atingiu sua cota (mensal/diária) para envio de mensagens e, portanto, a mensagem não será enviada. |
| 216 | MESSAGE_BLOCKED_BY_WARM_UP | Message blocked by WarmUp feature | Status para clientes do WhatsApp que estão realizando aquecimento de contêiner. A mensagem permanece nesse status quando o contêiner já atingiu o limite permitido de mensagens para a camada atual. |
| 217 | WA_MT_MEDIA_EXCEPTION | Error in media content (MT) | Status MT para mensagens de mídia, onde devido a um erro no modelo, o tamanho da mídia ou do modelo excedeu o limite suportado, o formato de mídia não foi suportado ou a mídia não pôde ser encontrada e foi considerada inválida. |
| 218 | WA_NO_PRODUCTS_FOUND | Product not found | A solicitação tentou buscar um produto que não está cadastrado no sistema. Se for uma Mensagem da Lista de Produtos, significa que o catálogo ou o produto não existe no Gerenciador de Negócios. |
| 219 | INVALID_PARAMETER_OR_CONTACT | Invalid parameter or contact/destination | Indica que algum parâmetro de mensagem é inválido ou ausente, ou que o contato/destinatário é inválido/não tem WhatsApp. |
| 301 | INTERNAL_ERROR | Internal error | Status indicando que houve algum erro interno em nossas plataformas e a mensagem não pôde ser processada e enviada. |
| 302 | WA_MO_UNKWNOWN_EXCEPTION | Unknown error (MO) | Status para WhatsApp MO. Esse status indica que ocorreu um erro desconhecido durante o processamento do MO. |
| 303 | WA_BUSINESS_PAYMENT_ISSUE | Business payment issue | Status indica que ocorreu um problema durante o pagamento da transação, que pode ser causado por erros internos e externos. A mensagem não será enviada ao usuário. |
| Field | Details | Type |
|---|---|---|
| total | Número de retornos de chamada na solicitação | Long |
| data | Lista de mensagens originadas por dispositivos móveis | Data[] |
| clientInfo | Informações de quem é a mensagem | ClientInfo |
| Field | Details | Type |
|---|---|---|
| id | Identificação da última mensagem | String |
| source | ID do remetente | String |
| origin | Telefone que identifica a conta do WhatsApp (incluindo o código do país). Exemplo: 5511900000000 | String |
| userProfile | Perfil do usuário que enviou a mensagem | UserProfile |
| correlationId | Um ID exclusivo definido por você para corresponder ao status da mensagem (retorno de chamada e DLR). Opcional, pois você pode usar o ID gerado pela Sinch | String |
| campaignId | ID da campanha definida anteriormente | String |
| campaignAlias | Alias de campanha previamente definidos | String |
| message | Mensagem MO | Message |
| receivedDate | Data em que a mensagem foi recebida. Formato: yyyy-MM-dd’T'HH:mm:ssZ | String |
| receivedAt | Data em que a mensagem foi recebida, usando o formato Unix_time | Long |
| extraInfo | Informações extras relacionadas à mensagem. Formato: Json | String |
| referral | Apresente se a mensagem foi iniciada pelo usuário clicando em uma publicação ou anúncio. Contém informações relacionadas ao anúncio. Este campo é opcional (pode ser nulo). | Referral |
| mtSentAt | O carimbo de data/hora quando a última MT foi enviada para este destinatário. | Long |
| session | Informações da sessão | Session |
| Field | Details | Type |
|---|---|---|
| id | Identificador de lista de segmentação | Integer |
| customerId | Identificador do cliente | Integer |
| subAccountId | Identificador de subconta | Integer |
| name | Nome da lista de segmentação | String |
| active | Status da lista de segmentação | Boolean |
| Field | Details | Type |
|---|---|---|
| headLine | Título do anúncio que gerou a mensagem. | String |
| body | Corpo do anúncio. | String |
| sourceType | Tipo do anúncio. Pode ser "anúncio", "post" ou "desconhecido". | String |
| sourceId | ID do anúncio no Facebook. | String |
| sourceUrl | URL do anúncio. | String |
| mediaType | Tipo de mídia do anúncio. Pode ser "imagem" ou "postagem". | String |
| mediaUrl | URL da mídia do anúncio. | String |
| Field | Details | Type |
|---|---|---|
| name | Nome do usuário especificado no WhatsApp | String |
| whatsAppId | Número de telefone do usuário | String |
| Field | Details | Type |
|---|---|---|
| sessionId | ID da sessão para este usuário | String |
| createdAt | Carimbo de data/hora de criação da sessão | Long |
| Field | Details | Type |
|---|---|---|
| type | Tipo de mensagem enviada pelo usuário final: TEXT - IMAGE - AUDIO - VIDEO - DOCUMENT - STICKER - BUTTON - ORDER - LIST | String |
| messageText | A mensagem de texto (MO) enviada pelo usuário final. Para respostas de lista, é igual a rowTitle. | String |
| mediaUrl | Url para baixar a mídia enviada pelo usuário final. | String |
| mimeType | Tipo mime do arquivo enviado pelo usuário final. | String |
| caption | Etiqueta de mídia enviada pelo usuário final. | String |
| location | Local enviado pelo usuário final. | Location |
| contacts | Contato(s) enviado(s) pelo usuário final. | Contact[] |
| receivedInteractive | Os campos interativos recebidos. | ReceivedInteractive |
| Field | Details | Type |
|---|---|---|
| order | O objeto de pedido com as informações dos produtos (PRODUCT_LIST) | Order |
| listReply | Responder para lista enviada pelo usuário. (LIST) | ListReply |
| payload | Texto definido ao enviar botões (REPLY_BUTTON) | String |
| Field | Details | Type |
|---|---|---|
| catalogId | O catalogId configurado no Gerenciador de Negócios | String |
| productItems | Matriz de ProductItem. | ProductItem[] |
| Field | Details | Type |
|---|---|---|
| productRetailerId | Identificador exclusivo (no catálogo) do produto | String |
| quantity | Número de itens comprados | String |
| itemPrice | Preço unitário dos itens | String |
| currency | Moeda do preço | String |
| Field | Details | Type |
|---|---|---|
| rowIdentifier | Identificador de linha enviando na mensagem original para o usuário | String |
| rowTitle | Título da linha enviando na mensagem original para o usuário | String |
| Field | Details | Type |
|---|---|---|
| customerId | CustomerId para o qual a mensagem se destina | Long |
| subAccountId | SubAccountId para o qual a mensagem se destina | Long |
| userId | UserId para o qual a mensagem se destina | Long |
| Mídia | Tipos de conteúdo suportados |
|---|---|
| documento | Qualquer tipo MIME válido |
| imagem | imagem/jpeg, imagem/png |
| áudio | áudio/aac, áudio/mp4, áudio/amr, áudio/mpeg, áudio/ogg; codecs=opus |
| vídeo | Vídeo/MP4, Vídeo/3GPP. Nota: Apenas o codec de vídeo H.264 e o codec de áudio AAC são suportados. |
| Campo | Valor |
|---|---|
| file_url | Link para download de um arquivo do tipo csv contendo os campos "origem" e "session_created_at" de todos os destinos encontrados |
| Campo | Detalhes | Tipo |
|---|---|---|
| total | Número de callbacks retornados. | String |
| data | Dados retornados no Callback. | Data[] |
| clientInfo | Informações do cliente. | ClientInfo |
| conversationID | String |
| Campo | Detalhes | Tipo |
|---|---|---|
| id | id da mensagem. | String |
| correlationId | Caso tenha sido especificado um correlationId no envio da mensagem, ele irá aparecer aqui. | String |
| destination | Número do telefone que a mensagem foi enviada (incluindo código de pais). Exemplo: 5511900000000. | String |
| origin | Número da Conta de WhatsApp (incluindo código de pais). Exemplo: 5511900000000. | String |
| campaignId | Caso tenha sido especificado um campaignID no envio da mensagem, ele irá aparecer aqui. | String |
| campaignAlias | Caso tenha sido especificado um campaignAlias no envio da mensagem, ele irá aparecer aqui. | String |
| extraInfo | Informação extra enviada com a mensagem original. | String |
| sent | Indica se a mensagem foi enviada. | Boolean |
| sentStatusCode | Código de Status gerado pela Sinch Messaging WhatsApp API para a mensagem indicando o status de envio. | Number |
| sentStatus | Descrição do status de envio. | Boolean |
| sentDate | Data em que a mensagem foi enviada. Formato: yyyy-MM-dd’T'HH:mm:ssZ. | String |
| sentAt | Horário em que a mensagem foi enviada, usando Unix_time format | Number |
| delivered | Indica se a mensagem foi entregue no destino. | Boolean |
| deliveredStatusCode | Código de Status gerado pela Sinch Messaging WhatsApp API indicando se a mensagem foi entregue. | Number |
| deliveredStatus | Descrição do status de entrega. | String |
| deliveredDate | Data em que a mensagem foi entregue. Formato:: yyyy-MM-dd’T'HH:mm:ssZ | String |
| deliveredAt | Horário em que a mensagem foi entregue, usando Unix_time format | Number |
| read | Indica se a mensagem foi lida pelo destinatário. | Boolean |
| readDate | Data em que a mensagem foi lida. Formato: yyyy-MM-dd’T'HH:mm:ssZ | String |
| readAt | Horário em que a mensagem foi lida, usando Unix_time format | String |
| updatedDate | Data em que o status da mensagem foi atualizado. Formato: yyyy-MM-dd’T'HH:mm:ssZ | String |
| updatedAt | Horário em que o status da mensagem foi atualizado, usando Unix_time format | String |
| type | O tipo de entidade a que se refere este objeto de status. Atualmente, a única opção disponível é “mensagem”. | String |
| Campo | Detalhes | Tipo |
|---|---|---|
| customerId | Código de identificação do cliente. | Number |
| subAccountId | Código de identificação da subconta. | Number |
| userId | Código de identificação do usuário. | Number |
| Status | Descrição | Equivalente ao WhatsApp para dispositivos móveis |
|---|---|---|
| SENT_SUCCESS | Mensagem recebida pelo servidor do WhatsApp | Uma marca de seleção |
| DELIVERED_SUCCESS | Mensagem entregue para o destinatário | Duas marcas de seleção |
| READ_SUCCESS | Mensagem lida pelo destinatário | Duas marcas de seleção azuis |
| Código de envio | Código de entrega | Status | Significado |
|---|---|---|---|
| 102 | CARRIER COMMUNICATION ERROR | Erro ao fazer upload de mídia para o WhatsApp | |
| 103 | REJECTED_BY_CARRIER | Ocorreu erro de comunicação com o WhatsApp. | |
| 2 | 101 | EXPIRED | Mensagem expirada. |
| 2 | 104 | NOT_DELIVERED | Possíveis Causas: Limite atingido - muitos envios de mensagens tentados; Ou falha ao enviar mensagem porque o número de telefone de destino é parte de um experimento; Ou a estrutura do template não existe; Ou falhou ao enviar mensagem pois o número de destino está fora da janela de atendimento de 24h para receber mensagens de forma livre; Ou houve erro de upload de mídia (erro desconhecido); Ou falha ao enviar mensagem porque sua conta é inelegível no Facebook Business Manager; Ou houve falha temporária de upload. Tente novamente mais tarde. |
| 2 | 105 | WA_MO_MEDIA_UNRETRYABLE_EXCEPTION | |
| 202 | EXPIREDINVALID_DESTINATION_NUMBER | Contato de WhatsApp inválido. | |
| 204 | DESTINATION_BLOCKED_BY_OPTOUT | Destino bloqueado por Opt-Out. | |
| 207 | INVALID_MESSAGE_TEXT | Valor de parâmetro inválido. | |
| 209 | INVALID_CONTENT | Tipo de mensagem UNKNOWN inválido. | |
| 210 | INVALID_SESSION | Sessão ou janela de atendimento não está aberta e nenhum Template de fallback está configurado. | |
| 301 | INTERNAL_ERROR | Não foi possível verificar o contato na API do WhatsApp. |
| HTTP Code | Description |
| 2xx | Success |
| 200 | Success (OK) |
| 201 | Successfully created (For POST requests) |
| 302 | Found |
| 4xx | Client Errors |
| 400 | Request was invalid |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 405 | Method not allowed |
| 412 | Precondition failed |
| 429 | Too many requests |
| 5xx | Server Errors |
| 500 | Internal server error |
| 504 | Timeout |
| Nome do atributo | Valor do atributo |
|---|---|
| êxito | true |
| estado | 200 |
| dados | Link para baixar o arquivo do tipo csv contendo os campos “source” e “createdAt” de todos os destinos encontrados |
| Field | Details | Type |
|---|---|---|
| total | Número de retornos de chamada na chamada. | String |
| data | Lista de retorno de chamada. | Data[] |
| clientInfo | Informações ao Cliente | ClientInfo |
| Field | Details | Type |
|---|---|---|
| id | ID da última mensagem. | String |
| correlationId | Um ID exclusivo definido por você para corresponder aos retornos de chamada da mensagem. O mesmo id enviado no MT que correspondia ao MO que gerou o evento opt out. | String |
| destination | Telefone para o qual a mensagem foi enviada (incluindo o código do país). Exemplo: 5511900000000. | String |
| origin | Telefone que identifica a conta do WhatsApp (incluindo o código do país). Exemplo: 5511900000000. | String |
| campaignId | ID de campanha definido anteriormente. | String |
| campaignAlias | Alias de campanha definidos anteriormente. | String |
| extraInfo | Informações extras enviadas com a mensagem original. | String |
| conversation | O objeto de conversação, que contém em si id, origin.type e expiration. Esse objeto estava relacionado ao novo modelo faturável de mensagens de whatsapp. Veja a conversa do Whatsapp. | Conversation |
| eventType | Indica o tipo de evento de desativação. Pode assumir 'OPT_OUT' ou 'EXIT_OPT_OUT'. Se o valor for 'OPT_OUT', o usuário digitou opt out, caso contrário, se o valor for 'EXIT_OPT_OUT', o usuário saiu do optout. | String |
| eventDate | Data em que ocorreu o evento de desativação. Formato: aaaa-MM-dd'T'HH:mm:ssZ | String |
| Field Name | Type | Details |
|---|---|---|
| conversation.id | String | Um id é criado sempre que uma conversa é iniciada. |
| conversation.origin | ConversationOrigin | O objeto de origem da conversação refere-se à origem da conversa. |
| conversation.expiration | Timestamp | Indica quando a conversa em andamento expira, o que seguirá a regra de 24 horas após o início da conversa. |
| Field Name | Details |
|---|---|
| BUSINESS_INITIATED | Quando uma conta comercial envia a primeira mensagem para o usuário. |
| USER_INITIATED | Indica que a conversa foi iniciada por uma conta comercial respondendo a uma mensagem de usuário |
| REFERRAL_CONVERSION | A conversa se originou de um ponto de entrada gratuito, que é quando um usuário envia mensagens para a empresa usando botões de chamada para ações. |
| Campo | Detalhes | Tipo |
|---|---|---|
| total | Números de callbacks para a ligação. | String |
| data | Lista de mensagens Mobile Originated (MO). | Data[] |
| Campo | Detalhes | Tipo |
|---|---|---|
| id | Última identificação da mensagem | String |
| source | Número de telefone do remetente | String |
| origin | Número de telefone que identifica a Conta de WhatsApp (incluindo código de pais). Exemplo: 5511900000000. | String |
| userProfile | Perfil do usuario que enviou a mensagem | UserProfile |
| correlationId | Um ID unico definido por voce para comparar com o status da mensagem (Callback and DLR). Este parametro é opcional, e voce pode usar o ID gerado pelo Sinch Messaging para fazer a comparação. | String |
| campaignId | campaignID definido anteriormente. | String |
| campaignAlias | Campaign alias definido anteriormente. | String |
| message | Mensagem MO. | mensagem |
| receivedAt | Data em que a mensagem foi recebida. Format: yyyy-MM-dd’T'HH:mm:ssZ | String |
| receivedDate | Data em que a mensagem foi recebida, usando Unix_time format | String |
| extraInfo | Informação extra relacionada com a mensagem. Formato: Json | String |
| referral | Caso a mensagem tenha se iniciado por um click em alguma propaganda, o campo contém a informação do anúncio/publicação. Esse campo é opcional (pode ser nulo). | Referral |
| mtSentAt | O timestamp de data/hora em que o último MT foi enviada a este destinatário. | Long |
| session | Informação da sessão. | Session |
{% endtab %} {% tab title="Ruby" %} ``` { "total":1, "data":[ { "id":"ce425ffe-bc62-421f-9261-e6819a5eab43", "source":"5511900000000", "origin":"5511900000000", "userProfile":{ "name":"username", "whatsAppId":"5511900000000" }, "correlationId":"...", "messageId":"aae959ca-5944-405a-809a-75ff142bc234", "message":{ "type":"BUTTON", "messageText":"Sim", "payload":"sim" }, "receivedAt":1513616971473, "receivedDate":"2020-07-22T14:24:41Z", "session":{ "id":"06deff90-cc27-11ea-b94f-0050569e62ca", "createdAt":1513616971473 } } ], "clientInfo":{ "customerId":10, "subAccountId":0, "userId":101010 } } ``` {% endtab %} {% tab title="Python" %} ``` { "total":1, "data":[ { "id":"ce425ffe-bc62-421f-9261-e6819a5eab43", "source":"5511900000000", "origin":"5511900000000", "userProfile":{ "name":"username", "whatsAppId":"5511900000000" }, "correlationId":"...", "messageId":"aae959ca-5944-405a-809a-75ff142bc234", "message":{ "type":"BUTTON", "messageText":"Sim", "payload":"sim" }, "receivedAt":1513616971473, "receivedDate":"2020-07-22T14:24:41Z", "session":{ "id":"06deff90-cc27-11ea-b94f-0050569e62ca", "createdAt":1513616971473 } } ], "clientInfo":{ "customerId":10, "subAccountId":0, "userId":101010 } } ``` {% endtab %} {% tab title="PHP" %} ``` { "total":1, "data":[ { "id":"ce425ffe-bc62-421f-9261-e6819a5eab43", "source":"5511900000000", "origin":"5511900000000", "userProfile":{ "name":"username", "whatsAppId":"5511900000000" }, "correlationId":"...", "messageId":"aae959ca-5944-405a-809a-75ff142bc234", "message":{ "type":"BUTTON", "messageText":"Sim", "payload":"sim" }, "receivedAt":1513616971473, "receivedDate":"2020-07-22T14:24:41Z", "session":{ "id":"06deff90-cc27-11ea-b94f-0050569e62ca", "createdAt":1513616971473 } } ], "clientInfo":{ "customerId":10, "subAccountId":0, "userId":101010 } } ``` {% endtab %} {% tab title="Java" %} ``` { "total":1, "data":[ { "id":"ce425ffe-bc62-421f-9261-e6819a5eab43", "source":"5511900000000", "origin":"5511900000000", "userProfile":{ "name":"username", "whatsAppId":"5511900000000" }, "correlationId":"...", "messageId":"aae959ca-5944-405a-809a-75ff142bc234", "message":{ "type":"BUTTON", "messageText":"Sim", "payload":"sim" }, "receivedAt":1513616971473, "receivedDate":"2020-07-22T14:24:41Z", "session":{ "id":"06deff90-cc27-11ea-b94f-0050569e62ca", "createdAt":1513616971473 } } ], "clientInfo":{ "customerId":10, "subAccountId":0, "userId":101010 } } ``` {% endtab %} {% endtabs %} ### Message:
| Campo | Detalhes | Tipo |
|---|---|---|
| type | Tipo de mensagem enviada pelo usuário final: TEXT - BUTTON - IMAGE - AUDIO - DOCUMENT | String |
| messageText | A mensagem de texto (MO) enviada pelo usuário final. | String |
| waGroupId | Grupo ao qual a mensagem foi enviada. | String |
| mediaUrl | Url para download da midia enviada pelo usuário final. | String |
| mimeType | Mime type do arquivo enviado pelo usuário final. | String |
| caption | Media label enviada pelo usuário final. | String |
| location | Localidade enviada pelo usuário final. | Location |
| contacts | Contatos enviados pelo usuário final. | Contact[] |
| Campo | Detalhes | Tipo |
|---|---|---|
| headLine | Título do ad que gerou a mensagem. | String |
| body | Corpo do ad que gerou a mensagem. | String |
| sourceType | Tipo da propaganda que o usuario clicou. Valores podem ser “ad”, “post” ou “unknown”. | String |
| sourceId | Identificador da propaganda no Facebook. | String |
| sourceUrl | Url da propaganda. Leva para a propaganda que o usuario clicou. | String |
| mediaType | Tipo mídia presente na propaganda. Pode ser “image” ou “video”. | String |
| mediaUrl | Url da mídia presente na propaganda. | String |
| Field | Details | Type |
|---|---|---|
| sessionId | Id da sessão para este usuário. | String |
| createdAt | Timestamp de criação da sessão | Long |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| name | Não | Nome de perfil do usuário | String |
| Campo | Detalhes | Tipo |
|---|---|---|
| name | Nome do local. | String |
| address | Endereço do local. | String |
| geoPoint | Geopoint enviado pelo usuário final. Formato: “latitude,longitude” | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| addresses | Não | Endereço(s) completo(s) do contato. | Address[] |
| birthday | Não | Data de aniversário com formato YYYY-MM-DD. | String |
| emails | Não | Endereço(s) de e-mail de contato. | Email[] |
| name | Não | Nome completo do contato. | Name |
| org | Não | Informações da organização do contato. | Org |
| phones | Não | Número(s) de telefone do contato. | Phone[] |
| urls | Não | URL(s) do contato. | Url[] |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| street | Não | Nome e número da rua. | String |
| city | Não | Nome da cidade. | String |
| state | Não | Sigla do Estado. | String |
| zip | Não | CEP. | String |
| country | Não | Nome completo do país. | String |
| country_code | Não | Abreviação de país (Duas letras). | String |
| type | Não | Valores Padrões: HOME, WORK. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| Não | Endereço de e-mail. | String | |
| type | Não | Valores Padrões: HOME, WORK. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| first_name | Não | Primeiro nome. | String |
| last_name | Não | Último nome. | String |
| middle_name | Não | Nome do meio. | String |
| name_suffix | Não | Sufixo do nome. | String |
| name_prefix | Não | Prefixo do nome. | String |
| formatted_name | Não | Nome completo como normalmente aparece. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| company | Não | Nome da organização do contato. | String |
| department | Não | Nome do departamento do contato. | String |
| title | Não | Título corporativo do contato. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| phone | Não | Número de telefone formatado. | String |
| type | Não | Valores padrões: CELL, MAIN, IPHONE, HOME, WORK. | String |
| wa_id | Não | Identficador WhatsApp. | String |
| Campo | Obrigatório | Detalhes | Tipo |
|---|---|---|---|
| url | Não | URL do contato. | String |
| type | Não | Valores padrões: HOME, WORK. | String |
| Campo | Detalhes | Tipo |
|---|---|---|
| id | Identificador da lista de segmentação | Integer |
| customerId | Identificador do cliente | Integer |
| subAccountId | Identificador da subconta | Integer |
| name | Nome da lista de segmentação | String |
| active | Status da lista de segmentação | Boolean |
| Campo | Descrição |
| id | Identificador da lista de segmentação. |
| customerId | Identificador do usuário. |
| subAccountId | Identificador da subconta. |
| Referral | Um objeto opcional que contém informações sobre a referência associada à mensagem. |
| headLine | Título ou manchete no anúncio que gerou a mensagem. |
| body | Corpo ou conteúdo do anúncio. |
| sourceType | Tipo de fonte do anúncio. Pode ser "ad" (anúncio), "post" (postagem) ou "unknown" (desconhecido). |
| sourceId | Identificador do anúncio no Facebook. |
| sourceUrl | URL do anúncio. |
| mediaType | Tipo de mídia do anúncio. Pode ser "image" (imagem) ou "video" (vídeo). |
| mediaUrl | URL da mídia do anúncio. |
Tela de login
email de configuração de senha
reset de senha
| Palavra | Descrição |
|---|---|
| Facebook Business Manager | É Plataforma de gerenciamento de negócios de empresas na Meta (Facebook). Abriga a Conta geral da Sinch (empresa) no Facebook e também a dos nossos clientes. Inclui todos os serviços e aplicativos da Meta (Facebook) (Contas de anúncios, Páginas, Apps, Funcionários, etc). O Business Manager é referenciado por um ID que precisamos receber de cada cliente nosso - o BM ID (Business Manager ID) - para poder configurar a conta do cliente no Whatsapp (WABA) |
| WABA | Whatsapp Business Account (WABA) – Conta de cada Cliente Sinch no Whatsapp dentro da qual serão criadas os Números de Telefone (ou “Contas Verificadas”) |
| Números de Telefone | Cada número que é criado dentro de um WABA, como uma “Conta Verificada”. Depois de criada e instalada o Whatsapp pode dar ao nosso cliente o badge VERDE, de “Verified Account” ou mante-lo apenas com o badge CINZA, de “Conta Comercial”. Isso é uma decisão do Whatsapp. |
| Container | Cada número de WhatsApp necessita de uma solução de tecnologia que esta vinculada á containers (servidores.) |
| API | É um conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades por aplicativos que não pretendem envolver-se em detalhes da implementação do software, mas apenas usar seus serviços. |
| Blocklist | São números que a empresa adiciona e classifica como números que não podem receber mensagens. Exemplo: número de concorrentes. |
| Carrier | Você também é cliente de uma Carrier! Denominamos por Carrier a Operadora que detém o número em questão. Ou seja, meu número é TIM, então a Carrier do meu MSISDN é a TIM. |
| Conta ou Customer ID | Cada um de nossos clientes possui um customer ID. |
| Conversion Rate | A taxa de conversão, ou conversion rate (principalmente usado por clientes internacionais) é a fórmula utilizada para medir a quantidade de mensagem trafegada VS o volume de entrega. Quando há queda de DR, os clientes são afetados diretamente na conversion rate, podendo direcionar o tráfego para outro broker de SMS que esteja com a conversion rate melhor. |
| Deploy | Um Deploy, ou lançamento, é toda atualização, lançamento ou nova versão de alguma feature. Podendo ser em homologação ou produção, todos os deploys incrementam ou retiram alguma feature. |
| FTP | Esse sistema é muito utilizado na Sinch para envios em lotes grandes. Cada plataforma (WA ou SMS) deve respeitar um formato pré estabelecido |
| MO | MO, ou Mobile Originated, é toda mensagem que parte de um aparelho para a empresa em questão. É utilizado no caso de perguntas e respostas por mensagem, quando é necessária a confirmação do usuário. |
| MT | MT, ou Mobile Terminated, é toda mensagem que tem com destino o aparelho do usuário. Ou seja, a empresa envia uma mensagem para o número em questão. |
| MSISDN | É um número que identifica exclusivamente uma assinatura em uma rede móvel GSM ou UMTS. |
| Opt-in | Opt-in é a permissão dada pelo usuário para que uma empresa possa entrar em contato com ela por determinado canal. Essa permissão pode ser, por exemplo, através do site da própria empresa, email ou SMS. |
| Opt-out | Opt-out é quando o usuário opta por não receber mais mensagens daquele contato por um determinado canal. Quando um usuário opta por sair da lista de contato, o nosso sistema bloqueia qualquer tentativa de envio que possa ocorrer para o usuário daquele contato. |
| Subconta | Dentro de uma Conta, é possível ter várias Subcontas com “departamentos” e configurações personalizadas, onde é possível realizar vários disparos diferentes, como atendimento, CRM, Status de pedido, entre outros. |
| Webhook | Um webhook é uma ponte de informação entre o nosso sistema Sinch e a empresa dona do Webhook. Essa ponte é feita através de uma URL onde trafegam informações entre o nosso sistema e o sistema desejado pelo nosso cliente. |
| Whitelist | Os usuários que estão em Whitelist, são usuários que a empresa adiciona e classifica como usuários que podem receber mensagens. Isso não significa que esse usuário deu a permissão em algum momento. |
| Template WhatsApp | Um template utilizado para enviar mensagens ativas para seus clientes. Todo template deve ser aprovado pelo WhatsApp antes de ser usado – dessa forma eles garantem que você está seguindo as diretrizes de conteúdo permitidas. |
| Sessão Aberta | Uma sessão só é dada como aberta quando o usuário final responde nosso contato ativo, e cada sessão tem uma duração de 24 horas fixas. |
| Sessão Fechada | Uma sessão só é dada como aberta quando o usuário final responde nosso contato ativo, e cada sessão tem uma duração de 24 horas fixas. |
| Tier | Tier é a quantidade de usuários que podemos enviar mensagens dentro de 24h. |
dados do número
dados de acesso
editar perfil
criar template
sugestões de template
Cabeçalho texto
pré-visualização
 {% hint style="warning" %} A formatação do texto de cada campo, é distinta. {% endhint %} **Cabeçalho:** Fica em negrito no começo da mensagem, caso tenha escolhido o cabeçalho de mídia uma prévia de imagem aparece. A mídia só é anexada quando a mensagem for disparada para os clientes.\ **Corpo da mensagem:** O corpo da sua mensagem aparece, em tom claro de acordo com os dados que você configuração.\ **Rodapé:** Aparece em tom mais claro de cinza ao final da mensagem.\ **Botões:** Aparecem ao final da mensagem para que o usuário clique.
{{1}}
Tudo bem? Seguem informações sobre sua passagem:
| | **Seu voo para a cidade {{3}} está agendado para o dia {{4}}, às {{5}}. Boa viagem!** |{{2}}
{{3}}
Anote os dados do seu voo, para não esquecer:
{{4}}
{{5}}
| ## Exemplos de mensagens rejeitadas {% hint style="danger" %} * **Sabia que você tem um empréstimo pré-aprovado de {{1}}? Você pode parcelar em até {{2}} vezes, e o dinheiro cai na sua conta em até 24 horas depois da aprovação! Não perca! A oferta é válida até o dia {{3}}.** * **Oi, {{1}}! Tudo bem? Temos uma ótima notícia! Falta apenas um click para você contratar seu empréstimo. É só responder essa mensagem que poderemos te ajudar!** * **Aqui é o Assistente Digital e falamos em nome da loja {{2}}. Vimos que você se interessou pelo {{3}}, no portal {{4}}. Que tal simular um financiamento, agendar um test-drive ou adiantar a avaliação do seu usado? Basta clicar no link: {{5}}** * **Temos novidades para você! Para conferir gratuitamente e se preparar para aumentar suas vendas, digite:** **1 - para conhecer a coleção {{3}};** **2 - para receber o catálogo {{2}}.** * **Temos uma proposta para você! Podemos conversar por aqui agora?** {% endhint %} ## Abertura de Sessão {% hint style="warning" %} A sessão tem uma duração fixa de 24 horas e é iniciada quando o disparo da comunicação é realizado por sua empresa para seu cliente final. {% endhint %} ## **Sugestões de Templates** 1. **Opt-in de canal:** Olá! Gostaríamos de te informar que este é o canal oficial da empresa {{1}} você poderá utilizar este canal para {{2}}. Clique no botão "Sim, eu quero!" para começar a receber ou em "Sair" caso não tenha interesse:\ Botões: Sim, eu quero! | Sair 2. **Auxílio para pessoas que querem comprar os produtos / serviços garantir coleta de optin no próprio site e que a base seja com menos de 3 dias.** Olá vimos que iniciou seu cadastro em nosso site, gostaríamos de te comunicar que este é nosso canal no WhatsApp e por aqui você poderá tirar suas dúvidas. Clique no botão "Sim, eu quero!" para saber mais ou em "Sair" caso não tenha interesse: Botões: Sim, eu quero! | Sair3. **Boletos / faturas** Olá, este é o canal oficial da empresa {{1}} para avisos de fatura a pagar ou vencidas | status de pedido | status de conta. Clique no botão "Sim, eu quero!" para começar a receber ou "Sair" caso não tenha interesse: Botões: Sim, eu quero! | Sair
4. **Status pedidos** Olá, este é o canal oficial do {{1}} para informações e status de pedidos. Clique no botão "Sim, eu quero!" para começar a receber ou "Sair" caso não tenha interesse: Botões: Sim, eu quero! | Sair
5. **Consignados / Empréstimos** Olá, este é o canal oficial da {{1}}, por aqui, você consegue tirar dúvidas e saber mais sobre {{2}}. Clique no botão "Sim, eu quero!" para saber mais ou "Sair" caso não tenha interesse: Botões: Sim, eu quero! | Sair
## **Respostas automáticas:** **SAIR:** Seu pedido para sair da conversa foi atendido. Favor enviar #voltar para retornar! **#VOLTAR:** Seu pedido de retornar à conversa foi atendido! Bem vindo de volta! **Informativo general:** Obrigada, por aqui você irá receber essas informações, fique ligado.\ \ **Auxílio para pessoas que querem comprar os produtos | serviços garantir coleta de optin no próprio site e que a base seja com menos de 3 dias.** Obrigada, em breve entraremos em contato para tirar suas dúvidas Obrigada, envie um Oi para iniciar seu atendimento.\ \ **Boletos | Faturas:** Obrigada, por aqui você irá receber essas informações, fique atento. **Status pedidos:** Obrigada, por aqui você irá receber o status do(s) seu(s) pedido(s), fique atento. **Consignados | Empréstimos:** Obrigada, em breve iremos entrar em contato através do canal para melhor lhe atender. Muito bom ter você por aqui. Manteremos você sempre informado por este canal, e quando precisar é só nos chamar. {% embed url="
Messaging > Menu lateral esquerdo expanda o menu de WhatsApp > Templates. Você visualizará no cabeçalho as seguintes informações:
| destination | name | info | correlationid |
|---|---|---|---|
| destination | name | info | correlationid |
| 5511987654321 | André | Sinch | campanha_X |
| 5511912345678 | Mozart | Sinch | campanha_Y |
| Celular | Nome | Empresa | Produto |
| 555111457897 | Renata | Sinch |
| Celular | Nome | Empresa | Produto |
|---|---|---|---|
| Celular | Nome | Empresa | Produto |
| 5511112233 | Renata | Sinch | |
| 5511333444 | Carol | Sinch | |
| 5511555666 | Fulano |
| Celular | Nome | Nome | Empresa |
nova mensagem
campanhas