Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Puoi utilizzare l'API CCaaS_CreateProactiveDelivery per avviare chiamate vocali in uscita proattive e SMS ai clienti 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à.
Importante
- Se un'organizzazione utilizza l'API
CCaaS_CreateProactiveDeliveryper avviare una chiamata vocale in uscita o un messaggio SMS, l'organizzazione è responsabile della gestione del consenso, incluso l'aggiornamento manuale delle "liste di non chiamare" per impostare orari di silenzio per il contatto con il cliente. Assicurati che le seguenti condizioni siano soddisfatte:- Il consenso viene ottenuto prima di contattare i clienti.
- 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 della richiesta
-
URL:
https://<orgurl>/api/data/v9.2/CCaaS_CreateProactiveDelivery - Metodo: POST
- Versione: 1.0
- Operazione OData: Azione
- Tipo OData: Non limitato
- Richiesta di autorizzazione: obbligatoria. Deve contenere un token Microsoft Entra ID Bearer valido per l'utente che effettua la chiamata API. Questo token deve essere emesso dallo stesso tenant Microsoft Entra ID dell'istanza Customer Service.
Intestazioni richieste
| Key | Tipo | Obbligatorio | Canale | Descrizione |
|---|---|---|---|---|
| ApiVersion | String | Sì | Entrambi | La versione dell'API CCaaS. |
| ProactiveEngagementConfigId | String | Sì | Entrambi | ID della Configurazione di Engagement Proattivo da utilizzare. Specifica anche il tipo di modalità di manopolazione, il flusso di lavoro e il profilo in uscita da utilizzare. Per ottenere questo ID, esegui i seguenti passaggi:
|
| RequestId | String | No | Entrambi | Attribue to pass per tracciare la richiesta da un sistema sorgente. |
| Priorità | String | No | Entrambi | Definisce il valore di priorità della richiesta. |
| Contatti | Array JSON degli oggetti Contact | Sì | Entrambi | Specifica uno o più contatti (fino a 5) su questa richiesta. È richiesto almeno un numero di telefono per ogni contatto. |
| Windows | Array JSON di oggetti Window | No | Entrambi | Specifica i periodi di tempo validi in cui la chiamata in uscita o l'SMS possono essere effettuati. 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). |
| Message | String | No | SMS | Contenuti dei messaggi da consegnare ai contatti. Può essere utilizzato solo per la configurazione proattiva degli SMS. Il messaggio viene generato di default dal template. Se il parametro viene fornito, sovrascrive il template. |
Contatto oggetto
| Key | Tipo | Obbligatorio | Canale | Descrizione |
|---|---|---|---|---|
| uniqueIdentifier | String | Sì | Entrambi | Identificatore univoco del contatto. Può essere un ContactId o un ID esterno. |
| firstName | String | Sì | Entrambi | Nome del contatto. |
| lastName | String | Sì | Entrambi | Cognome del contatto. |
| Numero di telefono mobile | String | Sì | Entrambi | Numero di telefono cellulare del contatto. |
| numero di telefono aziendale | String | No | Voce | Numero di telefono aziendale del contatto. |
| homePhoneNumber | String | No | Voce | Numero di telefono di casa del contatto. |
| posta elettronica | String | No | Entrambi | Indirizzo di posta elettronica del contatto. |
postalcode |
String | No | Entrambi | Codice postale del contatto. |
| state | String | No | Entrambi | Stato del contatto. |
country |
String | No | Entrambi | Paese/Regione del contatto. |
addressline |
String | No | Entrambi | Linea di indirizzo del contatto. |
| city | String | No | Entrambi | Città del contatto. |
| timezone | String | No | Entrambi | Fuso orario del contatto. Deve essere un valore dalla lista approvata da Dynamics 365. |
| inputAttributi | Oggetto JSON delle stringhe chiave-valore | No | Entrambi | 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. |
| finestre | Array JSON di oggetti Window | No | Entrambi | Windows temporali a livello di contatto che sovrascrivono le Windows di livello superiore per questo specifico contatto. |
Annotazioni
Almeno uno di mobilePhoneNumber, businessPhoneNumber, o homePhoneNumber è necessario per ogni contatto per la voce. Per gli SMS, solo mobilePhoneNumber è permesso.
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. |
Richieste di esempio
Richiesta vocale
{
"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\"}]}]"
}
Richiesta SMS
{
"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\"}]}]"
}
Risposta
Proprietà della risposta
| Property | Tipo | Descrizione |
|---|---|---|
DeliveryId |
Stringa (GUID) | L'identificatore unico della prima consegna proattiva creata |
DeliveryTaskId |
Stringa (GUID) | L'identificatore unico del compito di consegna proattiva creato |
Informazioni pertinenti
Utilizzare l'API CCaaS_CreateProactiveVoiceDelivery
Usa CCaaS_CreateOperation API
Utilizzare le tabelle di coinvolgimento proattive per la reportistica