Conexión HTTP
Last update: 2 hours ago by Emmanuel Gutierrez Solano
Petición
| URL | https://api.ventachat.com/template/api-template |
| Método | POST |
| Tipo | application/json |
Encabezados
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| Content-Type | application/json | string | obligatorio |
| Authorization | token de autenticación | string | obligatorio |
Objetos
Estructura general
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| contactName | nombre del contacto | string | opcional |
| from | teléfono (con código de país) del que se enviará el mensaje | string | obligatorio |
| to | identificador de WhatsApp devuelto por el servicio contactos | string | obligatorio |
| userId | uuid del usuario | string (uuid) | obligatorio |
| workgroupId | identificador del grupo de trabajo | string (uuid) | obligatorio |
| campaignId | identificador de la campaña | string | obligatorio |
| type | tipo de mensaje | string | obligatorio |
| message | objeto que contiene el contenido del mensaje | object | obligatorio |
Objeto message
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| templateId | identificador del template | integer | obligatorio |
| template | objeto que contiene el detalle del template | object | obligatorio |
Objeto template
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| language | lenguaje del template | string | opcional |
| name | nombre del template | string | opcional |
| components | objeto que contiene la configuración de la plantilla | object | opcional |
Objeto components
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | Tipo de componente. Los valores pueden ser: header: encabezado de la plantilla, body: cuerpo de la plantilla, button: botones para acciones de la plantilla | string | obligatorio |
| subtype | quick_reply: se refiere a un botón de respuesta rápida creado previamente que permite al cliente devolver un mensaje predefinido. URL: se refiere a un botón creado previamente que permite al cliente visitar la URL generada al agregar el parámetro de texto a la URL del prefijo predefinido en la plantilla. catálogo: se refiere a un botón de catálogo creado previamente que permite al cliente devolver un catálogo de productos completo | string | es obligatorio cuando se utiliza con el tipo button |
| index | índice para los parámetros de tipo payload | string | opcional, se utiliza con el tipo button, los valores del index pueden ser: 0,1,2 |
| cards | enviar mensajes de tipo carta | object | obligatorio |
| parameters | arreglo de tipos de plantilla. Los valores pueden ser: text, currency, date_time, image, document, video, location, payload, action | array | obligatorio |
Relación de tipos de parámetros versus tipos de componente
| Tipo de parámetro | header | body | button |
|---|---|---|---|
| text | si | si | no |
| currency | si | si | no |
| date_time | si | si | no |
| image | si | no | no |
| document | si | no | no |
| video | si | no | no |
| location | si | no | no |
| payload | no | no | si |
| action | no | si | si |
Texto
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “text” | string | obligatorio |
| text | texto | string | opcional |
Currency
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “currency” | string | obligatorio |
| fallbackValue | en caso de que no se reconozca el código de moneda, se utilizará el valor de fallbackValue | string | opcional |
| code | código de moneda (ISO 4217) | string | opcional |
| amount | Monto | number | opcional |
Datetime
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “date_time” | string | obligatorio |
| fallbackValue | en caso de que no se reconozca la fecha, se utilizará el valor de fallbackValue | string | obligatorio |
| dayOfMonth | día del mes | number | obligatorio |
| year | año | number | opcional |
| month | mes | number | opcional |
| hour | hora | number | opcional |
| minute | minuto | number | opcional |
Contenido multimedia
Objeto image
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “image” | string | obligatorio |
| link | URL de la imágen | string | obligatorio |
Objeto document
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “document” | string | obligatorio |
| link | URL del documento | string | obligatorio |
| caption | descripción del documento | string | opcional, el tamaño máximo es de 178 caracteres |
| filename | nombre del archivo del documento | string | obligatorio |
Objeto video
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “video” | string | obligatorio |
| link | URL del video | string | obligatorio |
Objeto botones
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| type | el valor es “payload” | string | obligatorio |
| link | descripción del botón para respuesta rápida | string | opcional, se utiliza con el tipo de parámetro payload, se utiliza en el componente button, el tamaño máximo es de 128 caracteres |
Objeto card
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| cardIndex | índice de la carta | number | obligatorio |
| components | componentes de la carta | object | obligatorio |