Share via

/Членов

  • Статья

Конечная точка API для добавления или удаления участников из групп бесед в Kaizala.

GET /members

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

Параметры запроса

Параметр Тип Дополнительные? Описание
Параметр URL-пути groupId String Нет GUID, представляющий groupId определенного ресурса группы
Заголовок HTTP accessToken Строка Нет Маркер доступа, полученный от конечной точки проверки подлинности

Текст ответа

Параметр Тип Описание
members Массив JSON Массив объектов JSON, каждый из которых представляет члена группы

Пример ответа JSON

{
  "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

Параметры запроса

Параметр Тип Дополнительные? Описание
Параметр URL-пути groupId String Нет GUID, представляющий groupId определенного ресурса группы
Заголовок HTTP accessToken Строка Нет Маркер доступа, полученный от конечной точки проверки подлинности
Заголовок HTTP Content-Type String Нет value: application/json

Текст запроса

Параметр Тип Описание
members Массив строк Массив хорошо отформатированных телефонных номеров новых участников для добавления

Пример запроса JSON

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

Текст ответа

Параметр Тип Описание
result Boolean True, если все номера телефонов успешно добавлены в группу

Пример ответа JSON

{
    "result": "true"
}

DELETE /members

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

Параметры запроса

Параметр Тип Дополнительные? Описание
Параметр URL-пути groupId String Нет GUID, представляющий groupId определенного ресурса группы
Параметр URL-пути memberId Строка Нет GUID, представляющий memberId определенного элемента
Заголовок HTTP accessToken Строка Нет Маркер доступа, полученный от конечной точки проверки подлинности

Текст ответа

Параметр Тип Описание
result Boolean Значение true, если указанный член успешно удален из группы

Пример ответа JSON

{
    "result": "true"
}