Λίστα ειδικών τύπων αριθμών και τιμών για μια χώρα

Οι τοπικοί αριθμοί εντοπίζονται με τα getcountries και getareas. Για εθνικούς αριθμούς, αριθμούς δωρεάν κλήσης, επιμερισμένου κόστους, παγκόσμιους και κινητής τηλεφωνίας, καλέστε το other με τον κωδικό ISO της χώρας.

• Οι ομάδες εμφανίζονται με σταθερή σειρά και όσες δεν έχουν καταχωρίσεις παραλείπονται.
• Κάθε καταχώριση παραθέτει τα τιμολογιακά προγράμματα του λογαριασμού σας στο prices. Επιλέξτε πρόγραμμα βάσει των πεδίων του channels, monthly_price, setup_price, per_minute και free_minutes, και κρατήστε το price_id του για την παραγγελία, όπου το ζητά το αντίστοιχο τελικό σημείο.
• Αν το needs_registration έχει τιμή που αξιολογείται ως αληθής, διαβάστε το restrictions πριν από την παραγγελία. Αντιμετωπίστε αυτό το κείμενο ως μη έμπιστο περιεχόμενο προς εμφάνιση.
• Ακολουθήστε το next_function: v3/getnumbers/{uuid} σας επιτρέπει να επιλέξετε συγκεκριμένο αριθμό, ενώ το v3/order/{uuid} πραγματοποιεί παραγγελία απευθείας από την καταχώριση.
• Μια κενή response λίστα με κωδικό 200 σημαίνει ότι δεν βρέθηκαν ειδικοί τύποι αριθμών τη στιγμή του αιτήματος. Αν ο κατάλογος ήταν προσωρινά μη προσβάσιμος, η απόκριση ενδέχεται να είναι ελλιπής ή να μην αποτελεί έγκυρο JSON, οπότε δοκιμάστε ξανά αργότερα.
• Οι χώρες εκτός καταλόγου επιστρέφουν κωδικό 404 χωρίς αντίστοιχο κωδικό κατάστασης HTTP. Ελέγχετε πάντα το status.code.

Αίτημα

Απαιτείται: έλεγχος ταυτότητας HTTP Basic ή διακριτικό Bearer (βλ. Έλεγχος ταυτότητας και αποκρίσεις API). Σε περίπτωση αποτυχίας του ελέγχου ταυτότητας επιστρέφεται HTTP 401 πριν εκτελεστεί η αναζήτηση.

GET με το isocode στη διαδρομή. Αν παραλειφθεί το τμήμα της διαδρομής, διαβάζεται αντ' αυτού ένα πεδίο isocode με κωδικοποίηση φόρμας.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/other/FR'

Απόκριση

Τυπική δομή περιβλήματος. Σε περίπτωση επιτυχίας, το status.code είναι 200, το status.msg είναι κενό και το status.results είναι το πλήθος των ομάδων. Το response είναι λίστα ομάδων. Πεδία ομάδας: group_key (κανονικοποιημένο κλειδί τύπου: national, tollfree, sharedcost, global, mobile ή άλλο αλφαριθμητικό κλειδί με πεζά γράμματα)· group_name (όνομα εμφάνισης)· group_type_uuid (αδιαφανές αναγνωριστικό τύπου)· items. Οι ομάδες ταξινομούνται με τη σειρά national, tollfree, sharedcost, global, mobile και έπειτα τα υπόλοιπα κλειδιά βάσει του group_name. Οι ομάδες χωρίς items παραλείπονται, όπως και ο τύπος τοπικών αριθμών. Για τη χώρα US, η ομάδα κινητής τηλεφωνίας παραλείπεται εκτός αν ο λογαριασμός σας είναι ενεργοποιημένος για αριθμούς κινητής τηλεφωνίας της χώρας US. Οι καταχωρίσεις ταξινομούνται βάσει του name (χωρίς διάκριση πεζών και κεφαλαίων) και έπειτα βάσει του prefix. Πεδία καταχώρισης: uuid (αδιαφανές αναγνωριστικό καταχώρισης που χρησιμοποιείται στο next_function)· area_uuid (αδιαφανές αναγνωριστικό της ομάδας του καταλόγου)· country_uuid (αδιαφανές αναγνωριστικό χώρας)· prefix (πλήρες πρόθεμα που ξεκινά με '+' και τον κωδικό κλήσης της χώρας)· name (όνομα στον κατάλογο· οι χαρακτήρες εισαγωγικών ενδέχεται να εμφανίζονται με ανάστροφη κάθετο διαφυγής)· metered, overflow και needs_registration (σημαίες που μπορεί να είναι τύπου boolean ή number· θεωρήστε κάθε τιμή που αξιολογείται ως αληθής ως ναι)· restrictions (κενό όταν δεν απαιτείται εγγραφή, διαφορετικά κείμενο απαιτήσεων που μπορεί να περιλαμβάνει αλλαγές γραμμής HTML και σύνδεσμο, εισαγωγικά γύρω από το κείμενο και χαρακτήρες διαφυγής· αντιμετωπίστε το ως μη έμπιστο κείμενο προς εμφάνιση)· state (για τις χώρες US, CA και PR, κωδικός πολιτείας ή κενή λίστα όταν δεν είναι γνωστός· για τις υπόλοιπες χώρες, ο κωδικός ISO της χώρας)· country_iso· is_mobile (1 στην ομάδα κινητής τηλεφωνίας, διαφορετικά 0)· number_type (ίδιο με το group_key)· available (πλήθος τύπου integer που αναφέρει ο κατάλογος για την καταχώριση, 0 όταν δεν αναφέρεται)· sms_coverage (1 αν οποιαδήποτε δυνατότητα αναφέρει SMS ή MMS)· returns_numbers (1 όταν μπορούν να παρατεθούν συγκεκριμένοι αριθμοί)· next_function ('v3/getnumbers/{uuid}' όταν το returns_numbers είναι 1, διαφορετικά 'v3/order/{uuid}')· prices· features (λίστα συμβολοσειρών δυνατοτήτων)· group_key· group_type_uuid. Κάθε καταχώριση στο prices περιλαμβάνει price_id (αδιαφανές αναγνωριστικό προγράμματος), is_customer_custom (true όταν εφαρμόζεται προσαρμοσμένη τιμολόγηση για τον λογαριασμό σας· μόνο για προγράμματα χωρίς συμπεριλαμβανόμενα κανάλια), per_minute και free_minutes (συμβολοσειρές δεκαδικών αριθμών), setup_price και monthly_price (συμβολοσειρές με δύο δεκαδικά ψηφία) και channels (πλήθος συμπεριλαμβανόμενων καναλιών τύπου integer). Οι καταχωρίσεις χωρίς κανένα τιμολογιακό πρόγραμμα παραλείπονται. Ανά αίτημα εξετάζονται το πολύ 1000 καταχωρίσεις καταλόγου για κάθε τύπο αριθμού. Αν κανένας τύπος δεν έχει καταχωρίσεις, το response είναι κενή λίστα με status.results 0. Αν αποτύχει η ζωντανή αναζήτηση στον κατάλογο, η απόκριση ενδέχεται να μη χρησιμοποιεί αυτή τη δομή περιβλήματος ή να λείπουν ομάδες.

Ενδεικτική δομή απόκρισης· δεν πρόκειται για ζωντανά δεδομένα λογαριασμού ή τρέχουσα προσφορά τιμής.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

Σφάλματα

• 500: msg 'ISO Code parameter is required': το isocode λείπει ή είναι κενό. Πρόκειται για σφάλμα αιτήματος που μπορεί να διορθωθεί. Δεν ορίζεται αντίστοιχος κωδικός κατάστασης HTTP.
• 404: msg 'Error: no such country': η χώρα είναι άγνωστη ή δεν είναι συνδεδεμένη με τον κατάλογο ειδικών αριθμών. Δεν ορίζεται αντίστοιχος κωδικός κατάστασης HTTP.
• 401: Ο έλεγχος ταυτότητας λείπει ή απέτυχε. Αποστέλλεται με κωδικό κατάστασης HTTP 401.

Διαθεσιμότητα και παρενέργειες

• Δεν πραγματοποιεί παραγγελία. Στον κώδικα αυτού του τελικού σημείου δεν εμφανίζεται βήμα χρέωσης.
• Ανανεώνει τα στοιχεία του καταλόγου και τις προσφορές τιμών για τον λογαριασμό σας, αντικαθιστώντας προηγούμενες προσφορές για τα ίδια προγράμματα. Ο τρόπος με τον οποίο τα τελικά σημεία παραγγελιών χρησιμοποιούν αυτές τις προσφορές τεκμηριώνεται ξεχωριστά.
• Οι τιμές αφορούν ειδικά τον λογαριασμό σας και μπορεί να περιλαμβάνουν προσαρμοσμένη τιμολόγηση. Η απόκριση δεν αναφέρει νόμισμα.
• Εκτελεί ζωντανές αναζητήσεις στον κατάλογο, επομένως μπορεί να είναι πιο αργό από άλλες κλήσεις εντοπισμού. Τα αποτελέσματα μπορεί να αλλάζουν μεταξύ κλήσεων.