Referencia de la API
Una página por área del contrato público, generada desde openapi.json: qué recibe cada ruta, qué devuelve y un curl para empezar.
- 125 operaciones
- URL base
https://api.messages.ccxcompany.co
El texto técnico de abajo viene del contrato público, openapi.json, en el idioma en que se escribió el contrato.
Las áreas del contrato
Cada área abre con una introducción y lista sus operaciones, con parámetros, cuerpo, respuestas y el ejemplo en curl.
Mensajes de WhatsApp
Envía mensajes de WhatsApp (texto, plantilla, multimedia o flow) desde uno de tus números, lista el historial con filtros y consulta el estado de cada envío.
GET/messagesPOST/messagesGET/messages/{id}3 operacionesVer la referenciaSMS
Envía SMS con Idempotency-Key, calcula segmentos y precio antes de enviar, consulta cada mensaje y lee las respuestas (MO) que te mandaron los destinatarios.
GET/v2/sms/messagesPOST/v2/sms/messagesPOST/v2/sms/preview6 operacionesVer la referenciaRCS
Envía mensajes RCS con respaldo por SMS, lista los envíos del entorno de tu clave y consulta por qué canal llegó de verdad cada mensaje al dispositivo.
GET/v2/rcs/messagesPOST/v2/rcs/messagesGET/v2/rcs/messages/{id}3 operacionesVer la referenciaEmail
Envía emails con Idempotency-Key obligatoria, lista los envíos del entorno de tu clave y sigue el estado de cada uno: entregado, rebotado o con queja.
GET/v2/email/messagesPOST/v2/email/messagesGET/v2/email/messages/{id}3 operacionesVer la referenciaNotificaciones push
Registra los dispositivos de tu app, envía push a un segmento o a dispositivos concretos, consulta alcance y coste antes y cuenta entregas y aperturas.
POST/v2/push/tokensPOST/v2/push/tokens/opt-outPOST/v2/push/dispatches/{id}/opened7 operacionesVer la referenciaMultimedia
Sube imágenes, audios, vídeos y documentos a Meta y recibe un mediaId reutilizable en los envíos, o descarga la multimedia que llegó en un mensaje.
POST/numbers/{numberId}/mediaPOST/numbers/{numberId}/media/binaryGET/messages/{id}/media3 operacionesVer la referenciaPlantillas de WhatsApp
Lista las plantillas de WhatsApp de tu organización con el id, el idioma y las variables de cada una, lee una plantilla por id y crea nuevas en borrador.
GET/v2/templatesPOST/v2/templatesGET/v2/templates/{id}3 operacionesVer la referenciaFlows de WhatsApp
Consulta los WhatsApp Flows de tu organización, con el flowJson de cada uno, para enviar formularios y pantallas interactivas por la API de mensajes.
GET/v2/flowsGET/v2/flows/{id}2 operacionesVer la referenciaNúmeros de WhatsApp
Lista los números de WhatsApp de tu organización, consulta estado, calidad y límite de cada uno directamente en Meta y sigue el volumen de envíos.
GET/numbersGET/numbers/{id}GET/numbers/{id}/health5 operacionesVer la referenciaWebhooks
Suscribe endpoints para recibir eventos firmados con HMAC, valida la URL antes de suscribirte, pausa o borra una suscripción y rota el secreto cuando quieras.
GET/webhooksPOST/webhooksPOST/webhooks/validate7 operacionesVer la referenciaContactos
Crea, actualiza, importa en lote y borra contactos, registra quién pidió no recibir mensajes y consulta los campos disponibles en tu base de contactos.
GET/contactsPOST/contactsGET/contacts/{id}8 operacionesVer la referenciaListas estáticas
Mantén listas estáticas de contactos desde tu sistema: crea, renombra y borra listas y añade, sustituye o quita hasta 50.000 miembros por llamada.
GET/v2/listsPOST/v2/listsGET/v2/lists/{id}8 operacionesVer la referenciaSegmentos
Crea segmentos dinámicos por etiqueta, atributo, opt-in, canal o última interacción, consulta el recuento y una muestra antes de guardar y edita los guardados.
GET/v2/segmentsPOST/v2/segmentsGET/v2/segments/{segmentId}6 operacionesVer la referenciaAtributos de contacto
Define los atributos personalizados de los contactos de tu organización, con tipo y etiqueta, y lee el diccionario que valida el campo attributes.
GET/v2/organizations/me/custom-attribute-defsPUT/v2/organizations/me/custom-attribute-defs2 operacionesVer la referenciaEventos del cliente
Registra compras y otras conversiones de tu sistema, atribuidas al último mensaje enviado al contacto dentro de la ventana (7 días por defecto).
GET/v2/eventsPOST/v2/events2 operacionesVer la referenciaRecorridos
Crea recorridos en borrador, pruébalos con un contacto, actívalos, páusalos o archívalos, añade contactos y sigue las ejecuciones y las cifras por paso.
GET/v2/journeysPOST/v2/journeysGET/v2/journeys/{id}15 operacionesVer la referenciaCRM y embudos de venta
Empresas, embudos, etapas y tarjetas: importa en lote, mueve tarjetas entre etapas, márcalas como ganadas o perdidas y registra actividades y archivos.
GET/v2/companiesPOST/v2/companiesPOST/v2/companies/import35 operacionesVer la referenciaImportación de conversaciones
Trae el historial de conversaciones de otra herramienta a la bandeja, hasta 200 por llamada, sin enviar ningún mensaje, sin cobro y sin duplicados.
POST/conversations/import1 operaciónVer la referenciaExportación de mensajes
Exporta los mensajes de WhatsApp, SMS, RCS y email de un periodo de hasta 31 días, con paginación por cursor y los metadatos de correlación de cada envío.
GET/v2/exports/whatsappGET/v2/exports/smsGET/v2/exports/rcs4 operacionesVer la referenciaSaldo de la cartera
Consulta el saldo de la cartera en el entorno de tu clave, de prueba o de producción, y lo reservado en envíos en curso, para avisar antes de quedarte sin él.
GET/wallet1 operaciónVer la referenciaEstado de la plataforma
Un endpoint público y sin autenticación para tu monitor: en una sola consulta indica si la plataforma está activa y si el proveedor de SMS responde.
GET/health/deep1 operaciónVer la referencia
¿Atascado en una ruta? Habla con quienes mantienen la API.
Si creas la cuenta desde la web, recibes 5 US$ de crédito de prueba.