Participantes e invitaciones

Last update: 4 days ago by Irais Aguirre

Administra los participantes y las invitaciones de un grupo: enlaces de invitación, solicitudes para unirse y eliminación de participantes.

Resumen para integración
URL base: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: de administración, en el encabezado Authorization: Bearer {{admin-token}} (cómo generarlo)
Endpoints en esta página:
GET /v1/group/{{waba_id}}/{{group_id}}/invite_link: Obtener enlace de invitación del grupo
PUT /v1/group/{{waba_id}}/{{group_id}}/invite_link: Restablecer enlace de invitación del grupo
GET /v1/group/{{waba_id}}/{{group_id}}/join_requests: Obtener solicitudes para unirse al grupo
POST /v1/group/{{waba_id}}/{{group_id}}/join_requests: Aceptar solicitudes para unirse al grupo
PUT /v1/group/{{waba_id}}/{{group_id}}/join_requests: Rechazar solicitudes para unirse al grupo
PUT /v1/group/{{waba_id}}/{{group_id}}/participants: Eliminar participantes del grupo

Obtener enlace de invitación del grupo

Devuelve el enlace de invitación vigente del grupo. Siempre comienza con el prefijo https://chat.whatsapp.com/.

Petición

Petición de Obtener enlace de invitación del grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/invite_link
Método	GET

Encabezados

Encabezados de Obtener enlace de invitación del grupo:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Obtener enlace de invitación del grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Ejemplo

Ejemplo completo de Obtener enlace de invitación del grupo:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/invite_link' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de 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

Genera un nuevo enlace de invitación e invalida de inmediato el anterior. Útil cuando el enlace previo se compartió de forma no deseada; los usuarios que ya son parte del grupo no se ven afectados.

Petición

Petición de Restablecer enlace de invitación del grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/invite_link
Método	PUT

Encabezados

Encabezados de Restablecer enlace de invitación del grupo:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Restablecer enlace de invitación del grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Ejemplo

Ejemplo completo de Restablecer enlace de invitación del grupo:

curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/invite_link' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de 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}}"
}

Obtener solicitudes para unirse al grupo

Devuelve la lista de solicitudes de unión abiertas para un grupo con aprobación requerida.

Petición

Petición de Obtener solicitudes para unirse al grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests
Método	GET

Encabezados

Encabezados de Obtener solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Obtener solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Ejemplo

Ejemplo completo de Obtener solicitudes para unirse al grupo:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de 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

{
  "data": [
    {
      "join_request_id": "MTY0NjcwNDM1OTU6MTIwMzYzNDA0Njk0MjMzODIw",
      "wa_id": "16505551234",
      "creation_timestamp": "1755548877"
    }
  ]
}

Aceptar solicitudes para unirse al grupo

Aplica únicamente a grupos creados con join_approval_mode en modo de aprobación requerida. Permite aprobar en lote las solicitudes pendientes de los usuarios que desean unirse mediante el enlace de invitación.

Petición

Petición de Aceptar solicitudes para unirse al grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests
Método	POST
Tipo	application/json

Encabezados

Encabezados de Aceptar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Aceptar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Cuerpo

Campos del cuerpo de Aceptar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
join_requests	Lista de identificadores (`join_request_id`) de las solicitudes a aprobar.	Array de strings	Obligatorio

Ejemplo

Ejemplo completo de Aceptar solicitudes para unirse al grupo:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "join_requests": [
        "{{join_request_id}}"
    ]
}'

Respuesta

Respuesta de Aceptar solicitudes para unirse al grupo:

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

{
  "approved_join_requests": [
    "NTIxMjcyMjE1OTgwMToxMjAzNjM0Mjg5OTE4MTE1ODAZD"
  ]
}

Rechazar solicitudes para unirse al grupo

Rechaza en lote una o más solicitudes de unión pendientes, identificadas por su join_request_id.

Petición

Petición de Rechazar solicitudes para unirse al grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests
Método	PUT
Tipo	application/json

Encabezados

Encabezados de Rechazar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Rechazar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Cuerpo

Campos del cuerpo de Rechazar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo	Requerimientos
join_requests	Lista de identificadores de las solicitudes de unión a rechazar.	Array de strings	Obligatorio

Ejemplo

Ejemplo completo de Rechazar solicitudes para unirse al grupo:

curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/join_requests' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "join_requests": [
        "{{join_request_id}}"
    ]
}'

Respuesta

Respuesta de Rechazar solicitudes para unirse al grupo:

Nombre	Descripción	Tipo
rejected_join_requests	Lista de identificadores de las solicitudes rechazadas con éxito.	Array de strings
failed_join_requests	Solo se incluye si no se pudo rechazar una o más solicitudes. Cada elemento contiene `join_request_id` (String) y `errors` (Lista de objetos con `code` Integer, `title` String, `message` String y `error_data` Objeto).	Lista objetos
errors	Lista de errores generales de la petición. Cada error contiene `code` (Integer), `title` (String), `message` (String) y `error_data` (Objeto).	Lista objetos

{
  "rejected_join_requests": [
    "NTIxMjcyMjE1OTgwMToxMjAzNjM0Mjg5OTE4MTE1ODAZD"
  ],
  "failed_join_requests": [
    {
      "join_request_id": "{{join_request_id}}",
      "errors": [
        {
          "code": 100,
          "title": "Invalid parameter",
          "message": "Join request not found",
          "error_data": {}
        }
      ]
    }
  ],
  "errors": []
}

Eliminar participantes del grupo

Elimina uno o más participantes del grupo (máximo 8 por petición). No existe un endpoint para agregar participantes: la incorporación siempre ocurre por invitación. Un usuario eliminado no puede volver a unirse al mismo grupo. La operación es asíncrona: la petición devuelve un request_id y el resultado se confirma por webhook.

Petición

Petición de Eliminar participantes del grupo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/participants
Método	PUT
Tipo	application/json

Encabezados

Encabezados de Eliminar participantes del grupo:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Eliminar participantes del grupo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
group_id	ID del grupo.	String	Obligatorio

Cuerpo

Campos del cuerpo de Eliminar participantes del grupo:

Nombre	Descripción	Tipo	Requerimientos
participants	Lista de objetos `{ "user": "<phone_number_or_wa_id>" }` a eliminar. Máximo 8. No puede estar vacía. Cada objeto incluye el campo `user` (String, obligatorio) con el número de teléfono o el WhatsApp ID.	Lista de objetos	Obligatorio

Ejemplo

Ejemplo completo de Eliminar participantes del grupo:

curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}/participants' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "participants": [
        { "user": "5212722159801" }
    ]
}'

Respuesta

Respuesta de 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"
}

Administrar grupos

Siguiente — Whatsapp

Bloqueo de usuarios