Πριν ξεκινήσετε
Επιλέξτε μια περιοχή χρησιμοποιώντας το getareas. Αντιγράψτε το αναγνωριστικό της περιοχής από την απόκρισή του ή από το επιστρεφόμενο next_function. Για μια περιοχή στις ΗΠΑ ή στον Καναδά, χρησιμοποιήστε το getstates αν θέλετε να περιορίσετε τα αποτελέσματα σε μία πολιτεία ή επαρχία.
Ανάγνωση του αποτελέσματος
Ελέγξτε το status.code στο σώμα JSON, καθώς και την κατάσταση HTTP. Τα επιτυχή αποτελέσματα βρίσκονται στον πίνακα response. Η προεπιλεγμένη απόκριση είναι ταξινομημένη κατά όνομα. Η τιμή available είναι εκτίμηση και οι ενδείξεις του καταλόγου δεν υποκαθιστούν τον έλεγχο των πραγματικών δυνατοτήτων και των απαιτήσεων εγγραφής του επιλεγμένου αριθμού.
Επιλογή του επόμενου βήματος
Χρησιμοποιήστε ένα μη ομαδοποιημένο αποτέλεσμα. Όταν η τιμή returns_numbers είναι 1, το επιστρεφόμενο next_function παραπέμπει σε αναζήτηση αριθμών. Όταν η τιμή είναι 0, οι αριθμοί εκχωρούνται κατά την παραγγελία και η διαδρομή παραπέμπει σε λειτουργία παραγγελίας. Εξετάστε τη λειτουργία και τις απαιτήσεις της πριν στείλετε το αίτημα: ένα αίτημα παραγγελίας μπορεί να επιφέρει χρέωση στον λογαριασμό σας. Μην αποστέλλετε αυτόματα αιτήματα σε κάθε επιστρεφόμενη διαδρομή.
Εδώ δεν περιλαμβάνεται καμία τιμή. Εξετάστε τη σχετική προσφορά, τα απαιτούμενα έγγραφα και τις οδηγίες παραγγελίας πριν από την αγορά. Διατηρήστε τα επιστρεφόμενα αναγνωριστικά του μεμονωμένου προθέματος και της προσφοράς αντί να τα δημιουργείτε από ένα εμφανιζόμενο τηλεφωνικό πρόθεμα.
Προηγμένες επιλογές εμφάνισης
compact=1 επιστρέφει ένα δείγμα με τυχαία σειρά, με το πολύ 100 γραμμές, όχι μια σελίδα ενός μεγαλύτερου συνόλου αποτελεσμάτων. Η ομαδοποίηση δημιουργεί συγκεντρωτικές γραμμές και συνθετικά αναγνωριστικά· χρησιμοποιήστε μια συνήθη, μη ομαδοποιημένη απόκριση για να επιλέξετε ένα μεμονωμένο πρόθεμα. Μη χρησιμοποιείτε αποτελέσματα δειγματοληψίας ή ομαδοποίησης για να ισχυριστείτε ότι αποτυπώνουν το σύνολο του αποθέματος ή τις ακριβείς δυνατότητες.
Αίτημα
Χρησιμοποιήστε τα διαπιστευτήρια του ενεργοποιημένου λογαριασμού σας API μέσω HTTPS. Υποστηρίζονται ο έλεγχος ταυτότητας Basic και τα ενεργοποιημένα διακριτικά bearer του λογαριασμού API· ισχύουν οι περιορισμοί του λογαριασμού.
Χρησιμοποιήστε τη μέθοδο GET και στείλτε τις προαιρετικές παραμέτρους στη συμβολοσειρά ερωτήματος. Μη βασίζεστε στην εναλλακτική ανάγνωση παραμέτρων από το σώμα φόρμας.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
area_id | string | Ναι | Αντιγράψτε το αναγνωριστικό της περιοχής από το getareas ή από το πεδίο next_function της απόκρισής του. Αντιμετωπίστε το ως αδιαφανή τιμή· μην το δημιουργείτε μόνοι σας και μην εφαρμόζετε σε αυτό συνάρτηση κατακερματισμού. |
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
state | string | Όχι | Μόνο για περιοχές των US και CA. Χρησιμοποιήστε έναν κωδικό πολιτείας/επαρχίας από το getstates ή το πλήρες όνομά της. Οι κωδικοί δεν διακρίνουν πεζά από κεφαλαία· στα ονόματα αγνοούνται η διάκριση πεζών και κεφαλαίων και οι επαναλαμβανόμενοι χαρακτήρες κενού. Μια άλλη χώρα ή μια μη αναγνωρισμένη, μη κενή τιμή προκαλεί την επιστροφή σφάλματος API. |
compact | string | Όχι | Προαιρετική λειτουργία δειγματοληψίας: 1, true ή on. Τα αποτελέσματα εμφανίζονται με τυχαία σειρά, με το πολύ 100 γραμμές. Παραλείψτε αυτή την παράμετρο για να λάβετε πλήρη λίστα αποτελεσμάτων· αυτό το τελικό σημείο δεν διαθέτει μηχανισμό σελίδας/δείκτη συνέχειας. |
group | integer | Όχι | Προηγμένες συγκεντρωτικές προβολές: οι τιμές από 1 έως 6 συνδυάζουν γραμμές και επιστρέφουν προθέματα εμφάνισης με απόκρυψη ψηφίων. Τα UUID των ομάδων είναι συνθετικά και δεν μπορούν να χρησιμοποιηθούν εναλλακτικά με τα αναγνωριστικά μεμονωμένων προθεμάτων. Υποβάλετε ένα μη ομαδοποιημένο αίτημα πριν επιλέξετε πρόθεμα για αναζήτηση αριθμών ή παραγγελία. Παραλείψτε αυτή την παράμετρο για τη συνήθη ροή εργασίας. |
pid | string | Όχι | Προαιρετικός επιλογέας αποθέματος που παρέχεται από τη MultiTEL, σε αριθμητική μορφή ή στην υποστηριζόμενη δεκαεξαδική μορφή 32 χαρακτήρων. Παραλείψτε τον για τη συνήθη χρήση. Οι μη αναγνωρισμένες τιμές αγνοούνται χωρίς ειδοποίηση. Η τιμή δεν είναι τηλεφωνικό πρόθεμα ούτε αναγνωριστικό τιμολογιακού προγράμματος. |
Απόκριση
Η τυπική περιβάλλουσα δομή JSON status/response. Το status.results μετρά τις επιστρεφόμενες γραμμές, συμπεριλαμβανομένων αυτών που προκύπτουν από δειγματοληψία ή ομαδοποίηση. Το response περιέχει αντικείμενα προθεμάτων. Δεν επιστρέφονται πεδία τιμών. Στη συνήθη, μη ομαδοποιημένη απόκριση, το uuid είναι το αναγνωριστικό του προθέματος· τα area_uuid και country_uuid είναι επιστρεφόμενα αναγνωριστικά· τα prefix και name είναι πληροφορίες εμφάνισης· το available είναι εκτίμηση διαθεσιμότητας και όχι κράτηση· τα needs_registration και restrictions περιγράφουν πληροφορίες εγγραφής· τα sms_coverage, is_mobile και number_type είναι ενδείξεις του καταλόγου, όχι εγγύηση για κάποια συγκεκριμένη δυνατότητα ενός αριθμού. Το number_type μπορεί να είναι κενό ή να περιέχει κάποια άλλη συμβολοσειρά του καταλόγου, επομένως μην απαιτείτε ένα σταθερό σύνολο απαριθμημένων τιμών. Το state είναι συμβολοσειρά και μπορεί να είναι κενό ή να περιέχει μορφοποίηση του καταλόγου. Τα latitude και longitude μπορεί να είναι κενά. Τα metered και overflow είναι ενδείξεις του καταλόγου, όχι χρηματικά ποσά. Το returns_numbers επιλέγει μια διαδρομή εμφάνισης λίστας αριθμών (1) ή μια διαδρομή εκχώρησης κατά την παραγγελία (0). Το next_function προσδιορίζει αυτή την επόμενη διαδρομή. Οι ομαδοποιημένες αποκρίσεις περιέχουν επιπλέον συγχωνευμένα χαρακτηριστικά, συμπεριλαμβανομένων εναλλακτικών τιμών χαρακτηριστικών που χρησιμοποιούνται ελλείψει άλλων· μην τα ερμηνεύετε ως επαληθευμένες δυνατότητες κάθε αριθμού.
Ενδεικτική δομή απόκρισης· δεν πρόκειται για ζωντανά δεδομένα λογαριασμού ή τρέχουσα προσφορά.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}Σφάλματα
- 404: Invalid area ID: αποκτήστε ένα τρέχον αναγνωριστικό περιοχής μέσω της διαδικασίας αναζήτησης.
- 404: State filter is only available for US and CA: παραλείψτε το state για άλλες χώρες.
- 404: Invalid state: χρησιμοποιήστε μια πολιτεία/επαρχία που επιστρέφεται από το getstates για αυτή τη χώρα.
- 404: No prefixes found: δεν επιστράφηκαν αντίστοιχες γραμμές του καταλόγου. Αυτό δεν αποδεικνύει ότι ένας συγκεκριμένος αριθμός δεν μπορεί ποτέ να παραγγελθεί.
- 500: Σφάλμα: 'Failed loading prefixes': η αναζήτηση στον κατάλογο απέτυχε. Δοκιμάστε ξανά αργότερα και επικοινωνήστε με την υποστήριξη αν το πρόβλημα επιμένει.
Διαθεσιμότητα και παρενέργειες
- Αυτό είναι ένα βήμα αναζήτησης, όχι επιβεβαίωση παραγγελίας. Η διαθεσιμότητα μπορεί να ανανεώνεται μέσω πρόσθετων αναζητήσεων στον κατάλογο, οπότε ο χρόνος απόκρισης μπορεί να ποικίλλει.
- Δεν επιστρέφονται τιμές. Ανακτήστε την ισχύουσα προσφορά για τον αριθμό ή την παραγγελία και εξετάστε τις απαιτήσεις εγγραφής πριν υποβάλετε παραγγελία.
- Μην αντιμετωπίζετε το available ως ακριβή μέτρηση αποθέματος, το μηδέν ως καθολική απαγόρευση παραγγελίας ή μια επιτυχή αναζήτηση ως κράτηση. Η διαθεσιμότητα μπορεί να αλλάξει πριν από την παραγγελία.