/Grupos

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

POST /groups

Post {endpoint-url}/v1/groups

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
Cabeçalho HTTP	Content-Type	Cadeia de Caracteres	Não	"application/json"

Corpo da solicitação

Parâmetro	Tipo	Opcional?	Descrição
name	Cadeia de caracteres	Não	Nome do grupo
Welcomemessage	Cadeia de caracteres	Não	Mensagem de boas-vindas que será exibida para o novo membro do grupo
members	String[]	Sim	Número móvel (com código de país) de membros a serem adicionados. Padrão: o usuário do token de acesso será adicionado como administrador do grupo
groupType	Cadeia de caracteres	Sim	Enum: Group/ConnectGroup. O ConnectGroup criará um grupo público gerenciado. Padrão: Grupo

Solicitação JSON de exemplo para criar grupo

{
    name:"Kaizala Test group",
    welcomeMessage:"Welcome to group created programmatically",
    members:["+911099999999"],
    groupType: "Group"
}

Corpo da resposta

Parâmetro	Tipo	Descrição
Groupname	Cadeia de caracteres	Nome do grupo
groupId	Cadeia de caracteres	Identificador de grupo que pode ser usado em chamadas de api subsequentes
membersAdded	bool	True se todos os membros forem adicionados com êxito

Resposta JSON de exemplo

{
   "groupName": "Kaizala Test group",
   "groupId": "853654b2-5874-462d-b709-0c4e43a7083f",
   "membersAdded": true
}

GET /groups

GET {endpoint-url}/v1/groups

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 de consulta	Showdetail	bool	Sim	Padrão: false. True para retornar todos os detalhes do grupo
Parâmetro de consulta	fetchAllGroups	bool	Sim	Padrão: false. True para retornar todos os grupos pai e sub

Corpo da resposta

Parâmetro	Tipo	Descrição
grupos	Matriz de Objetos JSON	Matriz de grupos aos quais o usuário tem acesso com o accessToken

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

Parâmetro	Tipo	Descrição
groupId	Cadeia de caracteres	Identificador de Grupo
Groupname	Cadeia de caracteres	Nome do grupo
groupImageURL	Cadeia de caracteres	Cadeia de caracteres especificando a URL da imagem de perfil de grupo
hasSubGroups	bool	True se o grupo tiver subgrupos
hasParentGroups	bool	True se o grupo tiver grupos pai
isMappedToTenant	bool	True se o grupo for grupo organization
groupType	Cadeia de caracteres	Grupo/ConnectGroup. ConnectGroup se o grupo no grupo Público Gerenciado
userCount	Numérico	Número total de usuários sob esse grupo em toda a hierarquia
currentLevelUserCount	Numérico	Número total de membros individuais do grupo no nível atual

Resposta JSON de exemplo

{
  "groups": [
    {
      "groupName": "Sample group name",
      "groupId": "853654b2-5874-462d-b709-0c4e43a7083f",
      "groupImageUrl": "{sample group image URL here}",
      "hasSubGroups": false,
      "hasParentGroups": false,
      "callerRole": "Admin",
      "currentLevelSubGroupCount": 0,
      "currentLevelParentGroupCount": 0,
      "userCount": 2,
      "uniqueUserCount": 0,
      "currentLevelUserCount": 2,
      "currentLevelUnProvisionedUserCount": 0,
      "unProvisionedUserCount": 0,
      "isMappedToTenant": false,
      "groupType": "Group",
      "isDuplicate": false,
      "isEditable": true,
      "isDetailsReadable": true
    }
  ]
}

GET /groups/{groupId}

Você pode obter detalhes sobre um membro de recurso específico (um grupo aqui) especificando o identificador como um parâmetro de caminho de URL

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

Parâmetros de solicitação

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

Corpo da resposta

Parâmetro	Tipo	Descrição
grupos	Matriz de Objetos JSON	Matriz de grupos aos quais o usuário tem acesso com o accessToken

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

Parâmetro	Tipo	Descrição
groupId	Cadeia de caracteres	Identificador de Grupo
Groupname	Cadeia de caracteres	Nome do grupo
groupImageURL	Cadeia de caracteres	Cadeia de caracteres especificando a URL da imagem de perfil de grupo
hasSubGroups	bool	True se o grupo tiver subgrupos
hasParentGroups	bool	True se o grupo tiver grupos pai
isMappedToTenant	bool	True se o grupo for grupo organization
groupType	Cadeia de caracteres	Grupo/ConnectGroup. ConnectGroup se o grupo no grupo Público Gerenciado
userCount	Numérico	Número total de usuários sob esse grupo em toda a hierarquia
currentLevelUserCount	Numérico	Número total de membros individuais do grupo no nível atual

Resposta JSON de exemplo

{
  "groups": [
    {
      "groupName": "Sample group name",
      "groupId": "853654b2-5874-462d-b709-0c4e43a7083f",
      "groupImageUrl": "{sample group image URL here}",
      "hasSubGroups": true,
      "userCount": 200,
      "currentLevelUserCount": 10
    }
  ]
}