Interactive Buttons
Properties
Property | Description | Required |
header | Contains the properties of the top part of the element. | Yes |
text | Contains the text included in the header. | Yes* |
imageUrl | Contains the URL of the image in the header. | Yes* |
videoUrl | Contains the URL of the video in the header. | Yes* |
documentUrl | Contains the URL of the document location. | Yes* |
filename | File name to send document type. | No |
body | Contains the text that will appear below the header. | Yes |
buttonsList | Contains an array with the buttons. (1-3) | Yes |
button | Button information.
| Yes Yes Yes |
footer | Contains the text that was in the footer of the element. | No |
*Only one of these properties is required, depending on what the interactive button header type will be. Ex: imageUrl > Image Type, text > Text Type, etc.
Text
Code Block | ||
---|---|---|
| ||
{ "interactiveButtons": { "header": { "text": "text" }, "body": "body text", "buttonsList": [ { "id": "1", "title": "Si" }, { "id": "2", "title": "No" } ], "footer": "footer" } } |
Document
Code Block | ||
---|---|---|
| ||
{ "interactiveButtons": { "header": { "documentUrl": "https://integraccs.ucontactcloud.com/attachments/20220201/000ESPMarcadores.pdf", "filename": "Marcadores" }, "body": "body text", "buttonsList": [ { "id": "1", "title": "Si" }, { "id": "2", "title": "No" } ], "footer": "footer" } } |
Image
Code Block |
---|
{ "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
Code Block | ||
---|---|---|
| ||
{ "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
Properties
Property | Description | Required |
header | Text located in the header of the element. | No |
body | Text located below the header. | Yes |
buttonMenu | Text on the button to open the menu. | Yes |
sections | Array with sections (1-2). | Yes |
title | Title for each section. | No* |
rows | Array with the different options. | Yes |
row | Information about each option:
| Yes
|
footer | Text located in the footer of the element. | No |
*Required if you have more than one section.
The range of options for each section is 1-10. Max between the sections is 10.
Code Block | ||
---|---|---|
| ||
{ "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
Properties
Property | Description | Required |
firstName | First name | Yes |
lastName | Last name. | No |
middleName | Middle name. | No |
formattedName | Name and last name without blank spaces. | Yes |
namePrefix | Name prefix. | No |
birthday | Birthday | No |
phones | Array with different phone numbers. | No |
phone | Number and phone type
| No |
emails | Array with different email addresses. | No |
Email address and type.
| No | |
addresses | Array with different addresses. | No |
address | Information of each address.
| No |
org | Information about the organization.
| No |
urls | Array with different URLs. | No |
url |
| No |
Code Block | ||
---|---|---|
| ||
{ "contact": { "firstName": "Test", "lastName": "Integra", "formattedName": "TestIntegra", "namePrefix": "Mr", "middleName": "Algo", "birthday": "2022-01-21", "phones": [ { "type": "WORK", "phone": "308740239" } ], "emails": [ { "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": "https://www.net2phone.com", "type": "WORK" } ] } } |
Location
Properties
Property | Description | Required |
address | Place on the map: street and city. | No |
name | Name of the location. | No |
latitude | Specific north-south coordinate. | Yes |
longitude | Specific east-west coordinate. | Yes |
Code Block | ||
---|---|---|
| ||
{ "location": { "address": "Bv. Gral. Artigas 1825 Departamento de Montevideo", "name": "Tres Cruces Shopping", "latitude": "-34.8938251", "longitude": "-56.1685413" } } |
Template/HSM
Properties
Property | Description | Required |
name | Name or id of the approved template. | Yes |
type | Template type. | Yes |
language | Template language. | Yes |
contentHeader | Text included in the header. | Yes(1) |
latitude | Specific north-south coordinate. | Yes(2) |
longitude | Specific east-west coordinate. | Yes(2) |
filename | Document name. | No(3) |
placeholders | Array with variables in template text. | Yes(4) |
buttonType | Button type (URL or QUICK_REPLY). | Yes(4) |
buttonsList | Array with variables for the text on the button. | Yes(4) |
1: Depending on the type, Ex: in the case of an image, the URL of the image must go.
2: Required if type is location.
3: If you leave it empty, the name will be “null”.
4: Required if the template contains variables or buttons, it must be the exact number of elements in the array.
Text (Gupshup)
Code Block |
---|
{ "template":{ "name":"0e05d104-4efd-4363-8c90-69eaca8b0c0d", "type":"text", "placeholders":[ "phone", "86565887", "updates" ] } } |
Body (Infobip v2)
Code Block | ||
---|---|---|
| ||
{ "template":{ "name":"infobip_test_hsm_2", "type":"Body", "language":"en_US", "placeholders":[ "John", "john@gmail.com" ] } } |
Video (Infobip v2)
Code Block | ||
---|---|---|
| ||
{ "template":{ "name":"instruction_video", "type":"video", "language":"en", "contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220201/1ae7ef92-0775-4b88-91f8-db2ba1a20000.mp4" } } |
Video (Gupshup)
Code Block | ||
---|---|---|
| ||
{ "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)
Code Block | ||
---|---|---|
| ||
{ "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)
Code Block | ||
---|---|---|
| ||
{ "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)
Code Block | ||
---|---|---|
| ||
{ "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)
Code Block | ||
---|---|---|
| ||
{ "template":{ "name":"delivery_notification", "type":"Location", "language":"en", "placeholders":[ "38" ], "latitude":"-34.739603", "longitude":"-56.088259" } } |
Documento (Infobip v2)
Code Block | ||
---|---|---|
| ||
{ "template":{ "name":"e_receipt", "type":"Document", "language":"en", "contentHeader": "https://integraccs.ucontactcloud.com/attachments/20220202/d065eed9-dac7-400c-aa38-d9d0b13e1036.000ESPMarcadores.pdf", "filename":"Marcadores" } } |