Freigeben über

/Abonnenten

  • Artikel

API-Endpunkt zum Hinzufügen, Abrufen oder Löschen von Abonnenten aus einer verwalteten öffentlichen Gruppe.

ADD /subscribers

   PUT {endpoint-url}/v1/groups/{groupId}/subscribers/add

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

Anforderungstext

Parameter Typ Beschreibung
Abonnenten String[] Jede Zeichenfolge stellt eine Mobiltelefonnummer mit Landesvorwahl (z. B. +911111111111) dar.

JSON-Beispielanforderung

{
    subscribers : ["+911111111111", "+911111111112"]
}

Antworttext

Parameter Typ Beschreibung
result JSON-Objekt Jeder Schlüssel dieses Json-Objekts stellt die Mobiltelefonnummer und der Wert das JSON-Objekt dar, das Erfolg oder Fehler mit Grund enthält.

JSON-Beispielantwort

{
    "result": {
        "+911111111111": {
            "isAdded": true
        },
        "+911111111112": {
            "isAdded": true
        }
    }
}

GET /subscribers

   POST {endpoint-url}/v1/groups/{groupId}/subscribers

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

Anforderungstext

Parameter Typ Optional? Beschreibung
Cursor Zeichenfolge Ja Beginn des Resultsets. Für Paginierung. Zurückgegeben im Antworttext
count int Ja Standardwert: 50. Maximal: 50. Anzahl der Abonnenten, die in einem Resultset zurückgegeben werden sollen

Antworttext

Parameter Typ Beschreibung
Abonnenten JSON-Array Array von JSON-Objekten, die jeweils einen Abonnenten der Gruppe darstellen
Cursor Zeichenfolge Beginn des Resultsets. Für Paginierung. Wird im Anforderungstext zum Abrufen des nächsten Resultsets verwendet. Als Antwort nur vorhanden, wenn ein gültiges nächstes Resultset vorhanden ist.

JSON-Beispielantwort

{
    "subscribers": [
        {
            "id": "e2238eb5-2f45-4783-8f4b-571549db86c0",
            "mobileNumber": "+91109999999",
            "name": "",
            "profilePic": "",
            "isProvisioned": false
        }
    ]
}

REMOVE /subscribers

   PUT {endpoint-url}/v1/groups/{groupId}/subscribers/remove

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

Anforderungstext

Parameter Typ Beschreibung
Abonnenten String[] Jede Zeichenfolge stellt eine Mobiltelefonnummer mit Landesvorwahl (z. B. +911111111111) dar.

JSON-Beispielanforderung

{
    subscribers : ["+911111111111", "+911111111112"]
}

Antworttext

Parameter Typ Beschreibung
result JSON-Objekt Jeder Schlüssel dieses Json-Objekts stellt die Mobiltelefonnummer und der Wert das JSON-Objekt dar, das Erfolg oder Fehler mit Grund enthält.

JSON-Beispielantwort

{
    "result": {
        "+911111111111": {
            "isRemoved": true
        },
        "+911111111112": {
            "isRemoved": true
        }
    }
}