Octapush Webhooks – Ενημέρωση εξωτερικών CRM/ERP συστημάτων με POST ή GET
Τα Webhooks είναι HTTP callbacks που μπορεί ο χρήστης να ορίσει στο Octapush με σκοπό την ενημέρωση εξωτερικών συστημάτων όπως CRM/ERP όταν η κατάσταση ενός μηνύματος αλλάζει.
Μπορείτε να τα βρείτε στην επιλογή Developers στο user menu που βρίσκεται πάνω δεξιά στην οθόνη.
To πλαίσιο για να ρυθμίσετε τα webhooks του λογαριασμού σας θα εμφανιστεί στο τέλος της οθόνης.
Σε περίπτωση που δεν βλέπετε το panel όπως φαίνεται στην παρακάτω εικόνα, τότε επικοινωνήστε με το τμήμα υποστήριξης για να ενεργοποιήσουμε τα webhooks στον λογαριασμό σας.
To Octapush θα στείλει ένα http callback κάθε φορά που ένα γεγονός για το οποίο έχετε ορίσει να λαμβάνετε ενημέρωση συμβαίνει. Έχετε την δυνατότητα να επιλέξετε μεταξύ POST ή GET και φυσικά κατά την κλήση μπορείτε να συμπεριλάβετε όλη την πληροφορία που έχει το Οctapush για αυτόν τον παραλήπτη στην συγκεκριμένη καμπάνια. Αυτό επιτυγχάνεται μέσα από τα tokens που βρίσκονται διαθέσιμα και μπορείτε να συμπεριλάβετε στο link σας.
Καταστάσεις μηνύματων
Όταν ένα μήνυμα αποσταλεί μέσα από το Octapush, μπορεί να έχει διάφορες καταστάσεις που μας περιγράφουν αν παραδόθηκε ή όχι και γιατί. Αν το status είναι τελικό, σημαίνει ότι για το μήνυμα αυτό δεν πρόκειται να λάβουμε άλλη ενημέρωση για την κατάσταση του, διαφορετικά το μήνυμα δεν έχει φτάσει στην τελική του κατάσταση και θα ακολουθήσουν και άλλες ενημερώσεις.
Ο παρακάτω πίνακας περιέχει όλα τα status που ένα SMS ή Viber μήνυμα μπορεί να πάρει καθώς και μια σύντομη επεξήγηση για το καθένα.
|
Status |
VIBER |
SMS |
Επεξήγηση |
Final |
|
Sent |
|
|
Το μήνυμα έχει αποσταλεί στο τελικό δίκτυο για παράδοση |
NO |
|
Pending |
|
|
Δεν είναι ακόμη γνωστή η κατάσταση του μηνύματος |
NO |
|
Submitted |
|
|
Το μήνυμα έχει δρομολογηθεί για αποστολή |
NO |
|
Scheduled |
|
|
Το μήνυμα έχει προγραμματιστεί για αποστολή σε ορισμένο χρόνο στο μέλλον |
NO |
|
Fallbacksms |
|
|
Το μήνυμα δεν παραδόθηκε μέσω του Viber καναλιού και έχει προωθηθεί για αποστολή μέσω του SMS καναλιού |
NO |
|
Not Delivered |
|
|
Το μήνυμα δεν παραδόθηκε |
YES |
|
Unknown |
|
|
Η αποστολή πήρε κάποιο άλλο status από αυτά που έχουμε καταχωρημένα |
YES |
|
Error |
|
|
Σφάλμα κατά την αποστολή |
YES |
|
Expired |
|
|
Το μήνυμα δεν παραδόθηκε στο χρονικό διάστημα που είχαμε θέσει κατά την δημιουργία της καμπάνιας |
YES |
|
Failed |
|
|
Η αποστολή του μηνύματος απέτυχε γιατί το υπόλοιπο που έχετε στον λογαριασμό σας δεν επαρκεί για την αποστολή |
YES |
|
Rejected |
|
|
Ένα μήνυμα γίνεται rejected όταν το σύστημα απορρίπτει την αποστολή. Έχει να κάνει με το routing. Δηλαδή είτε λάθος αριθμός, είτε δεν υποστηρίζεται ο τερματισμός σε αυτό το δίκτυο από τον λογαριασμό του πελάτη |
YES |
|
Canceled |
|
|
Η αποστολή του μηνύματος ακυρώθηκε |
YES |
|
Seen |
|
|
Ο παραλήπτης έχει δει το μήνυμα |
YES |
|
Clicked |
|
|
Ο παραλήπτης έχει πατήσει κάποιο link στο μήνυμα |
YES |
|
Blacklisted |
|
|
Ο αριθμός ανήκει στην blacklist |
YES |
|
Unsubscribed |
|
|
O παραλήπτης επέλεξε το Unsubscribed στο μήνυμα |
YES |
|
Blocked |
|
|
Έγινε block το Viber Sender Id από το οποίο παραλήφθηκε το μήνυμα |
YES |
Tokens
Τα βασικά tokens που παρέχει η πλατφόρμα είναι τα πεδία που υπάρχουν και στον τηλεφωνικό κατάλογο όπου αποθηκεύετε τις επαφές σας.
Αυτά είναι: Τηλεφωνικός Αριθμός, Όνομα, Επίθετο, Τίτλος, Option1, Option2.
Αν έχετε δημιουργήσει και δικά σας επιπλέον πεδία σε μια λίστα, όπως για παράδειγμα ένα δικό σας ID τότε και αυτό θα εμφανιστεί σαν token και θα μπορέσετε να το χρησιμοποιήσετε με τα webhooks που θα δημιουργήσετε.
Δημιουργία Webhook
Για να δημιουργήσετε ένα νέο Webhook, πρέπει αρχικά να επιλέξετε το κανάλι που σας ενδιαφέρει δηλαδή SMS ή Viber.
Κατόπιν πρέπει να κάνετε click στην επιλογή Edit στο κάτω μέρος της σελίδας και πλέον είστε έτοιμοι να ενεργοποιήσετε την αποστολή webhook για οποιοδήποτε από τα παρεχόμενα statuses των μηνυμάτων όπως φαίνεται παρακάτω.
Αν υποθέσουμε ότι θέλουμε να λάβουμε ενημέρωση σε ένα εξωτερικό σύστημα για ένα event που συμβαίνει στο Οctapush, θα πρέπει να ενεργοποιήσουμε τον διακόπτη στην αριστερή μεριά στο event που μας ενδιαφέρει και να ορίσουμε το URL που θέλουμε να λάβουμε το callback καθώς και τις μεταβλητές που θέλουμε να συμπεριληφθούν
Αν θέλουμε να χρησιμοποιήσουμε την μέθοδο GET για το status blacklisted τότε θα πρέπει να συμπληρώσουμε την φόρμα όπως φαίνεται παρακάτω.
Ενώ αν θέλουμε να χρησιμοποιήσουμε την μέθοδο POST για το status submitted θα πρέπει να χρησιμοποιήσουμε JSON format όπως φαίνεται παρακάτω.
Περισσότερες πληροφορίες για το JSON format μπορείτε να βρείτε στο παρακάτω link https://www.w3schools.com/whatis/whatis_json.asp