get
https://{subdominio}.kommo.com/api/v4/chats/templates/
El método permite obtener datos sobre una plantilla.
Limitaciones
- El método está disponible con derechos de administrador.
- El método solo retorna las plantillas que fueron creadas por la integración actual.
Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.
Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.
Parámetros de respuesta
| Parámetro | Tipo de dato | Descripción |
|---|---|---|
id | int | ID de la plantilla. |
account_id | int | ID de la cuenta a la que pertenece la plantilla. |
name | string | Nombre de la plantilla. |
content | string | Cuerpo de la plantilla (el mensaje que se envía al usuario). |
is_editable | bool | Define si los usuarios pueden editar la plantilla a través de la interfaz de Kommo. |
type | string | Tipo de plantilla. |
buttons | array | Arreglo de objetos botones. |
buttons[] | obj | Un objeto botón. |
buttons[][type] | string | Tipo de botón. Las opciones disponibles son inline (botón de texto simple) y url (botón de enlace). |
buttons[][text] | string | Texto en el botón. |
buttons[][url] | string | URL del botón de tipo url. |
attachment | object|null | Objeto del archivo añadido a la plantilla. |
attachment[id] | string | UUID del archivo adjuntado a la plantilla. |
attachment[name] | string | Nombre del archivo (se pasará al mensajero). |
attachment[type] | string | Tipo de archivo (imagen, archivo, documento, video). |
attachment[is_external] | bool | Indicador de que el archivo proviene de un servicio de archivos. Para todas las plantillas añadidas desde la primavera de 2022, retorna true. |
created_at | int | Indicador de que el archivo proviene de un servicio de archivos. Para todas las plantillas añadidas desde la primavera de 2022, retorna true. |
updated_at | int | Indica cuándo fue actualizada por última vez la plantilla en formato Unix Timestamp. |
external_id | string | ID externo de la plantilla. ID de la plantilla en tu sistema. |
review_status | string|null | Estado de la plantilla de WhatsApp:approved/review/paused/rejected. El parámetro GET with es obligatorio. |
is_on_review | null|bool | Indica si la plantilla está siendo revisada. El parámetro GET with es obligatorio. |
waba_footer | string | Pie de página de la plantilla de WhatsApp. |
waba_category | string | Categoría de la plantilla de WhatsApp. Las siguientes categorías están disponibles: UTILITY/AUTHENTICATION/MARKETING. |
waba_language | string | Idioma de la plantilla de WhatsApp. |
waba_examples | obj | Ejemplos de cómo reemplazar los elementos de formato de la plantilla de WhatsApp. Ejemplo: "waba_examples":{"{{lead.name}}":"qwerty"}. |
waba_header | string | Encabezado de la plantilla de WhatsApp con un límite de hasta 60 caracteres. |
waba_header_type | string | Tipo de encabezado de la plantilla de WhatsApp. Opciones disponibles: text (plantilla de WhatsApp con un encabezado de texto), media (plantilla de WhatsApp con un encabezado de medios, debe haber un archivo adjunto). |
_embedded | obj | Un objeto que contiene la información relacionada con la solicitud. |
_embedded.reviews | array | Un objeto que contiene la información relacionada con la solicitud. |
_embedded.reviews[][id] | int | ID del estado de la plantilla de WhatsApp. El parámetro GET with es obligatorio. |
_embedded.reviews[][source_id] | int | ID de la fuente del estado de la plantilla de WhatsApp. El parámetro GET with es obligatorio. |
_embedded.reviews[][reject_reason] | string | La razón por la cual la plantilla de WhatsApp fue rechazada. El parámetro GET with es obligatorio. |
_embedded.reviews[][status] | string | Estado de la plantilla de WhatsApp. El parámetro GET with es obligatorio. |