/Miembros

  • Artículo

Punto final de API para agregar o eliminar miembros de grupos de conversación dentro de Kaizala.

GET /members

GET {endpoint-url}/v1/groups/{groupId}/members

Parámetros de solicitud

Parámetro Tipo ¿Opcional? Descripción
Parámetro url path groupId Cadena No GUID que representa el groupId del recurso de grupo específico
Encabezado HTTP accessToken Cadena No Token de acceso recibido desde el punto de conexión de autenticación

Cuerpo de la respuesta

Parámetro Tipo Descripción
members Matriz JSON Matriz de objetos JSON que representan cada uno un miembro del grupo

Respuesta JSON de ejemplo

{
  "members": [
    {
      "id": "4deffa08-guid-4b87-8c2f-d944565f5f31",
      "role": "Admin",
      "mobileNumber": "+919652000000",
      "isProvisioned": true
    },
    {
      "id": "2e20e9ac-guid-47bd-abac-1f5236004684",
      "role": "Member",
      "mobileNumber": "+919652000001",
      "isProvisioned": false
    }
  ]
}

PUT /members

PUT {endpoint-url}/v1/groups/{groupId}/members

Parámetros de solicitud

Parámetro Tipo ¿Opcional? Descripción
Parámetro url path groupId Cadena No GUID que representa el groupId del recurso de grupo específico
Encabezado HTTP accessToken Cadena No Token de acceso recibido desde el punto de conexión de autenticación
Encabezado HTTP Content-Type Cadena No value: application/json

Cuerpo de solicitud

Parámetro Tipo Descripción
members Matriz de cadena Matriz de números de teléfono con formato correcto de nuevos miembros que se van a agregar

Solicitud JSON de ejemplo

{
  "members": [
      "+91000000000",
      "+91900000000"
  ]
}

Cuerpo de la respuesta

Parámetro Tipo Descripción
result Boolean True cuando todos los números de teléfono se han agregado correctamente al grupo

Respuesta JSON de ejemplo

{
    "result": "true"
}

DELETE /members

DELETE {endpoint-url}/v1/groups/{groupId}/members/{memberId}

Parámetros de solicitud

Parámetro Tipo ¿Opcional? Descripción
Parámetro url path groupId Cadena No GUID que representa el groupId del recurso de grupo específico
Parámetro url path memberId Cadena No GUID que representa el valor de memberId del miembro específico
Encabezado HTTP accessToken Cadena No Token de acceso recibido desde el punto de conexión de autenticación

Cuerpo de la respuesta

Parámetro Tipo Descripción
result Boolean True cuando el miembro especificado se ha quitado correctamente del grupo

Respuesta JSON de ejemplo

{
    "result": "true"
}