tyntec WhatsApp Empresarial
Habilita o canal de comunicação do WhatsApp usando a API tyntec Conversations para melhorar sua capacidade de comunicação
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Tyntec |
| URL | https://www.tyntec.com/get-help-support |
| support@tyntec.com |
| Metadados do conector | |
|---|---|
| Editora | tyntec GmbH |
| Sítio Web | https://www.tyntec.com |
| Política de privacidade | https://www.tyntec.com/data-privacy-statement |
| Categorias | Comunicação; Comércio |
O conector "tyntec WhatsApp Business" enriquece os recursos de comunicação do Power Apps, Power Automation ou Azure Logic Apps ao habilitar um canal unidirecional do WhatsApp. Ele permite que você envie notificações, alertas, memorandos ou materiais de envolvimento do cliente usando a API tyntec Conversations.
Pre-requisites
Você precisará do seguinte para prosseguir:
- Um plano Microsoft Power Apps ou Power Automate com recurso de conector personalizado
- Chave API tyntec
- Conta do WhatsApp Business fornecida pela tyntec
- Modelo de mensagem do WhatsApp aprovado pelo WhatsApp
Como obter a chave de API?
- Registar-me/Inicie sessão na sua conta tyntec
- Clique em Configurações da API
- Nas configurações da API, clique em New API KEY
- Copie a chave de API recém-atribuída
Como obter o número de conta do WhatsApp Business?
- Acompanhe a diretriz [no site da tyntec](https://www.tyntec.com/docs/ whatsapp-business-api-account-information-get-started#toc--set-up-your-whatsapp-business-account-waba-)
Como obter o modelo de mensagem do WhatsApp?
- Acompanhe a diretriz sobre tyntec webiste
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| apikey | securestring | O apikey para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
|
Botão Enviar URL Dinâmico de Modelo do Whats |
Envia o botão URL dinâmico do modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar lista de produtos de forma gratuita do Whats |
Envia lista de produtos do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de contato de forma gratuita do Whats |
Envia mensagem de contato pelo WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de documento de forma gratuita do Whats |
Envia mensagem de documento de forma livre do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de documento modelo do Whats |
Envia imagem de documento modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar mensagem de figurinha de forma gratuita do Whats |
Envia mensagem de figurinha do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
| Enviar mensagem de imagem de forma livre |
Envia mensagem de imagem livre. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de imagem de modelo do Whats |
Envia mensagem modelo do WhatsApp com imagem. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar mensagem de lista de forma gratuita do Whats |
Envia mensagem de lista do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de localização de forma gratuita do Whats |
Envia mensagem de localização do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de localização do modelo do Whats |
Envia mensagem de modelo de localização do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar mensagem de modelo do Whats |
Enviar mensagem de modelo do WhatsApp (preterido) |
|
Enviar mensagem de texto de forma gratuita do Whats |
Envia mensagens de texto simples de forma livre através do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente). |
|
Enviar mensagem de texto de modelo do Whats |
Envia mensagem de texto de modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar mensagem de vídeo de forma gratuita do Whats |
Envia mensagem de vídeo de forma livre do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar mensagem de vídeo modelo do Whats |
Envia mensagem de vídeo modelo Whatsapp. Utilizável a qualquer momento. Requer modelo registrado. |
| Enviar mensagem de áudio de forma livre |
Envia mensagem de áudio de forma livre. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Enviar modelo de Whats |
Esta ação envia modelo de WhatsApp com resposta rápida. Utilizável a qualquer momento. Requer modelo registrado. |
|
Enviar Whats |
Envia resposta rápida ao WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Envie um único produto de forma gratuita para o Whats |
Envia mensagem única de produto do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente) |
|
Mensagem de Free-Form do Whats |
Enviar mensagem de formulário gratuito (preterido) |
| Valide o seu número WABA |
Valide o seu número WABA |
| Verificação de status |
Verificar o estado da sua mensagem |
| Verificação de status (preterido) [PRETERIDO] |
Verificar o estado da sua mensagem (preterido) |
Botão Enviar URL Dinâmico de Modelo do WhatsApp
Envia o botão URL dinâmico do modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
indexar
|
index | integer |
indexar |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar lista de produtos de forma gratuita do WhatsApp
Envia lista de produtos do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
catalogId
|
catalogId | string |
catalogId |
|
|
productId
|
productId | string |
productId |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de contato de forma gratuita do WhatsApp
Envia mensagem de contato pelo WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
city
|
city | string |
city |
|
|
country
|
country | string |
country |
|
|
Código do país
|
countryCode | string |
Código do país |
|
|
rua
|
street | string |
rua |
|
|
tipo
|
type | string |
tipo |
|
|
ZIP
|
zip | string |
ZIP |
|
|
formattedName
|
formattedName | string |
formattedName |
|
|
sobrenome
|
lastName | string |
sobrenome |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de documento de forma gratuita do WhatsApp
Envia mensagem de documento de forma livre do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
URL
|
url | string |
URL |
|
|
legenda
|
caption | string |
legenda |
|
|
filename
|
filename | string |
filename |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de documento modelo do WhatsApp
Envia imagem de documento modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
URL
|
url | string |
URL |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de figurinha de forma gratuita do WhatsApp
Envia mensagem de figurinha do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
URL
|
url | string |
URL |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de imagem de forma livre
Envia mensagem de imagem livre. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
URL
|
url | string |
URL |
|
|
legenda
|
caption | string |
legenda |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de imagem de modelo do WhatsApp
Envia mensagem modelo do WhatsApp com imagem. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
URL
|
url | string |
URL |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de lista de forma gratuita do WhatsApp
Envia mensagem de lista do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
title
|
title | string |
title |
|
|
title
|
title | string |
title |
|
|
payload
|
payload | string |
payload |
|
|
title
|
title | string |
title |
|
|
descrição
|
description | string |
descrição |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de localização de forma gratuita do WhatsApp
Envia mensagem de localização do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
longitude
|
longitude | float |
longitude |
|
|
latitude
|
latitude | float |
latitude |
|
|
nome
|
name | string |
nome |
|
|
address
|
address | string |
address |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de localização do modelo do WhatsApp
Envia mensagem de modelo de localização do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
longitude
|
longitude | float |
longitude |
|
|
latitude
|
latitude | float |
latitude |
|
|
nome
|
name | string |
nome |
|
|
address
|
address | string |
address |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de modelo do WhatsApp (preterido) [PRETERIDO]
Enviar mensagem de modelo do WhatsApp (preterido)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | True | string |
Número de telefone do destinatário |
|
channels
|
channels | True | array of string |
channels |
|
de
|
from | True | string |
Seu número de conta do WhatsApp Business |
|
templateId
|
templateId | True | string |
O ID do seu modelo |
|
política linguística
|
policy | True | string |
política linguística |
|
idioma-código
|
code | True | string |
código linguístico |
|
tipo
|
type | True | string |
tipo |
|
tipo
|
type | string |
Tipo do parâmetro |
|
|
subtipo
|
subType | string |
Usado para botões de chamada para ação |
|
|
URL
|
url | string |
URL |
|
|
tipo
|
type | string |
Tipo de suporte utilizado |
|
|
filename
|
filename | string |
filename |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
Enviar mensagem de texto de forma gratuita do WhatsApp
Envia mensagens de texto simples de forma livre através do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | True | string |
de |
|
Para
|
to | True | string |
Para |
|
enviar SMS
|
text | True | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de texto de modelo do WhatsApp
Envia mensagem de texto de modelo do WhatsApp. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de vídeo de forma gratuita do WhatsApp
Envia mensagem de vídeo de forma livre do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
URL
|
url | string |
URL |
|
|
legenda
|
caption | string |
legenda |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de vídeo modelo do WhatsApp
Envia mensagem de vídeo modelo Whatsapp. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
canal
|
channel | string |
canal |
|
|
TipoDeConteúdo
|
contentType | string |
TipoDeConteúdo |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
URL
|
url | string |
URL |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar mensagem de áudio de forma livre
Envia mensagem de áudio de forma livre. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
URL
|
url | string |
URL |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar modelo de WhatsApp Resposta Rápida
Esta ação envia modelo de WhatsApp com resposta rápida. Utilizável a qualquer momento. Requer modelo registrado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
templateId
|
templateId | string |
templateId |
|
|
modeloLinguagem
|
templateLanguage | string |
modeloLinguagem |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
indexar
|
index | integer |
indexar |
|
|
payload
|
payload | string |
payload |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Enviar WhatsApp Resposta Rápida de forma gratuita
Envia resposta rápida ao WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
payload
|
payload | string |
payload |
|
|
title
|
title | string |
title |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Envie um único produto de forma gratuita para o WhatsApp
Envia mensagem única de produto do WhatsApp. Utilizável apenas na janela de suporte (24 horas após a última mensagem do cliente)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
de
|
from | string |
de |
|
|
Para
|
to | string |
Para |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
tipo
|
type | string |
tipo |
|
|
enviar SMS
|
text | string |
enviar SMS |
|
|
catalogId
|
catalogId | string |
catalogId |
|
|
productId
|
productId | string |
productId |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Mensagem de Free-Form do WhatsApp (preterida) [DEPRECATED]
Enviar mensagem de formulário gratuito (preterido)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Para
|
to | string |
Para |
|
|
channels
|
channels | True | array of string |
channels |
|
de
|
from | string |
de |
|
|
tipo
|
type | string |
tipo |
|
|
URL
|
url | string |
URL |
|
|
legenda
|
caption | string |
legenda |
|
|
TipoDeConteúdo
|
contentType | string |
TipoDeConteúdo |
|
|
enviar SMS
|
text | string |
enviar SMS |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
Valide o seu número WABA
Valide o seu número WABA
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número do WhatsAppBusiness:
|
whatsAppBusinessNumber | True | string |
WABA para validação |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número de telefone
|
phoneNumber | string |
O seu número |
|
displayNúmero de telefone
|
displayPhoneNumber | string |
A versão exibida do número de telefone |
|
nome verificado
|
verifiedName | string |
O nome verificado |
|
qualidadeClassificação
|
qualityRating | string |
A sua classificação de qualidade |
|
estado
|
status | string |
estado |
|
whatsAppAccountId
|
whatsAppAccountId | string |
O ID da sua conta do WhatsApp |
|
accountName
|
managedBy.accountName | string |
O nome da sua conta |
|
accountName
|
messagingVia.accountName | string |
O nome da conta managinng |
|
messagingTier
|
messagingTier | string |
Sua camada de mensagens |
|
classificação
|
qualityScore.score | string |
A sua pontuação |
Verificação de status
Verificar o estado da sua mensagem
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
messageId | True | string |
ID da mensagem |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
estado
|
status | string |
estado |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Verificação de status (preterido) [PRETERIDO]
Verificar o estado da sua mensagem (preterido)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da mensagem
|
id | True | string |
ID da mensagem |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da mensagem
|
messageId | string |
ID da mensagem |
|
Canal de entrega
|
deliveryChannel | string |
Canal de entrega |
|
estado
|
status | string |
estado |
|
carimbo de data/hora
|
timestamp | string |
carimbo de data/hora |
Acionadores
| Mensagem recebida |
Gatilhos na mensagem recebida |
| Mensagem recebida (preterida) [DEPRECATED] |
Gatilhos na mensagem de entrada (preterido) |
Mensagem recebida
Gatilhos na mensagem recebida
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Seu número de conta do WhatsApp Business
|
WABA | True | string |
Seu número de conta do WhatsApp Business |
Mensagem recebida (preterida) [DEPRECATED]
Gatilhos na mensagem de entrada (preterido)