Referencia de la APIGrupos de mensajes
Consultar
Consulta un grupo de mensajes de cobranza con sus clientes y mensajes.
Descripción general
Este endpoint devuelve un grupo de mensajes de cobranza: a qué clientes aplica, si está activo y todos sus mensajes, con su disparador, canal y contenido.
Requiere el permiso Leer en Grupos de mensajes.
Endpoint
GET
https://app.credonix.mx/api/v1/message-groups/{groupId}Path param: groupId — el id del grupo de mensajes.
Consulta un grupo de mensajes
Devuelve el grupo con sus mensajes, ordenados del primero al último que se creó.
Grupo inexistente
Si el id no existe, pertenece a otra organización o el grupo fue eliminado, la API responde 404 con el código NOT_FOUND.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador del grupo. |
name | string | Nombre del grupo. |
active | boolean | Si el grupo está activo. |
include_all_customers | boolean | Si el grupo aplica a todos los clientes. |
customer_ids | string[] | Clientes incluidos en el grupo. |
excluded_customer_ids | string[] | Clientes excluidos del grupo. |
channels | string[] | Canales de los mensajes del grupo, sin repetir, en el orden de los mensajes. |
messages | array | Mensajes del grupo. Ver abajo. |
created_by | objeto | null | Quién creó el grupo: type (api_key o user) y name. |
created_at | string | Fecha de creación (ISO 8601). |
updated_at | string | Fecha de la última actualización (ISO 8601). |
messages
| Campo | Tipo | Descripción |
|---|---|---|
id | string | Identificador del mensaje. |
timing | string | Disparador: before_due_date, before_issue_date, after_issued, after_overdue, after_paid, after_canceled, after_payment_received, after_emitted_sat o recurring. |
channel | string | whatsapp, sms o email. |
type | string | plain o whatsapp_template. |
days_before | integer | null | Días antes (1, 3, 7, 15 o 30) para before_due_date y before_issue_date. |
recurring_every_days | integer | null | Cada cuántos días se repite (15, 30 o 60) para recurring. |
email_subject | string | null | Asunto del correo. null en SMS y WhatsApp. |
message | string | null | Contenido del mensaje, en HTML. null en WhatsApp. |
Errores
| Status | Código | Causa |
|---|---|---|
401 | MISSING_API_KEY, INVALID_API_KEY, API_KEY_REVOKED | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Leer en Grupos de mensajes. |
404 | NOT_FOUND | El grupo no existe en esta organización. |