Administrar grupos

Crear grupo

Solo los números de teléfono elegibles pueden crear grupos (ver requisitos en Grupos).

Petición

Petición de Crear grupo:

Encabezados

Encabezados de Crear grupo:

Parámetros

Parámetros de Crear grupo:

Cuerpo

Campos del cuerpo de Crear grupo:

Ejemplo

Ejemplo completo de Crear grupo:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{business_phone_number}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "subject": "Support Team",
    "description": "Group for customer support coordination",
    "join_approval_mode": "approval_required"
}'

Respuesta

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

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Obtener grupos activos

Devuelve la lista de grupos activos asociados a un número de teléfono, con paginación mediante cursores after/before.

Petición

Petición de Obtener grupos activos:

Encabezados

Encabezados de Obtener grupos activos:

Parámetros

Parámetros de Obtener grupos activos:

Ejemplo

Ejemplo completo de Obtener grupos activos:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{business_phone_number}}/groups?limit=25' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Obtener grupos activos:

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

Obtener información del grupo

Devuelve la información del grupo según los campos solicitados en el parámetro fields. Si no se especifica ningún campo, por defecto se devuelven: id, subject, description y join_approval_mode.

Petición

Petición de Obtener información del grupo:

Encabezados

Encabezados de Obtener información del grupo:

Parámetros

Parámetros de Obtener información del grupo:

Ejemplo

Ejemplo completo de Obtener información del grupo:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}?fields=subject,description,participants,join_approval_mode' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Obtener información del grupo:

💾
{
  "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

Actualiza el asunto y/o la descripción del grupo. La operación es asíncrona: la petición devuelve un request_id y el resultado (éxito, éxito parcial o error por cada campo) se confirma por webhook.

Petición

Petición de Actualizar configuración del grupo:

Encabezados

Encabezados de Actualizar configuración del grupo:

Parámetros

Parámetros de Actualizar configuración del grupo:

Cuerpo

Campos del cuerpo de Actualizar configuración del grupo:

Ejemplo

Ejemplo completo de Actualizar configuración del grupo:

💾
curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "subject": "Watch Enthusiasts",
    "description": "Join our community to discuss the latest timepieces."
}'

Respuesta

Respuesta de Actualizar configuración del grupo:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Actualizar foto de perfil del grupo

Actualiza la foto de perfil del grupo. La imagen debe ser image/jpeg, cuadrada (alto = ancho), con un tamaño mínimo de 192x192 px y máximo de 5MB. La operación es asíncrona: la petición devuelve un request_id y el resultado se confirma por webhook (campo profile_picture).

Petición

Petición de Actualizar foto de perfil del grupo:

Encabezados

Encabezados de Actualizar foto de perfil del grupo:

Parámetros

Parámetros de Actualizar foto de perfil del grupo:

Cuerpo

Campos del cuerpo de Actualizar foto de perfil del grupo:

Ejemplo

Ejemplo completo de Actualizar foto de perfil del grupo:

💾
curl --location --request PUT 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/group/{{waba_id}}/{{group_id}}' \
--header 'Authorization: Bearer {{admin-token}}' \
--form 'file=@"/ruta/local/imagen.jpg"'

Respuesta

Respuesta de Actualizar foto de perfil del grupo:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}

Eliminar grupo

Petición

Petición de Eliminar grupo:

Encabezados

Encabezados de Eliminar grupo:

Parámetros

Parámetros de Eliminar grupo:

Ejemplo

Ejemplo completo de Eliminar grupo:

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

Respuesta

Respuesta de Eliminar grupo:

💾
{
  "request_id": "384EE736D97215A005AF71B3482C5DB5"
}