Listar plantillas

Obtén una lista de plantillas de mensajes de WhatsApp Cloud API para el dispositivo específico.

API de WhatsApp y CRM

Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.

GET https://api.getincloud.ai/v1/waba/templates

Obtén una lista de plantillas de mensajes de WhatsApp Cloud API para el dispositivo específico.

Las plantillas de mensajes se utilizan para enviar mensajes proactivos a los usuarios fuera de la ventana de mensajería de 24 horas.

Las plantillas deben ser aprobadas por WhatsApp antes de poder usarse.

Este endpoint devuelve las plantillas sincronizadas desde la cuenta de WhatsApp Business asociada al dispositivo.

Filtrado:

Puedes filtrar las plantillas por:

status: Filtra por el estado de la plantilla (pending, approved, rejected, etc.)

category: Filtra por la categoría de la plantilla (MARKETING, UTILITY, AUTHENTICATION)

language: Filtra por el código de idioma de la plantilla

name: Busca plantillas por nombre (coincidencia parcial, sin distinguir mayúsculas de minúsculas)

Nota: Este endpoint solo está disponible para dispositivos conectados mediante WhatsApp Cloud API.

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y prueba el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Parámetros

Campo	Dónde	Tipo	Obligatorio	Descripción
`status`	query	string	No	Filtra las plantillas por estado `enum: ['any', 'REMOVED', 'INVALID', 'DRAFT', 'PENDING', 'REVIEW', 'APPROVED', 'REJECTED', 'PAUSED', 'DISABLED', 'IN_APPEAL', 'DELETED', 'PENDING_DELETION']` · `default: any`
`category`	query	string	No	Filtra las plantillas por categoría `enum: ['any', 'MARKETING', 'UTILITY', 'SERVICE', 'AUTHENTICATION', 'AUTHENTICATION_INTERNATIONAL']` · `default: any`
`language`	query	string	No	Filtra las plantillas por código de idioma `enum: ['any', 'af', 'sq', 'ar', 'az', 'bn', 'bg', 'ca', 'zh_CN', 'zh_HK', 'zh_TW', 'hr', 'cs', 'da', 'nl', 'en', 'en_GB', 'en_US', 'et', 'fil', 'fi', 'fr', 'ka', 'de', 'de_CH', 'el', 'gu', 'ha', 'he', 'hi', 'hu', 'id', 'ga', 'it', 'ja', 'kn', 'kk', 'rw_RW', 'ko', 'ky_KG', 'lo', 'lv', 'lt', 'mk', 'ms', 'ml', 'mr', 'nb', 'fa', 'pl', 'pt_BR', 'pt_PT', 'pa', 'ro', 'ru', 'sr', 'sk', 'sl', 'es', 'es_CL', 'es_AR', 'es_ES', 'es_MX', 'sw', 'sv', 'ta', 'te', 'th', 'tr', 'uk', 'ur', 'uz', 'vi', 'zu']` · `default: any`
`name`	query	string	No	Busca plantillas por nombre (coincidencia parcial, sin distinguir mayúsculas de minúsculas) `maxLength: 512`
`waba`	query	string	No	Filtra las plantillas por el ID de la cuenta de WhatsApp Business (WABA) `maxLength: 64`
`size`	query	number	No	Número máximo de entradas a devolver `minimum: 1` · `maximum: 500` · `default: 200` · `format: integer`
`page`	query	number	No	Número de página de resultados (comienza en 0) `minimum: 0` · `maximum: 100` · `default: 0` · `format: integer`

Respuestas

Código	Descripción
`200`	Lista de plantillas de mensajes
`400`	El dispositivo no tiene una conexión de WhatsApp Cloud API
`401`	Acceso no autorizado debido a un token de API no válido o caducado
`403`	Faltan los permisos requeridos
`404`	Dispositivo no encontrado
`409`	Conflicto
`429`	Demasiadas solicitudes: inténtalo de nuevo más tarde
`500`	Error inesperado
`501`	No implementado
`503`	Servicio no disponible temporalmente: inténtalo de nuevo más tarde

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Retrieve all templates
curl --request GET \
  --url https://api.getincloud.ai/v1/waba/templates \
  --header 'Token: <api token goes here>'


// Retrieve approved templates only
curl --request GET \
  --url https://api.getincloud.ai/v1/waba/templates \
  --header 'Token: <api token goes here>'


// Search templates by name
curl --request GET \
  --url https://api.getincloud.ai/v1/waba/templates \
  --header 'Token: <api token goes here>'

AnteriorListar WhatsApp Flows SiguienteObtener precios de mensajería

¿Te sirvió esta página?