Freigeben über


/Nachrichten

API-Endpunkt zum Senden von Nachrichten an Konversationsgruppen in Kaizala.

POST /messages

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

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 Optional? Beschreibung
message String Nein Zu sendende SMS (maximal 4.000 Zeichen)
sendToAllSubscribers Boolescher Wert Ja Standard: False. Nur gültig, wenn die groupId zu einer öffentlichen Gruppe gehört. True, um die SMS an alle Abonnenten zu senden, für die der Benutzer des Tokens administrator der öffentlichen Gruppe sein muss.
Abonnenten String[] Ja Jedes Element entspricht einer Mobiltelefonnummer (mit Landesvorwahl). Zb. +911999999999). Eine SMS wird nur an die ausgewählten Abonnenten gesendet. Für die selektive Kommunikation mit Abonnenten im Kontext einer öffentlichen Gruppe verwendet werden

JSON-Beispielanforderung

{
  "message": "Hello All! Welcome to Kaizala.",
  "subscribers": ["+911999999999","+911999999998"]
}

Antworttext

Parameter Typ Beschreibung
referenceId Zeichenfolge GUID, die den erfolgreichen Abschluss der Anforderung darstellt

JSON-Beispielantwort

{
    "referenceId": "853654b2-5874-462d-b709-0c4e43a7083f"
}