/Mitglieder

API-Endpunkt zum Hinzufügen oder Löschen von Mitgliedern aus Konversationsgruppen in Kaizala.

GET /members

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

Anforderungsparameter

	Parameter	Typ	Optional?	Beschreibung
URL-Pfadparameter	groupId	Zeichenfolge	Nein	GUID, die die groupId der spezifischen Gruppenressource darstellt
HTTP-Header	accessToken	Zeichenfolge	Nein	Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird

Antworttext

Parameter	Typ	Beschreibung
Elemente	JSON-Array	Array von JSON-Objekten, die jeweils ein Mitglied der Gruppe darstellen

JSON-Beispielantwort

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

Anforderungsparameter

	Parameter	Typ	Optional?	Beschreibung
URL-Pfadparameter	groupId	Zeichenfolge	Nein	GUID, die die groupId der spezifischen Gruppenressource darstellt
HTTP-Header	accessToken	Zeichenfolge	Nein	Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird
HTTP-Header	Content-Type	Zeichenfolge	Nein	value: application/json

Anforderungstext

Parameter	Typ	Beschreibung
Elemente	Zeichenfolgenarray	Array von gut formatierten Telefonnummern neuer Mitglieder, die hinzugefügt werden sollen

JSON-Beispielanforderung

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

Antworttext

Parameter	Typ	Beschreibung
result	Boolesch	True, wenn alle Telefonnummern erfolgreich zur Gruppe hinzugefügt wurden

JSON-Beispielantwort

{
    "result": "true"
}

DELETE /members

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

Anforderungsparameter

	Parameter	Typ	Optional?	Beschreibung
URL-Pfadparameter	groupId	Zeichenfolge	Nein	GUID, die die groupId der spezifischen Gruppenressource darstellt
URL-Pfadparameter	memberId	Zeichenfolge	Nein	GUID, die die memberId des bestimmten Members darstellt
HTTP-Header	accessToken	Zeichenfolge	Nein	Zugriffstoken, das vom Authentifizierungsendpunkt empfangen wird

Antworttext

Parameter	Typ	Beschreibung
result	Boolesch	True, wenn das angegebene Mitglied erfolgreich aus der Gruppe entfernt wurde

JSON-Beispielantwort

{
    "result": "true"
}