Freigeben über


CCaaS_CreateProactiveVoiceDelivery-API verwenden

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.

Von Bedeutung

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:

  • Vor der Kontaktaufnahme mit Kunden wird eine ordnungsgemäße Einwilligung eingeholt
  • Kunden werden nur zu den zulässigen Zeiten kontaktiert.

Voraussetzungen

Initiieren Sie proaktive ausgehende Anrufe

Proaktives Engagement ermöglicht es Unternehmen, Kundeninteraktionen zu verbessern, indem sie ausgehende Kommunikation über den Sprachkanal initiieren. Sie können die proaktive Interaktion mithilfe einer Customer Insights-Journey oder der CCaaS_CreateProactiveVoiceDelivery.

Die CCaaS_CreateProactiveVoiceDelivery API ermöglicht es Organisationen, proaktive ausgehende Sprachanrufe an Kunden über den Proactive Engagement Service zu initiieren. Die API löst ausgehende Sprachanrufe über das Voice Runtime-System aus. Anrufe werden gemäß dem konfigurierten Wählmodus entweder sofort (wenn keine Zeitfenster angegeben sind) oder während der von Ihnen angegebenen Zeitfenster getätigt.

Diese API ermöglicht es Contact Centern, Kunden zur richtigen Zeit mit relevanten Informationen, Erinnerungen oder Benachrichtigungen zu erreichen, was das Kundenerlebnis verbessert und gleichzeitig die betriebliche Effizienz optimiert.

Anfragedetails

  • URL-Adresse: https://<orgurl>/api/data/v9.2/CCaaS_CreateProactiveVoiceDelivery
  • Methode: POST
  • Ausführung: 1.0
  • OData-Vorgang: Aktion
  • OData-Typ: Unbegrenzt
  • Autorisierung anfordern: Erforderlich. Muss ein gültiges Azure AD-Bearertoken für den Benutzer enthalten, der den API-Aufruf ausführt. Dieses Token muss von demselben Azure AD-Mandanten ausgestellt werden wie die Kundendienstinstanz.

Anforderungsheader

Schlüssel Typ BESCHREIBUNG
ApiVersion (Englisch) Schnur Die CCaaS-API-Version.
ProactiveEngagementConfigId Schnur 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. Gehen Sie zu Power Apps und wählen Sie die gewünschte Umgebung aus.
  2. Konfiguration der proaktiven Interaktion>
  3. Wählen Sie die ID des gewünschten Datensatzes aus.
Zieltelefonnummer Schnur Telefonnummer des Kunden, den Sie anrufen möchten.
Kontakt-ID Schnur ID des Kundenkontakts in Dynamics CRM.
Fenster 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, auf die innerhalb von Copilot-Agentenabläufen verwiesen werden kann, um das Verhalten anzupassen, bedingte Logik zu steuern oder personalisierte Informationen aus Dataverse-Datensätzen abzurufen.

Windows-Objekt

Schlüssel Typ BESCHREIBUNG
Starten Schnur Der Anfangszeitstempel für dieses Fenster. Muss in UTC im yyyy-MM-ddTHH:mm:ss.fffZ Format angegeben werden.
ENDE Schnur Der Endzeitstempel für dieses Fenster. Muss in UTC im yyyy-MM-ddTHH:mm:ss.fffZ Format angegeben werden.

Von Bedeutung

Einige Clients benötigen ein bestimmtes Format, z. B "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"
}

Planen Sie Rückrufe von jeder Plattform aus

Sie können die Proactive Engagement-Lösung verwenden, um Rückrufe von verschiedenen Plattformen zu planen, einschließlich Web, mobilen Anwendungen, Sprach- und Chat-Agenten. Sie können dies auf folgende Arten tun:

  • Erstellen Sie einen Power Automate-Flow über den Copilot Studio-Agenten.
  • Integrieren Sie die Callback-API für Zeitpläne in Ihre Website.

Erstellen eines Power Automate-Flows über den Copilot-Agent

Sie können einen Power Automate-Flow über den Copilot-Agent erstellen, um Rückrufe zu planen. Führen Sie die folgenden Schritte durch:

  1. Führen Sie die Schritte unter Erstellen eines Flows aus, den Sie mit einem Agent mit den folgenden Parametern verwenden können:
  • Geben Sie Perform an unbound action (Nicht gebundene Aktion ausführen ) als Aktion an.
  • Wählen Sie CCaaS_CreateProactiveVoiceDelivery als Aktionsnamen aus.
  • Geben Sie unter Erweiterte Parameter die folgenden Pflichtfelder an:
    • Item/DestinationPhoneNumber: Telefonnummer des Kunden, den er anrufen möchte.
    • Item/ProactiveEngagementConfigId: ID der zu verwendenden Konfiguration für die proaktive Interaktion. Dies gibt den Wählmodustyp, den Arbeitsstream und das ausgehende Profil an, das bei der Kontaktaufnahme mit dem Kunden verwendet werden soll. Sie können diese ID aus der >Apps-Tabellentabelle >Proactive Engagement-Konfiguration kopieren.
    • Artikel/APIVersion: 1.0
    • Item/ContactId: ID des Kundenkontakts in Dynamics CRM.
    • Optional können Sie Item/InputAttributes angeben. Dieses Feld sollte ein JSON-Objekt enthalten, das vom Copilot-Agenten verwendet wird. Beispiel: { "msdyn_CaseTitle" : "Vitre cassée", "msdyn_CustomerName" : "Sarah", "msdyn_CustomerPhone" : "+1234567890", "msdyn_CustomerId" : "cfaa617b-2fc1-ef11-b8e8-000d3a5bcd16" }.

Verwenden der API zum Planen von Rückrufen

Integrieren Sie die CCaaS_CreateProactiveVoiceDelivery API in Ihre Website, damit Kunden zu den für sie günstigsten Zeiten Hilfe anfordern können.

Beispiel für eine Anforderung

{
  "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": {
     "type": "callback"
    "isLastAttempt": "false"
  }
}

CCaaS_CreateOperation

Suspendieren, fortsetzen und absagen.

Umsetzungsstatus: In Entwicklung

API CCaaS_CreateOperation
BESCHREIBUNG Fordern Sie den Betrieb von PES an, um den Betrieb abzubrechen, auszusetzen oder wieder aufzunehmen
URL https://< orgurl>/api/data/v9.2/CaaS_CreateOperation
Version 1,0
OData-Operation Maßnahme
OData-Typ Beschränkt
HTTP-Verb POST
HTTP-Anfrage-Header Autorisierung: <Pflicht-Bearer-Token von Azure AD für den API-Aufrufer im Tenant der CCaaS-Instanz.>
Beispielszenarien
Erforderliche Privilegien

HTTP-Anfrageschlüssel

Schlüssel Typ Erforderlich BESCHREIBUNG
ApiVersion (Englisch) Schnur ja Muss auf "1.0" gesetzt werden.
ProactiveEngagementConfigId Schnur nein Die proaktive Engagement-ID
DeliveryId Schnur nein wenn Stornieren, wird die Lieferung storniert
Operation Schnur ja Suspendieren, fortsetzen oder abbrechen

Beispielnutzlast

{ 
  "ApiVersion": "1.0", 
  "ProactiveEngagementConfigId": "47089bbe-deb7-ef11-b8e6-000d3a36a6b3", 
  "Operation ": "Resume"
}

HTTP-Antwortstatus

HTTP Statusbemerkung
202 Angenommen
400 Schlechte Anfrage (Falsche Eingabeparameter)
401 Nicht autorisiert
404 Ressource nicht gefunden
429 Rate-Limit (Zu viele Anfragen)
405 API nicht erlaubt

Verwenden von proaktiven Engagement-Tabellen für die Berichterstellung