/Subgrupos

Ponto de extremidade da API para interagir com os sub-grupos de conversa dentro de Kaizala.

GET /subGroups

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

Parâmetros de solicitação

	Parâmetro	Tipo	Opcional?	Descrição
Cabeçalho HTTP	accessToken	Cadeia de caracteres	Não	Token de Acesso recebido do ponto de extremidade de auth
Parâmetro caminho de URL	groupId	Cadeia de caracteres	Não	GUID representando o groupId do recurso de grupo específico
Parâmetro de consulta de URL	fetchAllGroups	Boolean	Sim	Parâmetro para especificar se você deseja buscar todos os subGrupos em toda a hierarquia

Corpo da resposta

Parâmetro	Tipo	Descrição
grupos	Matriz de Objetos JSON	Matriz de grupos com a lista de subGrupos se houver

Estrutura JSON para cada grupo individual nos grupos de matriz[]:

Parâmetro	Tipo	Descrição
groupId	Cadeia de caracteres	GUID associado ao grupo
Groupname	Cadeia de caracteres	Nome do grupo
groupImageURL	Cadeia de caracteres	Cadeia de caracteres especificando a URL da imagem de perfil de grupo

Resposta JSON de exemplo

{
  "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 solicitação

	Parâmetro	Tipo	Opcional?	Descrição
Cabeçalho HTTP	accessToken	Cadeia de caracteres	Não	Token de Acesso recebido do ponto de extremidade de auth
Parâmetro caminho de URL	groupId	Cadeia de caracteres	Não	GUID representando o groupId do recurso de grupo específico

Corpo da solicitação

	Parâmetro	Tipo	Opcional?	Descrição
Groupname	Cadeia de caracteres	Não	Nome do subconjunto
groupImageURL	Cadeia de caracteres	Sim	URL de mídia da imagem do grupo; A imagem precisa ser carregada pelo caminho /media
members	Matriz	Sim	Matriz de cadeia de caracteres de números de telefone bem formatados
Welcomemessage	Matriz	Não	Matriz de cadeia de caracteres de números de telefone bem formatados
addUserToGroup	Boolean	Sim	Defina como False se o usuário de chamada não deve ser adicionado ao grupo por padrão

Solicitação JSON de exemplo

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

Corpo da resposta

Parâmetro	Tipo	Descrição
groupId	Cadeia de caracteres	Identificador de Grupo
Groupname	Cadeia de caracteres	Nome do grupo criado

Resposta JSON de exemplo

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