Utilizzare l'API CCaaS_CreateProactiveVoiceDelivery

È possibile utilizzare l'API CCaaS_CreateProactiveVoiceDelivery per avviare chiamate vocali in uscita proattive ai clienti o consentire ai clienti di pianificare le richiamate tramite il servizio Proactive Engagement.

Sono disponibili diverse API per creare consegne proattive. Usa le seguenti indicazioni per scegliere quella giusta:

  • CCaaS_CreateProactiveBulkDelivery: Usa questa API per inviare più record in una singola richiesta (circa 15.000 record). Non supporta le chiamate di account.
  • CCaaS_CreateProactiveDelivery: Questa API è la più versatile. Supporta tutte le funzionalità e i canali, oltre alle chiamate di account (più contatti come parte della stessa richiesta). Usa questa API per la maggior parte degli scenari.
  • CCaaS_CreateSimpleProactiveDelivery: Questa versione non richiede un complesso annidamento JSON ed è più adatta a superfici come Power Automate.
  • CCaaS_CreateProactiveVoiceDelivery: Questa API è una voce di prima generazione che non supporta funzionalità più recenti. Finché è supportato, migra su CCaaS_CreateProactiveDelivery per le ultime funzionalità.
  • CCaaS_CreateProactiveSMSDelivery: Questa API è una API SMS di prima generazione che non supporta funzionalità più recenti. Finché è supportato, migra su CCaaS_CreateProactiveDelivery per le ultime funzionalità.

Note

Questa API non supporta funzionalità di engagement proattivo come tentativi di ritorno, finestre di contatto, priorità personalizzate e limiti di frequenza. Usa l'API CCaaS_CreateProactiveDelivery se vuoi sfruttare queste funzionalità.

Importante

Se un'organizzazione utilizza l'API CCaaS_CreateProactiveVoiceDelivery per avviare una chiamata vocale in uscita, l'organizzazione è responsabile della gestione del consenso, incluso l'aggiornamento manuale degli elenchi "Do not call" per l'impostazione delle ore di silenzio per il contatto con i clienti. Assicurarsi che siano soddisfatte le condizioni seguenti:

  • Il consenso viene ottenuto prima che i clienti vengano contattati.
  • I clienti vengono contattati solo negli orari consentiti.

Prerequisiti

  • Devi avere il ruolo di agente Omnicanale o supervisore Omnicanale per chiamare questa API.
  • Il coinvolgimento proattivo è configurato. Scopri di più in Configura l'impegno proattivo.

Dettagli richiesta

  • URL: https://<orgurl>/api/data/v9.2/CCaaS_CreateProactiveVoiceDelivery
  • Metodo: POST
  • Versione: 1.0
  • Operazione OData: Azione
  • Tipo OData: Non limitato
  • Richiesta di autorizzazione: obbligatoria. Deve contenere un token Azure AD Bearer valido per l'utente che effettua la chiamata API. Questo token deve essere emesso dallo stesso tenant Azure AD dell'istanza del Servizio Clienti.

Intestazioni richieste

Key Tipo Descrizione
ApiVersion String La versione dell'API CCaaS.
ProactiveEngagementConfigId String ID della configurazione di Proactive Engagement da utilizzare. Specifica il tipo di modalità di composizione, il flusso di lavoro e il profilo in uscita da utilizzare. Per ottenere questo ID, procedi come segue:
  1. Vai su Power Apps e seleziona l'ambiente richiesto.
  2. Seleziona tabelle>Configurazione coinvolgimento proattivo
  3. Selezionare l'ID del record richiesto.
Numero di telefono di destinazione String Numero di telefono del cliente da chiamare.
ContactId String ID del contatto cliente in Dynamics CRM.
Windows Array JSON di oggetti Window Specifica i periodi di tempo validi in cui può essere effettuata la chiamata in uscita. Se non viene fornito, per impostazione predefinita il sistema utilizza una finestra di 24 ore a partire da immediatamente (dall'ora corrente fino a 24 ore dopo).
InputAttributes Oggetto JSON delle stringhe chiave-valore Optional. Variabili che possono essere riferite all'interno dei flussi agente Copilot per personalizzare il comportamento, guidare la logica condizionale o recuperare informazioni personalizzate dai record Dataverse.

Oggetto Windows

Key Tipo Descrizione
Start String Timestamp iniziale per questa finestra. Deve essere specificato in UTC nel yyyy-MM-ddTHH:mm:ss.fffZ formato.
Fine periodo String Timestamp di fine per questa finestra. Deve essere specificato in UTC nel yyyy-MM-ddTHH:mm:ss.fffZ formato.

Importante

Alcuni client richiedono un formato specifico come "Windows": "[{\"Start\":\"2025-01-30T16:32:45.930Z\",\"End\":\"2025-06-25T16:32:45.930Z\"}]". Si consiglia di eseguire il test di conseguenza.

Esempio di richiesta

{
  "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"
  }
}

Dettagli della risposta

In caso di esito positivo, questo metodo restituisce DeliveryId. L'ID recapito è un identificatore univoco assegnato a ogni richiesta di coinvolgimento proattivo che viene accettata tramite l'API e memorizzata nella tabella msdyn_proactive_delivery.

La risposta di esempio è la seguente:

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

Utilizzare le tabelle di coinvolgimento proattive per la reportistica