/Subgrupos

Punto final de API para interactuar con los subgrupos de conversación dentro de Kaizala.

GET /subGroups

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

Parámetros de solicitud

	Parámetro	Tipo	¿Opcional?	Descripción
Encabezado HTTP	accessToken	Cadena	No	Token de acceso recibido desde el punto de conexión de autenticación
Parámetro url path	groupId	Cadena	No	GUID que representa el groupId del recurso de grupo específico
Parámetro de consulta url	fetchAllGroups	Boolean	Sí	Parámetro para especificar si desea capturar todos los subgrupos de la jerarquía.

Cuerpo de la respuesta

Parámetro	Tipo	Descripción
groups	Matriz de objetos JSON	Matriz de grupos con la lista de subgrupos, si existe

Estructura JSON para cada grupo individual de los grupos de matrices[]:

Parámetro	Tipo	Descripción
groupId	Cadena	GUID asociado al grupo
Groupname	Cadena	Nombre del grupo
groupImageURL	Cadena	Cadena que especifica la dirección URL de la imagen de perfil de grupo

Respuesta JSON de ejemplo

{
  "groups": [
    {
      "groupName": "Sample group name",
      "groupId": "853654b2-guid-462d-b709-0c4e43a7083f",
      "groupImageUrl": "{sample group image URL here}",
      "subGroups": [
          {
            "groupName": "Sample sub group name",
            "groupId": "853654b2-guid-462d-b709-0c4e43a7083f",
            "groupImageUrl": "{sample sub group image URL here}",
          }
      ]
    }
  ]
}

POST /subGroups

POST {endpoint-url}/v1/groups/{groupId}/subGroups

Parámetros de solicitud

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

Cuerpo de solicitud

	Parámetro	Tipo	¿Opcional?	Descripción
Groupname	Cadena	No	Nombre del subgrupo
groupImageURL	Cadena	Sí	Dirección URL multimedia de la imagen de grupo; La imagen debe cargarse a través de la ruta de acceso /media
members	Matriz	Sí	Matriz de cadenas de números de teléfono con formato correcto
welcomeMessage	Matriz	No	Matriz de cadenas de números de teléfono con formato correcto
addUserToGroup	Boolean	Sí	Establezca en False si el usuario que realiza la llamada no debe agregarse al grupo de forma predeterminada.

Solicitud JSON de ejemplo

{
  "groupName": "Test Group",
  "groupImageUrl": "",
  "members": [ "+919652000000", "+919910000005"],
  "welcomeMessage": "Hello",
  "addUserToGroup": false
}

Cuerpo de la respuesta

Parámetro	Tipo	Descripción
groupId	Cadena	Identificador de grupo
Groupname	Cadena	Nombre del grupo creado

Respuesta JSON de ejemplo

{
    "groupId": "853654b2-5874-462d-b709-0c4e43a7083f",
    "groupName": "Test Group"
}