Κοινή χρήση μέσω

Ορισμός προσαρμοσμένων API

  • Άρθρο

Εξερχόμενο προσαρμοσμένο API

Ισχύοντα κανάλια: SMS, προσαρμοσμένο

Όταν δημιουργείτε ένα προσαρμοσμένο κανάλι στο Dynamics 365 Customer Insights - Journeys, πρέπει να ορίσετε ένα εξερχόμενο προσαρμοσμένο API για κλήση κατά τον χρόνο εκτέλεσης της διαδρομής. Το προσαρμοσμένο API είναι το σημείο εισόδου για εκτέλεση προσαρμοσμένου κώδικα. Καλεί τα API του παρόχου και πρέπει να αποδεχτεί τη σύμβαση που ορίζεται από το Customer Insights - Journeys και να επιστρέψει την απόκριση. Το εξερχόμενο προσαρμοσμένο API αντιστοιχίζεται στο χαρακτηριστικό msdyn_outboundendpointurltemplate κατά το βήμα ορισμού του καναλιού.

Η σύμβαση που πρέπει να υλοποιήσει το εξερχόμενο προσαρμοσμένο API πρέπει να έχει μία παράμετρο εισόδου (ωφέλιμο φορτίο) και ένα χαρακτηριστικό εξόδου (απόκριση).

  • Το ωφέλιμο φορτίο είναι ένα σειριοποιημένο JSON με την ακόλουθη σύμβαση:

    • ChannelDefinitionId: GUID – Το αναγνωριστικό ορισμού καναλιού.
    • RequestId: συμβολοσειρά – Το αναγνωριστικό αίτησης.
    • From: συμβολοσειρά – Ο αποστολέας (παρουσία καναλιού).
    • To: συμβολοσειρά - Ο παραλήπτης.
    • Μήνυμα: Λεξικό <συμβολοσειρά, συμβολοσειρά> - Περιέχει όλα τα τμήματα μηνυμάτων για ένα κανάλι. Τα πλήκτρα είναι τα ονόματα τμήματος μηνυμάτων, όπως οι τιμές του αντίστοιχου χαρακτηριστικού msdyn_name.
    • MarketingAppContext: αντικείμενο - Ένα αντικείμενο που αντιπροσωπεύει το περιβάλλον της υποβολής. Αυτό το αντικείμενο είναι διαθέσιμο μόνο όταν η υποβολή εκτελείται από την εφαρμογή Customer Insights - Journeys. Το αντικείμενο περιλαμβάνει τα ακόλουθα πεδία:
      • CustomerJourαid: συμβολοσειρά - Το αναγνωριστικό της διαδρομής πελάτη που προετοιμάζει την κλήση. Null, όταν η υποβολή ζητηθεί από μια δοκιμαστική αποστολή.
      • UserId: GUID - Αναγνωριστικό του χρήστη που λαμβάνει το μήνυμα. Null, όταν η υποβολή ζητηθεί από μια δοκιμαστική αποστολή.
      • UserEntityType: συμβολοσειρά - Τύπος οντότητας που αντιπροσωπεύει έναν χρήστη που λαμβάνει το μήνυμα. Null, όταν η υποβολή ζητηθεί από μια δοκιμαστική αποστολή.
      • IsTestSend: δυαδική τιμή - True, όταν η υποβολή είχε προετοιμαστεί από μια δοκιμαστική αποστολή, False άλλως.

  • Η απόκριση είναι ένα σειριοποιημένο JSON με την ακόλουθη σύμβαση:

    • ChannelDefinitionId: GUID – Το αναγνωριστικό ορισμού καναλιού.
    • MessageId: συμβολοσειρά - (Προαιρετικά) Το αναγνωριστικό μηνύματος. Προαιρετικά, μπορεί να υπάρχει στην απόκριση API ενός παρόχου.
    • RequestId: συμβολοσειρά – Το αναγνωριστικό αίτησης. Πρέπει να ισούται με την τιμή αναγνωριστικού αιτήματος εντός του ωφέλιμου φορτίου της αίτησης.
    • Κατάσταση: συμβολοσειρά – Οι πιθανές τιμές είναι:
      • NotSent – Έγινε προσπάθεια εκτέλεσης της υποβολής στον πάροχο, αλλά απορρίφθηκε χωρίς να υπάρχει δυνατότητα επανάληψης.
      • Sent – Η αίτηση υποβολής έγινε αποδεκτή με επιτυχία από τον πάροχο.

Προσαρμοσμένο API αναφοράς παράδοσης

Ισχύοντα κανάλια: SMS, προσαρμοσμένο

Αν το κανάλι σας υποστηρίζει αναφορές ή καταστάσεις παράδοσης για μηνύματα, πρέπει να ορίσετε ένα προσαρμοσμένο API αναφοράς παράδοσης. Το API σας καλείται από τον πάροχο και θα πρέπει να καλεί το API msdyn_D365ChannelsNotification της βασικής λύσης, που επιστρέφει τις πληροφορίες στο Dataverse. Αυτές οι πληροφορίες είναι διαθέσιμες στην Ανάλυση Customer Insights - Journeys.

Το προσαρμοσμένο API της αναφοράς παράδοσης καλεί το API του msdyn_D365ChannelsNotification με τη σύμβαση ως μία παράμετρο εισόδου:

  • το notificationPayLoad είναι ένα σειριοποιημένο JSON με την ακόλουθη σύμβαση:

    • ChannelDefinitionId: GUID – Το αναγνωριστικό ορισμού καναλιού.
    • RequestId: συμβολοσειρά – Το αναγνωριστικό αίτησης.
    • MessageId: συμβολοσειρά – Το αναγνωριστικό μηνύματος.
    • From: συμβολοσειρά – Ο αποστολέας (παρουσία καναλιού).
    • OrganizationId: συμβολοσειρά – Το αναγνωριστικό οργανισμού.
    • Status: συμβολοσειρά – Η κατάσταση της αναφοράς παράδοσης Οι πιθανές τιμές είναι:
      • Delivered – Το αποδεκτό μήνυμα είχε παραδοθεί με επιτυχία στον στόχο.
      • NotDelivered – Το αποδεκτό μήνυμα δεν είχε παραδοθεί με επιτυχία στον στόχο.

Εισερχόμενο προσαρμοσμένο API

Ισχύοντα κανάλια: SMS

Αν το κανάλι σας υποστηρίζει εισερχόμενες αιτήσεις, πρέπει να ορίσετε ένα εισερχόμενο προσαρμοσμένο API. Το API σας καλείται από τον πάροχο και θα πρέπει να καλεί το API msdyn_D365ChannelsInbound της βασικής λύσης, που επιστρέφει τις πληροφορίες στο Dataverse.

Το εισερχόμενο προσαρμοσμένο API καλεί το API του msdyn_D365ChannelsInbound με τη σύμβαση ως μία παράμετρο εισόδου:

  • Το inboundPayLoad είναι ένα σειριοποιημένο JSON με την ακόλουθη σύμβαση:

    • ChannelDefinitionId: GUID – Το αναγνωριστικό ορισμού καναλιού.
    • To: συμβολοσειρά - Ο αριθμός τηλεφώνου C1 (παρουσία καναλιού).
    • From: συμβολοσειρά - Σημείο επαφής χρήστη C2.
    • OrganizationId: συμβολοσειρά – Το αναγνωριστικό οργανισμού.
    • Μήνυμα: Λεξικό <συμβολοσειρά, συμβολοσειρά> - Περιέχει όλα τα τμήματα μηνυμάτων για ένα κανάλι.