Elenca i tipi di numeri speciali e i prezzi per un paese

I numeri locali si individuano con getcountries e getareas. Per i numeri nazionali, verdi, a costo condiviso, globali e mobili, chiama other con il codice ISO del paese.

• I gruppi compaiono in un ordine fisso e quelli senza voci vengono omessi.
• Ogni voce elenca i piani tariffari del tuo account in prices. Scegli un piano in base ai suoi valori di channels, monthly_price, setup_price, per_minute e free_minutes, e conserva il relativo price_id per effettuare l'ordine quando l'endpoint lo richiede.
• Se needs_registration ha un valore valutato come vero, leggi restrictions prima di effettuare l'ordine. Tratta quel testo come contenuto non attendibile da visualizzare.
• Segui next_function: v3/getnumbers/{uuid} consente di scegliere un numero specifico, mentre v3/order/{uuid} effettua l'ordine direttamente dalla voce.
• Un elenco response vuoto con codice 200 indica che al momento della richiesta non è stato trovato alcun tipo di numero speciale. Se il catalogo era temporaneamente irraggiungibile, la risposta può essere incompleta o non essere JSON valido; riprova quindi più tardi.
• I paesi non presenti nel catalogo restituiscono il codice 404 senza uno stato HTTP corrispondente. Controlla sempre status.code.

Richiesta

Obbligatorio: autenticazione HTTP Basic o token Bearer (vedi Autenticazione e risposte API). In caso di autenticazione non riuscita, viene restituita una risposta HTTP 401 prima che venga eseguita la ricerca.

GET con isocode nel percorso. Se il segmento del percorso viene omesso, viene invece letto un campo isocode codificato come dati di modulo.

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

Risposta

Struttura standard della risposta. In caso di esito positivo, status.code è 200, status.msg è vuoto e status.results è il numero di gruppi. response è un elenco di gruppi. Campi del gruppo: group_key (chiave normalizzata del tipo: national, tollfree, sharedcost, global, mobile o un'altra chiave alfanumerica in minuscolo); group_name (nome visualizzato); group_type_uuid (identificatore opaco del tipo); items. I gruppi sono ordinati come segue: national, tollfree, sharedcost, global, mobile, quindi le altre chiavi in base a group_name. I gruppi senza items vengono omessi, così come il tipo locale. Per US, il gruppo dei numeri mobili viene omesso a meno che il tuo account non sia abilitato ai numeri mobili di US. Le voci sono ordinate per name (senza distinzione tra maiuscole e minuscole), quindi per prefix. Campi della voce: uuid (identificatore opaco della voce usato in next_function); area_uuid (identificatore opaco del gruppo del catalogo); country_uuid (identificatore opaco del paese); prefix (prefisso completo che inizia con '+' e il prefisso telefonico internazionale del paese); name (nome nel catalogo; i caratteri delle virgolette possono essere preceduti da una barra inversa di escape); metered, overflow e needs_registration (indicatori che possono essere di tipo boolean o number; considera come sì qualsiasi valore valutato come vero); restrictions (vuoto quando non è richiesta la registrazione, altrimenti testo dei requisiti che può includere interruzioni di riga HTML e un collegamento, virgolette iniziali e finali e caratteri con escape; trattalo come testo non attendibile da visualizzare); state (per US, CA e PR, un codice di stato oppure un elenco vuoto quando non è noto alcun codice; per gli altri paesi, il codice ISO del paese); country_iso; is_mobile (1 nel gruppo dei numeri mobili, altrimenti 0); number_type (uguale a group_key); available (conteggio di tipo integer riportato dal catalogo per la voce, 0 quando non è riportato); sms_coverage (1 se una qualsiasi funzionalità menziona SMS o MMS); returns_numbers (1 quando è possibile elencare numeri specifici); next_function ('v3/getnumbers/{uuid}' quando returns_numbers è 1, altrimenti 'v3/order/{uuid}'); prices; features (elenco di stringhe che descrivono le funzionalità); group_key; group_type_uuid. Ogni voce di prices contiene price_id (identificatore opaco del piano), is_customer_custom (true quando si applicano tariffe personalizzate per il tuo account; solo per i piani senza canali inclusi), per_minute e free_minutes (stringhe decimali), setup_price e monthly_price (stringhe con due cifre decimali) e channels (numero di tipo integer dei canali inclusi). Le voci prive di qualsiasi piano tariffario vengono omesse. Per ogni richiesta vengono considerate al massimo 1000 voci del catalogo per tipo di numero. Se nessun tipo contiene voci, response è un elenco vuoto con status.results pari a 0. Se la ricerca in tempo reale nel catalogo non riesce, la risposta potrebbe non usare questa struttura oppure potrebbero mancare dei gruppi.

Struttura della risposta a scopo illustrativo; non si tratta di dati dell'account in tempo reale né di un preventivo attuale.

{
  "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"
        }
      ]
    }
  ]
}

Errori

• 500: msg 'ISO Code parameter is required': isocode è mancante o vuoto. Si tratta di un errore della richiesta che può essere corretto. Non viene impostato uno stato HTTP corrispondente.
• 404: msg 'Error: no such country': il paese è sconosciuto o non è collegato al catalogo dei numeri speciali. Non viene impostato uno stato HTTP corrispondente.
• 401: autenticazione mancante o non riuscita. Inviato con stato HTTP 401.

Disponibilità ed effetti collaterali

• Non effettua alcun ordine. Nel codice di questo endpoint non compare alcuna fase di addebito.
• Aggiorna i dettagli del catalogo e i preventivi per il tuo account, sostituendo i preventivi precedenti per gli stessi piani. Il modo in cui gli endpoint di ordinazione utilizzano questi preventivi è documentato separatamente.
• I prezzi sono specifici per il tuo account e possono includere tariffe personalizzate. La risposta non indica una valuta.
• Esegue ricerche in tempo reale nel catalogo, quindi può essere più lento di altre chiamate di individuazione. I risultati possono cambiare da una chiamata all'altra.