/Membros

  • Artigo

Ponto de extremidade da API para adicionar ou excluir membros de grupos de conversa dentro de Kaizala.

GET /members

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

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
membros Matriz JSON Matriz de objetos JSON cada um representando um membro do grupo

Resposta JSON de exemplo

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

Corpo da solicitação

Parâmetro Tipo Descrição
membros Matriz de Cadeia de Caracteres Matriz de números de telefone bem formatados de novos membros a serem adicionados

Solicitação JSON de exemplo

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

Corpo da resposta

Parâmetro Tipo Descrição
resultado Boolean True quando todos os números de telefone tiverem sido adicionados com êxito ao grupo

Resposta JSON de exemplo

{
    "result": "true"
}

DELETE /members

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

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
Parâmetro caminho de URL Memberid Cadeia de caracteres Não GUID representando o memberId do membro 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
resultado Boolean True quando o membro especificado tiver sido removido com êxito do grupo

Resposta JSON de exemplo

{
    "result": "true"
}