API per numeri di telefono e documenti

Tramite API puoi implementare l'attivazione e la gestione dei numeri virtuali direttamente dalla tua interfaccia (o pannello di amministrazione), senza dover accedere all'area personale Zadarma.

Tutte le funzionalità e i metodi API di Zadarma.

Nella maggior parte dei paesi, per collegamento di un numero è richiesta l'identificazione dell'utente finale. Anche i documenti dell'utente possono essere caricati tramite API.

Funzionalità API:

• selezione e attivazione di numeri virtuali
• configurazione dei numeri già attivi
• gestione dei documenti per collegamento (informazioni sui requisiti di collegamento, caricamento dei documenti, verifica dei documenti già caricati per l'ordine di un numero specifico)

Sequenza di passaggi per il collegamento di un numero tramite API:

1. Ottenere l'elenco aggiornato dei paesi e delle destinazioni per l'ordine, per mostrarli all'utente;
2. Ottenere e visualizzare l'elenco dei numeri disponibili per l'ordine;
3. Creare un gruppo di documenti per l'utente (se non esiste già) e caricare i documenti (se richiesti);
4. Collegamento del numero selezionato al gruppo di documenti;
5. Instradare il numero su un login SIP o su un SIP URI (set_sip_id).

Attivazione di nuovi numeri

Il metodo GET /v1/direct_numbers/countries/ per ottenere l'elenco dei paesi in cui è possibile ordinare un numero. Se la richiesta viene inviata senza parametri, la risposta sarà nella lingua dell'area personale. Aggiungendo il parametro opzionale language è possibile ottenere la risposta in una delle lingue dell'area personale.

Il metodo GET /v1/direct_numbers/country/ er ottenere l'elenco dei paesi in cui è possibile ordinare un numero. Parametro obbligatorio country - codice ISO del Paese (ISO 3166-1 alpha-2); Parametri opzionali language e direction_id. La risposta conterrà un array di dati con la descrizione del numero: città, costo di attivazione, canone mensile, caratteristiche, possibilità di ricevere SMS, ecc.

Ottenere l'elenco dei numeri disponibili all'ordine, metodo GET /v1/direct_numbers/available/<DIRECTION_ID>/ con il parametro DIRECTION_ID - ID della destinazione; e mask - parametro opzionale per la ricerca di corrispondenze nei numeri.

È possibile ordinare un numero utilizzando il metodo POST /v1/direct_numbers/order/.

Un numero già collegato può essere rinnovato in anticipo per diversi mesi con il metodo POST /v1/direct_numbers/prolong/.

Parametri obbligatori della richiesta number e months

Gestione dei numeri collegati

Il metodo GET /v1/direct_numbers/ (senza parametri) restituisce un array con le informazioni sui numeri già collegati.

Con il metodo GET /v1/direct_numbers/number/ puoi ottenere informazioni su uno specifico numero collegato. La richiesta va inviata con i parametri type e number.

Lo stato del rinnovo automatico (se il numero verrà rinnovato automaticamente o disattivato alla scadenza) si può verificare con il metodo GET /v1/direct_numbers/autoprolongation/ usando i parametri di richiesta type e number .

Per modificare lo stato del rinnovo automatico, usa il metodo PUT /v1/direct_numbers/autoprolongation/ con i parametri di richiesta type, number e value.

Il metodo PUT /v1/direct_numbers/set_caller_name/ - Impostazione o attivazione il Nome del numero (lettere latine e cifre, max 30 caratteri) viene anche inviato nell'intestazione From in una chiamata in entrata come CALLERID(name).

Con il metodo PUT /v1/direct_numbers/set_sip_id/ è possibile deviare le chiamate dal numero virtuale verso un login SIP specifico, un server esterno via SIP URI oppure attivare la modalità di prova. Parametri obbligatori della richiesta type, number e sip_id - login sip o indirizzo del server esterno, per esempio 1234567890@myserver.com test_mode - opzionale, (on|off) - per attivare la modalità di prova.

Gestione dei documenti

Un gruppo di documenti contiene i dati della persona o dell'azienda che utilizzerà il numero virtuale, possono esistere più gruppi.

Creazione di un nuovo gruppo di documenti - metodo POST /v1/documents/groups/create/ .

È possibile aggiornare i dati in un gruppo di documenti già esistente utilizzando il metodo PUT /v1/documents/groups/update/<GROUPID>/.

Il caricamento di nuovi gruppi di documenti si effettua con il metodo POST /v1/documents/upload/ .

Con il metodo GET /v1/documents/groups/list/ è possibile ottenere l'elenco dei gruppi di documenti e con il metodo GET /v1/documents/groups/get/<ID>/, dove ID è l'identificatore del gruppo, 0 - gruppo di documenti principale, è possibile ottenere le informazioni su un determinato gruppo di documenti.

Il metodo GET /v1/documents/files restituisce l'elenco dei documenti/file precedentemente caricati nel gruppo di documenti. group_id - parametro opzionale, ID del gruppo di documenti (0 o, se non impostato, gruppo di documenti principale).

Verifica: il gruppo di documenti è utile o meno per il collegamento del numero di una determinata città/destinazione viene effettuato tramite il metodo GET /v1/documents/groups/valid/<ID>/.