Ορισμός προσαρμοσμένων API για κανάλι SMS

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

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

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

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

  • ChannelDefinitionId: GUID – Το αναγνωριστικό ορισμού καναλιού.
  • RequestId: string – Το αναγνωριστικό αίτησης.
  • Από: συμβολοσειρά – Ο αποστολέας (παρουσία καναλιού).
  • Προς: συμβολοσειρά – Ο παραλήπτης.
  • Μήνυμα: Συμβολοσειρά λεξικού <, συμβολοσειρά> - Περιέχει όλα τα τμήματα του μηνύματος για ένα κανάλι. Τα κλειδιά είναι τα ονόματα των τμημάτων μηνύματος, όπως οι τιμές του αντίστοιχου msdyn_name χαρακτηριστικού.

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

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

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

Εάν το κανάλι σας υποστηρίζει αναφορές παράδοσης μηνυμάτων ή καταστάσεις, ορίστε ένα προσαρμοσμένο API αναφοράς παράδοσης. Η υπηρεσία παροχής καλεί το API σας και πρέπει να καλέσει το msdyn_D365ChannelsNotification API της βασικής λύσης, το οποίο επιστρέφει τις πληροφορίες στο Dataverse. Το πρόγραμμα επεξεργασίας συνομιλίας πωλήσεων παρέχει πρόσβαση σε αυτές τις πληροφορίες.

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

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

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

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

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

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

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

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

Επόμενο βήμα

Ορισμός προσαρμοσμένου καναλιού SMS