Προετοιμασία του αποθηκευμένου προφίλ και του αριθμού
Χρησιμοποιήστε αυτή τη διαδικασία για να συσχετίσετε ένα αποθηκευμένο προφίλ εγγραφής με έναν αγορασμένο αριθμό και, για τους αριθμούς που διαχειρίζονται μέσω τηλεπικοινωνιακού παρόχου και υποστηρίζουν αυτή τη δυνατότητα, να ζητήσετε έλεγχο εγγραφής. Δεν πρόκειται για γενικό API ενεργοποίησης για κάθε προμηθευτή αριθμών. Η επιτυχία ενός αιτήματος δεν αποδεικνύει ότι τα έγγραφα έχουν εγκριθεί ή ότι ο αριθμός είναι ενεργός.
Χρησιμοποιήστε έναν ενεργοποιημένο λογαριασμό API της MultiTEL μέσω HTTPS, με τα διαπιστευτήρια και τους περιορισμούς IP που έχουν ρυθμιστεί για αυτόν. Τόσο το προφίλ που δεν έχει διαγραφεί όσο και ο αγορασμένος αριθμός που δεν έχει ακυρωθεί πρέπει να ανήκουν στον λογαριασμό σας.
- Δημιουργήστε ένα προφίλ εγγραφής ή επιλέξτε ένα υπάρχον. Διατηρήστε το uuid του τοπικού προφίλ από το create_document· το get_document επιστρέφει την ίδια τοπική αναφορά ως id.
- Για υποβολή μέσω τηλεπικοινωνιακού παρόχου, το προφίλ πρέπει να διαθέτει τις αποθηκευμένες αναφορές ταυτότητας και διεύθυνσης. Επισυνάψτε τα απαιτούμενα αποδεικτικά και συνοδευτικά έγγραφα μέσω των αντίστοιχων διαδικασιών πριν από την υποβολή.
- Ελέγξτε ότι ο αριθμός και το προφίλ πληρούν τις απαιτήσεις που ισχύουν για τη χώρα και τον αριθμό. Μην θεωρείτε ότι ένα αποθηκευμένο προφίλ έχει εγκριθεί για κάθε αριθμό.
Υποβολή της συσχέτισης
curl --silent --show-error --request POST \
--user "$API_USER:$API_PASSWORD" \
--form-string document_uuid="$PROFILE_UUID" \
--form-string service_description="Example customer support line" \
https://api.multitel.net/v3/number_identity/12125550123Η διαδρομή περιέχει τον αγορασμένο αριθμό τηλεφώνου, όχι το UUID του, έναν εσωτερικό αριθμό PBX ή ένα αναγνωριστικό ταυτότητας. Ο χειριστής αφαιρεί από τον αριθμό τους χαρακτήρες που δεν είναι ψηφία. Χρησιμοποιήστε τον πλήρη διεθνή αριθμό με τον κωδικό χώρας. Το παράδειγμα είναι πλασματικό και πρέπει να αντικατασταθεί με τον δικό σας αριθμό και την αναφορά του αποθηκευμένου τοπικού προφίλ σας.
| Πεδίο | Υποχρεωτικό | Σημασία |
|---|---|---|
document_uuid | Ναι | Το ακριβές uuid του αποθηκευμένου τοπικού προφίλ. Μην χρησιμοποιείτε στη θέση του τα καλυμμένα απομακρυσμένα αναγνωριστικά identity_id ή address_id, ένα αναγνωριστικό μεταφόρτωσης ή μια επιστρεφόμενη τιμή registration_details_id. |
service_description | Όχι | Περιγραφή της προβλεπόμενης υπηρεσίας, η οποία προωθείται για επαλήθευση μέσω τηλεπικοινωνιακού παρόχου. Τα κενά στην αρχή και στο τέλος αφαιρούνται. |
onetime_files | Εξαρτάται από τη διαδικασία | Πίνακας που γίνεται αποδεκτός για έγγραφα μίας χρήσης του τηλεπικοινωνιακού παρόχου. Ο τρέχων χειριστής αφαιρεί τα κενά στην αρχή και στο τέλος των συμβολοσειρών του και τις προωθεί χωρίς να επιλύει τις τοπικές αναφορές μεταφορτώσεων. Η συμβατότητα με τα καλυμμένα αναγνωριστικά που επιστρέφει το create_encrypt_files δεν έχει τεκμηριωθεί· πριν χρησιμοποιήσετε αυτό το πεδίο, δείτε παρακάτω τον περιορισμό για τα έγγραφα μίας χρήσης. |
Στα αιτήματα πολλαπλών τμημάτων, ένας πίνακας χρησιμοποιεί επαναλαμβανόμενα πεδία onetime_files[]. Γίνεται επίσης αποδεκτό αίτημα JSON με Content-Type: application/json· οι ιδιότητές του συγχωνεύονται στα δεδομένα της φόρμας. Μπορεί να δοθεί πεδίο number στα δεδομένα του αιτήματος όταν παραλείπεται ο αριθμός από τη διαδρομή. Προτιμήστε τη ρητή διαδρομή που εμφανίζεται παραπάνω για να αποφύγετε ασάφειες.
Διάκριση της συσχέτισης από την έγκριση
Διαβάστε τόσο το αποτέλεσμα HTTP όσο και το πεδίο status.code του JSON. Σφάλματα JSON μπορεί να ληφθούν με HTTP 200. Μια επιτυχής υποβολή μέσω τηλεπικοινωνιακού παρόχου αναφέρει Address verification task created; awaiting carrier review. Αυτό το παράδειγμα χρησιμοποιεί πλασματικές αναφορές.
{
"status": {
"code": 200,
"msg": "Address verification task created; awaiting carrier review."
},
"response": {
"number": "+12125550123",
"did_id": "11111111111111111111111111111111",
"document_uuid": "0123456789abcdef0123456789abcdef",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"address_verification_id": "44444444444444444444444444444444",
"verification_status": "pending",
"verification_reference": null,
"requirement_id": "55555555555555555555555555555555",
"registration_details_id": "8516ac99dc60603295de7bdb6a153530"
}
}Τα αναγνωριστικά που σχετίζονται με τον προμηθευτή είναι καλυμμένες αναφορές, όχι αναγνωριστικά τοπικών προφίλ που μπορούν να χρησιμοποιηθούν εναλλακτικά. Το document_uuid παραμένει η αναφορά του τοπικού προφίλ που υποβάλατε. Στη διαδρομή αυτού του χειριστή που περνά μέσω τηλεπικοινωνιακού παρόχου, το registration_details_id είναι ένα επιπλέον αποτέλεσμα κατακερματισμού αυτής της τοπικής αναφοράς· μην το χρησιμοποιείτε στη θέση του document_uuid σε μεταγενέστερα αιτήματα προφίλ ή υποβολής.
Ορισμένοι εκχωρημένοι αριθμοί χρησιμοποιούν τοπική συσχέτιση ταυτότητας αντί για δημιουργία επαλήθευσης στον τηλεπικοινωνιακό πάροχο. Το επιτυχές αποτέλεσμά τους είναι Identity associated. με κενό πίνακα response. Αυτό δεν δημιουργεί εργασία ελέγχου στον τηλεπικοινωνιακό πάροχο ούτε τεκμηριώνει έγκριση. Η πύλη διαθέτει νεότερη διαδικασία συσχέτισης, της οποίας ο χειρισμός των προμηθευτών και οι έλεγχοι επαναλαμβανόμενης υποβολής διαφέρουν από εκείνους αυτού του τελικού σημείου.
Χειρισμός σφαλμάτων χωρίς δημιουργία διπλότυπων εργασιών
Ο κωδικός API 400 καλύπτει την απουσία αριθμού ή αναφοράς προφίλ. Ο κωδικός 404 καλύπτει προφίλ ή αριθμό που δεν είναι διαθέσιμος για τον λογαριασμό ή αριθμό που απουσιάζει από το απόθεμα του τηλεπικοινωνιακού παρόχου. Ο κωδικός 422 μπορεί να αναφέρει ελλείπουσες αναφορές ταυτότητας ή διεύθυνσης, απαιτήσεις του πωλητή ή απόρριψη κατά την επικύρωση από τον τηλεπικοινωνιακό πάροχο. Η απουσία ρύθμισης επανάκλησης μπορεί να προκαλέσει 503 και μια αποτυχία μεταφοράς κατά τη δημιουργία μπορεί να προκαλέσει 502. Διαβάστε το μήνυμα και τυχόν requirement_diagnostics αντί να αντιμετωπίζετε κάθε αποτυχία με τον ίδιο τρόπο.
Η διαδρομή μέσω τηλεπικοινωνιακού παρόχου μπορεί να ενημερώσει τις τοπικές ενδείξεις εκκρεμούς εγγραφής πριν ολοκληρωθούν η επικύρωση απαιτήσεων, οι έλεγχοι ρύθμισης επανάκλησης ή η δημιουργία εργασίας. Επομένως, ένα σφάλμα δεν συνεπάγεται ότι η τοπική κατάσταση παραμένει αμετάβλητη, και μια ένδειξη εκκρεμότητας από μόνη της δεν αποδεικνύει ότι υπάρχει εργασία. Μην χρησιμοποιείτε αυτές τις ενδείξεις ως επιβεβαίωση έγκρισης ή παράδοσης του αιτήματος.
Ο προμηθευτής μπορεί να αποδεχτεί μια εργασία ακόμη και αν αποτύχει μια μεταγενέστερη λειτουργία στην τοπική βάση δεδομένων, και αυτή η βοηθητική συνάρτηση δεν ελέγχει το αποτέλεσμα κάθε τοπικής εγγραφής πριν αναφέρει επιτυχία. Αυτός ο χειριστής δεν διαθέτει παράμετρο ιδιοδυναμίας του πελάτη ούτε μηχανισμό αποτροπής διπλότυπων υποβολών. Μετά από λήξη χρονικού ορίου, σφάλμα ή αβέβαιο αποτέλεσμα, ελέγξτε το ιστορικό εγγραφής του αριθμού στην πύλη ή επικοινωνήστε με την υποστήριξη πριν υποβάλετε ξανά. Η απουσία τοπικής εγγραφής δεν αποδεικνύει από μόνη της ότι ο προμηθευτής δεν έλαβε τίποτα.
Περιορισμός για τα έγγραφα μίας χρήσης
Ο χειριστής δέχεται το onetime_files και προωθεί κάθε μη κενή συμβολοσειρά στη σχέση κρυπτογραφημένων αρχείων του τηλεπικοινωνιακού παρόχου. Δεν αναζητά τις εγγραφές μεταφορτώσεων του λογαριασμού στον οποίο ανήκουν ούτε μετατρέπει εξωτερικά καλυμμένα αναγνωριστικά μεταφορτώσεων σε αναγνωριστικά αρχείων του προμηθευτή. Ο έλεγχος εκτός σύνδεσης επαλήθευσε τη συμπεριφορά προώθησης, όχι την επιτυχή επισύναψη στον τηλεπικοινωνιακό πάροχο.
Μην θεωρείτε ότι ένα αναγνωριστικό αρχείου από το create_encrypt_files μπορεί να αντιγραφεί σε αυτό το πεδίο για να ολοκληρωθεί μια διαδικασία συμφωνίας μίας χρήσης. Όταν ένας αριθμός απαιτεί αυτά τα έγγραφα, χρησιμοποιήστε την πύλη ή επιβεβαιώστε με τη MultiTEL την υποστηριζόμενη διαδικασία χρήσης αναγνωριστικών. Αυτό παραμένει ανεπίλυτο μέρος του ελέγχου του API και δεν αποτελεί παράδειγμα επαληθευμένο από την αρχή έως το τέλος.
Προστασία των πληροφοριών εγγραφής
Υποβάλετε μόνο πληροφορίες και έγγραφα που έχετε εξουσιοδότηση να χρησιμοποιήσετε για τον αριθμό. Διατηρείτε τις αναφορές προφίλ και επαλήθευσης συσχετισμένες με τον σωστό λογαριασμό και αποφεύγετε την καταχώριση του πλήρους περιεχομένου των αιτημάτων εγγραφής στα αρχεία καταγραφής. Αυτό το αίτημα δεν διαγράφει ούτε αντικαθιστά όλα τα προηγούμενα αποδεικτικά ή όλες τις προηγούμενες επαληθεύσεις. Ο έλεγχος από τον τηλεπικοινωνιακό πάροχο, η ενεργοποίηση και η διατήρηση δεδομένων είναι ξεχωριστές διαδικασίες.