...
Interactive Buttons
Propriedades
Propiedad | Descripción | Requerido | |
header | Contém as propriedades da parte superior do elemento.. | Sim | |
text | Contém o texto incluído no cabeçalho. | Sim* | |
imageUrl | Contém a URL da imagem no cabeçalho. | Sim* | |
videoUrl | Contém o URL do vídeo no cabeçalho.. | Sim* | |
documentUrl | Contém o URL da localização do documento. | Sim* | |
filename | Nome do arquivo para enviar o tipo de documento. | Não | |
body | Contém o texto que aparecerá abaixo do cabeçalho. | Sim | |
buttonsList | Contém uma matriz com os botões (1-3) | | Sim |
button | Informações do botão. | Sim Sim Sim | |
footer | Contém o texto que estava no rodapé do elemento. | Não | |
*Apenas uma dessas propriedades é necessária, dependendo de qual será o tipo de cabeçalho do botão interativo. Ex: imageUrl > Tipo Imagen, text > Tipo texto, etc.
...
Texto
{
"interactiveButtons": {
"header": {
"text": "text"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}
|
|---|
...
Documento
{
"interactiveButtons": {
"header": {
"documentUrl": "https://integraccs.ucontactcloud.com/attachments/
20220201/1dbb7e13-5cd9-41f5-be08-29fa6b586061.000ESPMarcadores.pdf",
"filename": "Marcadores"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}
|
|---|
...
Imagem
{
"interactiveButtons": {
"header": {
"imageUrl": "https://integraccs.ucontactcloud.com/attachments/
20220201/e2f3323a-2cb3-4ff7-9e81-1ff4ce893d26.logo192.png"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}
|
|---|
...
Vídeo
{
"interactiveButtons": {
"header": {
"videoUrl": "https://integraccs.ucontactcloud.com/attachments/
20220201/e2f3323a-2cb3-4ff7-9e81-1ff4ce893d26.sample.mp4"
},
"body": "body text",
"buttonsList": [
{
"id": "1",
"title": "Si"
},
{
"id": "2",
"title": "No"
}
],
"footer": "footer"
}
}
|
|---|
...
Interactive List
Propriedades
Propiedad | Descripción | Requerido |
header | Texto localizado no cabeçalho do elemento. | Não |
body | Texto localizado abaixo do cabeçalho. | Sim |
buttonMenu | Texto no botão para abrir o menu. | Sim |
sections | Acordo com as seções (1-2). | Sim |
title | Título para cada seção. | Não* |
rows | Acordo com as diferentes opções. | Sim |
row | Informações de cada opção: | Sim |
footer | Texto localizado no rodapé do elemento. | Não |
...
{
"interactiveList": {
"header": "Header",
"body": "Some text",
"buttonMenu": "Choose one",
"sections": [
{
"title": "First section title",
"rows": [
{
"id": "1",
"title": "first row title",
"description": "first row description"
},
{
"id": "2",
"title": "second row title",
"description": "second row description"
}
]
},
{
"title": "Second section title",
"rows": [
{
"id": "3",
"title": "third row title"
}
]
}
]
},
"footer": "Footer"
}
|
|---|
...
Contact
Propriedades
Propiedad | Descripción | Requerido |
firstName | Primeiro nome. | Sim |
lastName | Sobrenome. | Não |
middleName | Nome do meio. | Não |
formattedName | Nome e Sobrenome sem espaço. | Sim |
namePrefix | Prefixo usado no nome. | Não |
birthday | Data de nascimento. | Não |
phones | Arranjo com diferentes telefones. | Não |
phone | Número e tipo de telefone. | Não |
emails | Organização com diferentes e-mails. | Não |
email | Endereço postal e tipo. | Não |
addresses | Acordo com os diferentes endereços. | Não |
address | Información de cada dirección. type street city country zip state
| Não |
org | Informações da empresa/organização onde trabalha. | Não |
urls | Arranjo com diferentes URLs. | Não |
url | | Não |
...
{
"contact": {
"firstName": "Test",
"lastName": "Integra",
"formattedName": "TestIntegra",
"namePrefix": "Mr",
"middleName": "Algo",
"birthday": "2022-01-21",
"phones": [
{
"type": "WORK",
"phone": "308740239"
}
],
"email": [
{
"email": "testing@integraccs.com",
"type": "WORK"
}
],
"addresses": [
{
"type": "WORK",
"street": "Paseo de la Carretas",
"city": "Montevideo",
"country": "Uruguay",
"zip": "11800",
"state": "MV"
}
],
"org": {
"company": "Integra",
"department": "Development",
"title": "Senior Developer"
},
"urls": [
{
"url": "http://www.integraccs.com ",
"type": "WORK"
}
]
}
}
|
|---|
...
Location
Propriedades
Propiedad | Descripción | Requerido |
address | Endereço do local no mapa: rua e cidade. | Não |
name | nome do local. | Não |
latitude | Coordenada específica norte-sul. | Sim |
longitude | Coordenada . específica leste-oeste. | Sim |
{
"location": {
"address": "Bv. Gral. Artigas 1825 Departamento de Montevideo",
"name": "Tres Cruces Shopping",
"latitude": "-34.8938251",
"longitude": "-56.1685413"
}
}
|
|---|
...
Template/HSM
Propriedades
Propiedad | Descripción | Requerido |
name | Nome ou ID do modelo aprovado para WhatsApp. | Sim |
type | Tipo de template. | Sim |
language | Linguagem do template. | Sim |
contentHeader | Texto incluído no cabeçalho. | Sim(1) |
latitude | Coordenada específica norte-sul. | Sim(2) |
longitude | Coordenada específica leste-oeste. | Sim(2) |
filename | Nome do documento. | Não(3) |
placeholders | Arranjo com as variáveis no texto de template. | Sim(4) |
buttonType | Tipo de Botão (URL o QUICK_REPLY). | Sim(4) |
buttonsList | Arranjo variável do texto no botão. | Sim(4) |
...
4: Requerido se o template contém variáveis ou botões, ele deve ser o número exato de elementos na matriz.
...
Text (Gupshup)
{
"template":{
"name":"0e05d104-4efd-4363-8c90-69eaca8b0c0d",
"type":"text",
"placeholders":[
"phone",
"86565887",
"updates"
]
}
}
|
|---|
...
Body (Infobip v2)
{
"template":{
"name":"infobip_test_hsm_2",
"type":"Body",
"language":"en_US",
"placeholders":[
"John",
"john@gmail.com"
]
}
}
|
|---|
...
Vídeo (Infobip v2)
{
"template":{
"name":"instruction_video",
"type":"video",
"language":"en",
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/1ae7ef92-0775-4b88-91f8-db2ba1a20000.mp4"
}
}
|
|---|
...
Vídeo (Gupshup)
{
"template":{
"name":"3af461ef-2799-479a-9d8e-d0bff1bf851a",
"type":"video",
"placeholders":[
"Matias",
"Account"
],
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/1ae7ef92-0775-4b88-91f8-db2ba1a20000.mp4"
}
}
|
|---|
...
Imagem (Infobip v2)
{
"template":{
"name":"boarding_pass",
"type":"Image",
"language":"en",
"placeholders":[
"1899"
],
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/f3038b7c-2ef7-4d5f-821a-27942c072926.jpeg"
}
}
|
|---|
...
Imagem (Gupshup)
{
"template": {
"name": "a730dd25-845c-4f99-823a-a495b751ce67",
"type": "image",
"placeholders": ["Matias", "07/02/2022","Admin"],
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220203/19cd82ad-fb36-4414-8c60-fe1be13b4f2c.jpeg"
}
}
|
|---|
...
{
"template":{
"name":"registration_success",
"type":"Image",
"language":"en",
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/f3038b7c-2ef7-4d5f-821a-27942c072926.jpeg",
"placeholders":[
"var1",
"var2",
"var3",
"var4"
],
"buttonType":"QUICK_REPLY",
"buttonsList":[
"test",
"test2",
"test3"
]
}
}
|
|---|
Location (Infobip v2)
{
"template":{
"name":"delivery_notification",
"type":"Location",
"language":"en",
"placeholders":[
"38"
],
"latitude":"-34.739603",
"longitude":"-56.088259"
}
}
|
|---|
...
Documento (Infobip v2)
{
"template":{
"name":"e_receipt",
"type":"Document",
"language":"en",
"contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220202/d065eed9-dac7-400c-aa38-d9d0b13e1036.000ESPMarcadores.pdf",
"filename":"Marcadores"
}
}
|
|---|
...