Brug CCaaS_CreateProactiveDelivery API

Du kan bruge API'en CCaaS_CreateProactiveDelivery til at igangsætte proaktive udgående taleopkald og SMS-beskeder til kunder via Proactive Engagement-tjenesten.

Flere API'er er tilgængelige for at skabe proaktive leverancer. Brug følgende vejledning til at vælge den rigtige:

  • CCaaS_CreateProactiveBulkDelivery: Brug dette API til at sende flere poster i én forespørgsel (ca. 15.000 poster). Den understøtter ikke kontoopkald.
  • CCaaS_CreateProactiveDelivery: Dette API er det mest alsidige. Den understøtter alle funktioner og kanaler samt kontoopkald (flere kontakter som en del af samme anmodning). Brug dette API til de fleste scenarier.
  • CCaaS_CreateSimpleProactiveDelivery: Denne version kræver ikke kompleks JSON-nesting og egner sig bedst til overflader som Power Automate.
  • CCaaS_CreateProactiveVoiceDelivery: Dette API er en førstegenerations stemme-API, der ikke understøtter nyere funktioner. Selvom det understøttes, så migrer til CCaaS_CreateProactiveDelivery for de nyeste funktioner.
  • CCaaS_CreateProactiveSMSDelivery: Dette API er en førstegenerations SMS-API, der ikke understøtter nyere funktioner. Selvom det understøttes, så migrer til CCaaS_CreateProactiveDelivery for de nyeste funktioner.

Vigtigt!

  • Hvis en organisation bruger API'et CCaaS_CreateProactiveDelivery til at igangsætte et udgående taleopkald eller SMS-besked, er organisationen ansvarlig for samtykkehåndtering, herunder manuel opdatering af "don't calls-lister" til at sætte stille timer for kundekontakt. Sørg for, at følgende betingelser er opfyldt:
    • Samtykke indhentes, før kunderne kontaktes.
    • Kunder kontaktes kun på tilladte tidspunkter.

Forudsætninger

  • Du skal have rollen som Omnichannel-agent eller Omnichannel-supervisor for at kunne kalde dette API.
  • Proaktivt engagement er konfigureret. Lær mere i Konfigurér proaktivt engagement.

Detaljer om anmodning

  • URL-adresse: https://<orgurl>/api/data/v9.2/CCaaS_CreateProactiveDelivery
  • Metode: POST
  • Version: 1.0
  • OData-operation: Handling
  • OData-type: Ubegrænset
  • Anmod om autorisation: Påkrævet. Skal indeholde et gyldigt Microsoft Entra ID Bearer-token for brugeren, der foretager API-kaldet. Dette token skal udstedes fra samme Microsoft Entra ID-lejer som kundeserviceinstansen.

Headers til anmodninger

Nøgle Type Påkrævet Kanal Beskrivelse
ApiVersion String Ja Begge CCaaS API-versionen.
ProactiveEngagementConfigId String Ja Begge ID for den proaktive engagement-konfiguration, der skal bruges. Den specificerer også dial-tilstandstype, arbejdsstrøm og udgående profil, der skal bruges. For at få dette ID skal du udføre følgende trin:
  1. Gå til Power Apps og vælg det ønskede miljø.
  2. Vælg tabeller>proaktiv engagement-konfiguration.
  3. Vælg id'et for den påkrævede post.
RequestId String Nej Begge Attribut til at sende for at spore forespørgslen fra et kildesystem.
Prioritet String Nej Begge Definerer prioritetsværdien af anmodningen.
Kontakter JSON-array af kontaktobjekter Ja Begge Specificerer en eller flere kontakter (op til 5) på denne anmodning. Mindst ét telefonnummer pr. kontakt er påkrævet.
Windows JSON-matrix af vinduesobjekter Nej Begge Angiver de gyldige tidsperioder, hvor det udgående opkald eller SMS kan foretages. Hvis det ikke er angivet, har systemet som standard et 24-timers vindue, der starter med det samme (fra det aktuelle tidspunkt til 24 timer senere).
Meddelelse String Nej sms Beskedindhold skal leveres til kontakterne. Kan kun bruges til proaktiv SMS-konfiguration. Beskeden genereres som standard fra skabelonen. Hvis parameteren er angivet, overskriver den skabelonen.

Kontaktobjekt

Nøgle Type Påkrævet Kanal Beskrivelse
uniqueIdentifier String Ja Begge Unik identifikator for kontakten. Det kan være et ContactId eller et eksternt ID.
fornavn String Ja Begge Kontaktens fornavn.
efternavn String Ja Begge Kontaktens efternavn.
mobilTelefonnummer String Ja Begge Mobiltelefonnummeret på kontakten.
businessTelefonnummer String Nej Voice Forretningstelefonnummeret på kontakten.
hjemTelefonnummer String Nej Voice Kontaktens hjemmetelefonnummer.
email String Nej Begge Kontaktens e-mailadresse.
postalcode String Nej Begge Postnummeret til kontakten.
state String Nej Begge Kontaktens tilstand.
country String Nej Begge Kontaktens land/region.
addressline String Nej Begge Kontaktens adresselinje.
by String Nej Begge Kontaktens by.
tidszone String Nej Begge Kontaktens tidszone. Skal være en værdi fra Dynamics 365-godkendte listen.
inputAttributter JSON-objekt for nøgle/værdi-strenge Nej Begge Variabler, der kan refereres i Copilot-agent-flows for at tilpasse adfærd, styre betinget logik eller hente personlige oplysninger fra Dataverse-poster.
Vinduer JSON-matrix af vinduesobjekter Nej Begge Kontaktniveau-tids-windows, der tilsidesætter topniveau-Windows for denne specifikke kontakt.

Bemærkning

Mindst én af mobilePhoneNumber, businessPhoneNumber, eller homePhoneNumber er påkrævet pr. kontakt for stemme. For SMS er kun mobilePhoneNumber tilladt.

Windows-objekt

Nøgle Type Beskrivelse
Start String Starttidsstemplet for dette vindue. Skal angives i UTC i formatet yyyy-MM-ddTHH:mm:ss.fffZ .
Afslut String Sluttidsstemplet for dette vindue. Skal angives i UTC i formatet yyyy-MM-ddTHH:mm:ss.fffZ .

Eksempelanmodninger

Stemmeanmodning

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

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

Svar

Svaregenskaber

Egenskab Type Beskrivelse
DeliveryId Streng (GUID) Den unikke identifikator for den skabte første proaktive levering
DeliveryTaskId Streng (GUID) Den unikke identifikator for den oprettede proaktive leveringsopgave

Brug CCaaS_CreateProactiveVoiceDelivery API
Brug CCaaS_CreateOperation API
Brug proaktive engagementstabeller til rapportering

  • Last updated on