API: cómo gestionar miembros de una sala de chat

Listar, añadir, reemplazar o eliminar miembros mediante la API.

Requisitos previos

• Token de API.
• ID de cuenta.
• ID de sala.
• Usuarios autorizados.

Permisos y disponibilidad

La interfaz utilizada para esta documentación fue observada con un usuario Administrador. La creación y administración de salas puede requerir permisos. El acceso a canales privados, mensajes directos, hilos, archivos y llamadas depende de la membresía, las funciones habilitadas y el estado de disponibilidad de los participantes.

Ruta de acceso

API de Waclis Inbox > Salas de chat > Miembros

Procedimiento

1. Lista miembros con GET.
2. Añade usuarios con POST y un arreglo user_ids.
3. Actualiza la lista completa con PATCH.
4. Elimina usuarios con DELETE.
5. Comprueba la respuesta y vuelve a listar.

Campos y opciones

| Elemento | Descripción | |---|---| | GET | /api/v1/accounts/:account_id/chat_rooms/:chat_room_id/members | | POST | Misma ruta con user_ids para añadir. | | PATCH | Misma ruta; establece la lista completa. | | DELETE | Misma ruta con user_ids para retirar. |

Ejemplos

Añadir miembros

curl -X POST \
  '{{base_url}}/api/v1/accounts/{{account_id}}/chat_rooms/{{room_id}}/members' \
  -H 'api_access_token: {{token}}' \
  -H 'Content-Type: application/json' \
  -d '{"user_ids":[3,4]}'

Resultado esperado

Puedes interpretar o ejecutar la operación con el alcance y las comprobaciones adecuadas.

Consideraciones importantes

• PATCH establece la lista completa: los usuarios omitidos pueden ser retirados.

Artículos relacionados

• Cómo gestionar los miembros de una sala de chat
• Cómo retirar miembros de una sala de forma segura
• Referencia general de la API de salas de chat