Versions Compared

Version Old Version 2 New Version 3
Changes made by

Carina Soca

Rodrigo Monteiro (Voice Engineering)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Interactive Buttons

Propiedades

Propiedad

Descripción

Requerido

header

Contiene las propiedades de la

Contém as propriedades da parte superior

del

do elemento..

Si

Sim

text

Contiene el texto incluido en la cabecera

Contém o texto incluído no cabeçalho.

SiSi

Sim*

imageUrl

Contiene la URL de la imagen en la cabecera.

Si

Contém a URL da imagem no cabeçalho.

Sim*

videoUrl

Contiene la URL del video en la cabecera.

Contém o URL do vídeo no cabeçalho..

Sim*

documentUrl

Contiene la URL de la ubicación del

Contém o URL da localização do documento.

Si

Sim*

filename

Nombre del archivo

Nome do arquivo para enviar o tipo de documento.

No

Não

body

Contiene el

Contém o texto que aparecerá

debajo de la cabecera

abaixo do cabeçalho.

Si

Sim

buttonsList

Contiene un array con los botones.

Contém uma matriz com os botões (1-3)

Si

Sim

button

Información del botón

Informações do botão.

  • id

  • title

Si

Sim

Si

Sim

Si

Sim

footer

Contiene el

Contém o texto que

era en el pie del

estava no rodapé do elemento.

No

Não

*Solo una de estas propiedades es requerida, dependiendo de cuál será el tipo de la cabecera de los botones interactivos. EjApenas 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"

  }

}

...

Imagen

{

  "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"

  }

}

...

Video

{

  "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

ubicado en la cabecera del

localizado no cabeçalho do elemento.

No

Não

body

Texto

ubicado por debajo de la cabecera

localizado abaixo do cabeçalho.

Si

Sim

buttonMenu

Texto

en el botón

no botão para abrir

el menú

o menu.

Si

Sim

sections

Arreglo con las secciones

Acordo com as seções (1-2).

Si

Sim

title

Título para cada

sección

seção.

No

Não*

rows

Arreglo con las diferentes opciones

Acordo com as diferentes opções.

Si

Sim

row

Información

Informações de cada

opción

opção:

  • id

  • title

  • description

Si

Sim

Si

  • Sim

Si

  • Sim

No

  • Não

footer

Texto

ubicado en el pie del

localizado no rodapé do elemento.

No

Não

*Requerido en Necessário no caso de tener más de una secciónmais de uma seção.

El rango de opciones de cada sección es de O intervalo de opções para cada seção é 1-10

{

  "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

Propiedades

Propiedad

Descripción

Requerido

firstName

Primer nombre

Primeiro nome.

Si

Sim

lastName

Apellido

Sobrenome.

No

Não

middleName

Nombre del medio

Nome do meio.

No

Não

formattedName

Nombre y apellido sin espacio

Nome e Sobrenome sem espaço.

Si

Sim

namePrefix

Prefijo usado en el nombre

Prefixo usado no nome.

No

Não

birthday

Fecha

Data de

nacimiento

nascimento.

No

Não

phones

Arreglo con los distintos teléfonos

Arranjo com diferentes telefones.

No

Não

phone

Número

y

e tipo

del teléfono

de telefone.

  • type

  • phone

No

Não

emails

Arreglo con los distintos emails

Organização com diferentes e-mails.

No

Não

email

Dirección de correo y el

Endereço postal e tipo.

  • email

  • type

No

Não

addresses

Arreglo con los distintas direcciones

Acordo com os diferentes endereços.

No

Não

address

Información de cada dirección.

  • type

  • street

  • city

  • country

  • zip

  • state

No

Não

org

Información de la organización donde trabaja

Informações da empresa/organização onde trabalha.

  • company

  • department

  • title

No

Não

urls

Arreglo con los

Arranjo com diferentes URLs.

No

Não

url

  • url 

  • type

No

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

Propiedades

Propiedad

Descripción

Requerido

address

Dirección del lugar en el mapa: calle y ciudad.

No

name

Nombre del lugar.

No

Endereço do local no mapa: rua e cidade.

Não

name

nome do local.

Não

latitude

Coordenada específica norte-

sur

sul.

Si

Sim

longitude

Coordenada . específica

este

leste-oeste.

Si

Sim

{

  "location": {

    "address": "Bv. Gral. Artigas 1825 Departamento de Montevideo",

    "name": "Tres Cruces Shopping",

    "latitude": "-34.8938251",

    "longitude": "-56.1685413"

  }

}

...

Template/HSM

Propiedades

Propiedad

Descripción

Requerido

name

Nombre o id del template aprobado por

Nome ou ID do modelo aprovado para WhatsApp.

Si

Sim

type

Tipo

del

de template.

Si

Sim

language

Lenguaje del

Linguagem do template.

Si

Sim

contentHeader

Texto

incluido en la cabecera

incluído no cabeçalho.

Si

Sim(1)

latitude

Coordenada específica norte-

sur

sul.

Si

Sim(2)

longitude

Coordenada específica

este

leste-oeste.

Si

Sim(2)

filename

Nombre del

Nome do documento.

No

Não(3)

placeholders

Arreglo con las variables en el texto del

Arranjo com as variáveis no texto de template.

Si

Sim(4)

buttonType

Tipo de

botón

Botão (URL o QUICK_REPLY).

SiSi

Sim(4)

buttonsList

Arreglo con variables para el texto en el botón.

Arranjo variável do texto no botão.

Sim(4)

1: Dependiendo el tipo, Ej: en caso de imagen debe ir la URL de la imagenDependendo o tipo, por exemplo, no caso de uma imagem, o URL da imagem deve ser incluído.

2: Requerido si el tipo es Obrigatório se o tipo for location.

3: En caso de dejarlo vacío el nombre Se não for preenchido, o nome será “null”.

4: Requerido si el template contiene variables o botones, debe ser el número exacto de elementos en el arrayse 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"

        ]

    }

}

...

Video (Infobip v2)

{

    "template":{

        "name":"instruction_video",

        "type":"video",

        "language":"en",

        "contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/1ae7ef92-0775-4b88-91f8-db2ba1a20000.mp4"

    }

}

...

Video (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"

    }

}

...

Image (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"

    }

}

...

Imagen (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"

  }

}

...

Imagen/Button (Infobip v2)

{

    "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"

    }

}