Verwenden CCaaS_CreateProactiveVoiceDelivery-API

Sie können die CCaaS_CreateProactiveVoiceDelivery API verwenden, um proaktive ausgehende Sprachanrufe an Kunden zu initiieren oder Kunden zu ermöglichen, Rückrufe über den Proactive Engagement Service zu planen.

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.

Note

Diese API unterstützt keine proaktiven Engagement-Funktionen wie Wiederholungsversuche, Kontaktfenster, benutzerdefinierte Priorität und Frequenzbegrenzung. Nutzen Sie die CCaaS_CreateProactiveDelivery API, wenn Sie diese Funktionen nutzen möchten.

Important

Wenn eine Organisation die CCaaS_CreateProactiveVoiceDelivery API verwendet, um einen ausgehenden Sprachanruf zu initiieren, ist die Organisation für die Einwilligungsverwaltung verantwortlich, einschließlich der manuellen Aktualisierung von "Nicht-Anruflisten" zum Festlegen von Ruhezeiten für den Kundenkontakt. Stellen Sie sicher, dass die folgenden Bedingungen erfüllt sind:

  • Die Zustimmung wird eingeholt, bevor die 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.

Anforderungsdetails

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

Anforderungsheader

Key Typ Description
ApiVersion String Die CCaaS-API-Version.
ProactiveEngagementConfigId String ID der zu verwendenden Proactive Engagement-Konfiguration. Dies gibt den Wählmodustyp, den Arbeitsstream und das zu verwendende ausgehende Profil an. Gehen Sie folgendermaßen vor, um diese ID abzurufen:
  1. Gehe zu Power Apps und wähle die erforderliche Umgebung aus.
  2. Konfiguration der proaktiven Interaktion>
  3. Wählen Sie die ID des gewünschten Datensatzes aus.
Zieltelefonnummer String Telefonnummer des Kunden, den Sie anrufen möchten.
Kontakt-ID String ID des Kundenkontakts in Dynamics CRM.
Windows JSON-Array von Window-Objekten Gibt die gültigen Zeiträume an, in denen der ausgehende Anruf 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).
Eingabe-Attribute JSON-Objekt von Schlüssel-Wert-Zeichenfolgen Wahlfrei. 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.

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.

Important

Einige Clients benötigen ein bestimmtes Format wie "Windows": "[{\"Start\":\"2025-01-30T16:32:45.930Z\",\"End\":\"2025-06-25T16:32:45.930Z\"}]". Wir empfehlen Ihnen, entsprechend zu testen.

Musteranforderung

{
  "ApiVersion": "1.0",
  "ProactiveEngagementConfigId": "cbbac510-3e66-ef11-a671-6045bd03d9d8",
  "DestinationPhoneNumber": "+123456798",
  "ContactId": "761e062f-c734-ef11-8e4f-00224808a166",
  "Windows": [
    {
      "Start": "2024-09-10T13:00:00.000Z",
      "End": "2024-09-10T15:59:59.999Z"
    },
    {
      "Start": "2024-09-11T13:00:00.000Z",
      "End": "2024-09-11T15:59:59.999Z"
    }
  ],
  "InputAttributes": {
    "orderNumber": "ORD123456789",
    "type": "callback",
    "isFinalAttempt": "false"
  }
}

Details zur Antwort

Bei erfolgreicher Ausführung gibt die Methode zurück DeliveryId. Die Übermittlungs-ID ist eine eindeutige Kennung, die jeder proaktiven Interaktionsanforderung zugewiesen wird, die über die API akzeptiert und in der msdyn_proactive_delivery Tabelle gespeichert wird.

Die Beispielantwort lautet wie folgt:

{
  "@odata.context": "[Organization URI]api/data/v9.2/$metadata#Microsoft.Dynamics.CRM.CCaaS_CreateProactiveVoiceDeliveryResponse",
  "DeliveryId": "9838deee-0b4e-4116-bf73-ecb80474568d"
}

Verwenden von proaktiven Engagement-Tabellen für die Berichterstellung