Respuestas

Last update: 3 days ago by Jimena Acevedo - JC

Generar token de administración de grupos

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
}

Crear grupo

La creación es asíncrona: la respuesta solo confirma que la solicitud fue aceptada. El resultado real (grupo creado con su invite_link, o error) llega por webhook.

Nombre	Descripción	Tipo
request_id	Identificador único de la solicitud. Es esencial guardarlo para vincular el webhook posterior (con los detalles reales del grupo) con esta solicitud.	String

{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Eliminar grupo

Nombre	Descripción	Tipo
request_id	Identificador único de la solicitud. El resultado se confirma por webhook.	String

{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Aceptar solicitudes para unirse al grupo

Nombre	Descripción	Tipo
approved_join_requests	Lista de identificadores de las solicitudes que fueron aprobadas.	Lista objetos

{
  "approved_join_requests": [
    "NTIxMjcyMjE1OTgwMToxMjAzNjM0Mjg5OTE4MTE1ODAZD"
  ]
}

Obtener solicitudes para unirse al grupo

Nombre	Descripción	Tipo
data	Lista de solicitudes abiertas. Cada objeto contiene `join_request_id`, `wa_id` y `creation_timestamp`.	Lista objetos
paging	Objeto de paginación con los cursores `before` y `after`.	Objeto

{
  "data": [
    {
      "join_request_id": "MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw",
      "wa_id": "16505551234",
      "creation_timestamp": "1755548877"
    }
  ],
  "paging": {
    "cursors": {
      "before": "{{before_cursor}}",
      "after": "{{after_cursor}}"
    }
  }
}

Rechazar solicitudes para unirse al grupo

Nombre	Descripción	Tipo
rejected_join_requests	Lista de identificadores de las solicitudes rechazadas con éxito.	Lista objetos
failed_join_requests	Solo se incluye si no se pudo rechazar una o más solicitudes. Contiene el `join_request_id` y los errores asociados.	Lista objetos

{
  "rejected_join_requests": [
    "NTIxMjcyMjE1OTgwMToxMjAzNjM0Mjg5OTE4MTE1ODAZD"
  ]
}

Obtener enlace de invitación del grupo

Nombre	Descripción	Tipo
invite_link	Enlace de invitación del grupo. Siempre comienza con `https://chat.whatsapp.com/`.	String

{
  "invite_link": "https://chat.whatsapp.com/{{link_id}}"
}

Restablecer enlace de invitación del grupo

Nombre	Descripción	Tipo
invite_link	Nuevo enlace de invitación. Una vez restablecido, los enlaces anteriores dejan de ser válidos.	String

{
  "invite_link": "https://chat.whatsapp.com/{{link_id}}"
}

Eliminar participantes del grupo

Nombre	Descripción	Tipo
request_id	Identificador único de la solicitud. La eliminación es asíncrona; el resultado se confirma por webhook.	String

{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Obtener información del grupo

Nombre	Descripción	Tipo
id	ID del grupo consultado.	String
subject	Asunto del grupo.	String
description	Descripción del grupo, si se definió al crearlo.	String
join_approval_mode	`approval_required` \| `auto_approve`.	String
suspended	`true` si el grupo fue suspendido por WhatsApp.	Boolean
creation_timestamp	Timestamp UNIX (segundos) de creación del grupo.	Integer
participants	Lista de objetos `{"wa_id": "<WA_ID>"}` con los participantes del grupo.	Lista objetos
total_participant_count	Número total de participantes, excluyendo tu negocio.	Integer

{
  "id": "{{group_id}}",
  "subject": "Artificial Intelligence Insights",
  "creation_timestamp": "683731200",
  "suspended": false,
  "description": "Explore AI developments and discuss the future of AI.",
  "total_participant_count": "6",
  "participants": [
    { "wa_id": "2228675309" },
    { "wa_id": "7693349922" }
  ],
  "join_approval_mode": "auto_approve"
}

Actualizar configuración del grupo

Nombre	Descripción	Tipo
request_id	Identificador único de la solicitud. El resultado se confirma por webhook (`group_settings_update`).	String

{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Actualizar foto de perfil del grupo

Nombre	Descripción	Tipo
request_id	Identificador único de la solicitud. El resultado se confirma por webhook (campo `profile_picture`).	String

{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Obtener grupos activos

Nombre	Descripción	Tipo
data	Objeto con la lista de grupos. Cada grupo incluye `id`, `subject` y `created_at`.	Objeto
paging	Objeto de paginación con los cursores `after` y `before`.	Objeto

{
  "data": {
    "groups": [
      { "id": "{{group_id}}", "subject": "Support Team", "created_at": "683731200" }
    ]
  },
  "paging": {
    "cursors": {
      "after": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "before": "NDMyNzQyODI3OTQw"
    }
  }
}

Enviar mensaje, fijar y desfijar mensaje en un grupo

Las tres operaciones de mensajería (enviar, fijar, desfijar) devuelven la misma estructura de respuesta que el envío de mensajes 1:1: el identificador del mensaje enviado.

Nombre	Descripción	Tipo
id	Identificador del mensaje enviado.	String

[
  {
    "id": "gBGHUhVUByKUHwIJ5zf2vjzVJh-X"
  }
]