Verwenden Sie die CCaaS_CreateProactiveDelivery-API

Sie können die CCaaS_CreateProactiveDelivery API nutzen, um proaktive ausgehende Sprachanrufe und SMS-Nachrichten an Kunden über den Proactive Engagement-Service zu initiieren.

Mehrere APIs stehen zur Verfügung, um proaktive Lieferungen zu erstellen. Verwenden Sie die folgenden Hinweise, um die richtige auszuwählen:

  • CCaaS_CreateProactiveBulkDelivery: Verwenden Sie diese API, um mehrere Datensätze in einer einzigen Anfrage zu senden (etwa 15.000 Datensätze). Es unterstützt keine Kontoanrufe.
  • CCaaS_CreateProactiveDelivery: Diese API ist die vielseitigste. Es unterstützt alle Funktionen und Kanäle sowie Kontoaufrufe (mehrere Kontakte im Rahmen derselben Anfrage). Nutze diese API für die meisten Szenarien.
  • CCaaS_CreateSimpleProactiveDelivery: Diese Version erfordert kein komplexes JSON-Nesting und eignet sich am besten für Oberflächen wie Power Automate.
  • CCaaS_CreateProactiveVoiceDelivery: Diese API ist eine Sprach-API der ersten Generation, die keine neueren Funktionen unterstützt. Solange es unterstützt wird, migriere zu CCaaS_CreateProactiveDelivery für die neuesten Funktionen.
  • CCaaS_CreateProactiveSMSDelivery: Diese API ist eine SMS-API der ersten Generation, die keine neueren Funktionen unterstützt. Solange es unterstützt wird, migriere zu CCaaS_CreateProactiveDelivery für die neuesten Funktionen.

Important

  • Wenn eine Organisation die CCaaS_CreateProactiveDelivery API nutzt, um einen ausgehenden Sprachanruf oder eine SMS-Nachricht zu initiieren, ist die Organisation für das Einwilligungsmanagement verantwortlich, einschließlich der manuellen Aktualisierung von "Nicht anrufen"-Listen zur Festlegung von Ruhezeiten für Kundenkontakt. Stellen Sie sicher, dass die folgenden Bedingungen erfüllt sind:
    • Die Zustimmung wird eingeholt, bevor Kunden kontaktiert werden.
    • Kunden werden nur zu den zulässigen Zeiten kontaktiert.

Voraussetzungen

  • Du musst die Rolle des Omnichannel-Agenten oder Omnichannel-Supervisors haben, um diese API aufrufen zu können.
  • Proaktives Engagement ist konfiguriert. Erfahren Sie mehr unter Configure proactive engagement.

Anfragedetails

  • URL:https://<orgurl>/api/data/v9.2/CCaaS_CreateProactiveDelivery
  • Methode: POST
  • Version: 1.0
  • OData-Vorgang: Aktion
  • OData-Typ: Unbegrenzt
  • Autorisierung anfordern: Erforderlich. Muss ein gültiges Microsoft Entra ID Bearer-Token enthalten, damit der Benutzer den API-Aufruf aufnimmt. Dieses Token muss vom selben Microsoft Entra ID-Tenant wie die Kundenservice-Instanz ausgegeben werden.

Anforderungsheader

Key Typ Erforderlich Kanal Description
ApiVersion String Ja Beides Die CCaaS-API-Version.
ProactiveEngagementConfigId String Ja Beides ID der Proactive Engagement Configuration zu verwenden. Er legt außerdem den Wählmodustyp, den Arbeitsstrom und das ausgehende Profil fest. Um diese ID zu erhalten, führen Sie folgende Schritte aus:
  1. Gehe zu Power Apps und wähle die erforderliche Umgebung aus.
  2. Auswählen Tabellen>Konfiguration für proaktives Engagement.
  3. Wählen Sie die ID des gewünschten Datensatzes aus.
RequestId String No Beides Attribut zu übergeben, um die Anfrage von einem Quellsystem zu verfolgen.
Priorität String No Beides Definiert den Prioritätswert der Anfrage.
Kontakte JSON-Array von Kontaktobjekten Ja Beides Spezifiziert einen oder mehrere Kontakte (bis zu 5) auf dieser Anfrage. Mindestens eine Telefonnummer pro Kontakt ist erforderlich.
Windows JSON-Array von Window-Objekten No Beides Gibt die gültigen Zeiträume an, in denen der ausgehende Anruf oder SMS getätigt werden kann. Wenn nicht angegeben, verwendet das System standardmäßig ein 24-Stunden-Fenster, das sofort beginnt (von der aktuellen Uhrzeit bis 24 Stunden später).
Meldung String No SMS Nachrichteninhalte sollen an die Kontakte zugestellt werden. Kann nur für SMS-proaktive Konfigurationen verwendet werden. Die Nachricht wird standardmäßig aus der Vorlage generiert. Wenn der Parameter angegeben ist, überschreibt er die Vorlage.

Kontaktobjekt

Key Typ Erforderlich Kanal Description
uniqueIdentifier (eindeutiger Bezeichner) String Ja Beides Eindeutiger Bezeichner des Kontakts. Es kann eine ContactId oder eine externe ID sein.
firstName String Ja Beides Vorname des Kontakts.
lastName String Ja Beides Nachname des Kontakts.
mobilePhoneNumber String Ja Beides Mobiltelefonnummer des Kontakts.
Geschäftstelefonnummer String No Stimme Geschäftstelefonnummer des Kontakts.
homePhoneNumber String No Stimme Festnetznummer des Kontakts.
E-Mail String No Beides E-Mail-Adresse des Kontakts.
postalcode String No Beides Postleitzahl des Kontakts.
state String No Beides Zustand des Kontakts.
country String No Beides Land/Region des Kontakts.
addressline String No Beides Adressnummer des Kontakts.
Stadt String No Beides Stadt des Kontakts.
timezone String No Beides Zeitzone des Kontakts. Muss ein Wert aus der von Dynamics 365 genehmigten Liste sein.
inputAttribute JSON-Objekt von Schlüssel-Wert-Zeichenfolgen No Beides Variablen, die innerhalb von Copilot-Agent-Flows referenziert werden können, um das Verhalten anzupassen, bedingte Logik zu steuern oder personalisierte Informationen aus Dataverse-Datensätzen abzurufen.
Fenster JSON-Array von Window-Objekten No Beides Die Kontaktzeitebene windows die die oberste Windows für diesen speziellen Kontakt überschreibt.

Note

Mindestens eine von mobilePhoneNumber, businessPhoneNumber, oder homePhoneNumber ist pro Kontakt für die Sprachübertragung erforderlich. Für SMS ist nur mobilePhoneNumber erlaubt.

Windows-Objekt

Key Typ Description
Start String Der Anfangszeitstempel für dieses Fenster. Muss in UTC im yyyy-MM-ddTHH:mm:ss.fffZ Format angegeben werden.
Beenden String Der Endzeitstempel für dieses Fenster. Muss in UTC im yyyy-MM-ddTHH:mm:ss.fffZ Format angegeben werden.

Beispielanforderungen

Sprachanfrage

{
  "ApiVersion": "1.0",
  "ProactiveEngagementConfigId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "RequestId": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
  "Priority": "1",
  "Contacts": "[{\"uniqueIdentifier\":\"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"firstName\":\"John\",\"lastName\":\"Doe\",\"mobilePhoneNumber\":\"+15550100\",\"businessPhoneNumber\":\"+15550101\",\"homePhoneNumber\":\"+15550102\",\"email\":\"text@a.com\",\"postalcode\":\"25642\",\"state\":\"WA\",\"country\":\"USA\",\"addressline\":\"1234 227th PL SE\",\"city\":\"Seattle\",\"timezone\":\"(GMT-03:00) Brasilia\",\"inputAttributes\":{\"AppointmentTime\":\"10:00 AM\",\"CustomerNumber\":\"1234567\"},\"windows\":[{\"start\":\"2025-12-10T09:00:00Z\",\"end\":\"2025-12-10T17:00:00Z\"}]}]"
}

SMS-Anfrage

{
  "ApiVersion": "1.0",
  "ProactiveEngagementConfigId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "RequestId": "d3e4f5a6-b7c8-9012-cdef-a12345678901",
  "Priority": "1",
  "Message": "Your appointment is confirmed for tomorrow at 10:00 AM. Reply STOP to opt out.",
  "Contacts": "[{\"uniqueIdentifier\":\"a58bc20c-69dd-5483-b678-1f13c3d4e580\",\"firstName\":\"Jane\",\"lastName\":\"Smith\",\"mobilePhoneNumber\":\"+15550200\",\"email\":\"jane.smith@example.com\",\"postalcode\":\"98101\",\"state\":\"WA\",\"country\":\"USA\",\"addressline\":\"5678 Main St\",\"city\":\"Seattle\",\"timezone\":\"(GMT-08:00) Pacific Time\",\"inputAttributes\":{\"AppointmentTime\":\"10:00 AM\",\"CustomerNumber\":\"7654321\"},\"windows\":[{\"start\":\"2025-12-10T09:00:00Z\",\"end\":\"2025-12-10T17:00:00Z\"}]}]"
}

Antwort

Antworteigenschaften

Eigentum Typ Description
DeliveryId Zeichenfolge (GUID) Die eindeutige Kennung der erstellten ersten proaktiven Lieferung
DeliveryTaskId Zeichenfolge (GUID) Die eindeutige Kennung der erstellten proaktiven Lieferaufgabe

Verwenden CCaaS_CreateProactiveVoiceDelivery-API
Verwende CCaaS_CreateOperation API
Verwenden von proaktiven Engagement-Tabellen für die Berichterstellung

  • Last updated on