Di seguito è riportato un elenco di API che forniamo per l'integrazione con applicazioni di terze parti per ottenere la piena automazione e funzionalità senza soluzione di continuità.

API REST

Questa API REST fornisce un'interfaccia esterna per chiamare alcune importanti funzioni di ICTBroadcast. ICTBroadcast definisce 3 classi API_User, API_contact e API_Campaign nell'API REST che definisce tutte le funzioni necessarie per accedere dall'esterno dell'ambito dell'applicazione. Di seguito è riportato un esempio di codice che descrive come chiamare queste funzioni:

user_create

Questa funzione crea un nuovo utente in ICTBroadcast. Il codice seguente descrive come chiamare questa funzione.

parametri

$ user: array serializzato contenente dati utente

Valore di ritorno

Restituisce l'array contenente i dati dell'utente in caso di successo. Altrimenti restituisce un array contenente un valore falso.

User_Update

Questa funzione aggiorna i dati dell'utente.

parametri


$ user_id: ID dell'utente i cui dati devono essere aggiornati


$ user: dati dell'utente

Valore di ritorno


Restituisce la stringa codificata json contenente i dati utente in caso di successo. Altrimenti restituisce un array contenente un valore falso.

User_Get

Questa funzione restituisce i dati dell'utente il cui ID viene fornito come argomento.

parametri


$ user_id: ID dell'utente


$ search: cerca


$ value: valore

Valore di ritorno


Restituisce la stringa codificata json contenente i dati utente in caso di successo. Altrimenti restituisce un array contenente un valore falso.

User_Delete

Questa funzione elimina un utente il cui ID è fornito.

parametri


$ user_id: ID dell'utente

Valore di ritorno


Restituisce vero se l'eliminazione ha esito positivo, altrimenti restituisce falso.

User_Extension_Create

Questa funzione crea l'estensione per l'utente specificato.

parametri


$ user_id: ID dell'utente


$ extension: array contenente dati per la nuova estensione

Valore di ritorno


Restituisce la stringa codificata json contenente i dati dell'estensione se ha esito positivo. Altrimenti restituisce un array contenente un valore falso.

User_Role_List

Questa funzione restituisce tutti i ruoli disponibili.

parametri


Nessuna

Valore di ritorno


Restituisce la stringa codificata json contenente i ruoli utente in caso di successo.

User_Payment_Create

Questa funzione aggiunge credito nell'account utente

parametri


$ user_id: ID dell'utente


$ value: importo pagato da aggiungere


$ description: breve descrizione


$ type: tipo di pagamento

Valore di ritorno


Restituisce vero se aggiungi credito con successo altrimenti restituisce falso.

Login utente

Questa funzione accede a un utente.

parametri


$ session_id: ID sessione

Valore di ritorno


Restituisce il nome della sessione se eseguito correttamente restituisce false.

User_Logout

Questa funzione distrugge la sessione dell'utente per disconnetterlo.

parametri


$ session_id: ID sessione

Valore di ritorno


Restituisce il nome della sessione se eseguito correttamente restituisce false.

Campaign_Status

Questa funzione fornisce lo stato della campagna di cui viene fornito l'ID.

parametri


$ campaign_id: ID della campagna il cui stato è richiesto

Valore di ritorno


Restituisce la stringa codificata json contenente i dati sullo stato della campagna in caso di successo.

CAMPAIGN_START

Questa funzione avvia una campagna il cui ID viene fornito.

parametri


$ campaign_id: ID della campagna

Valore di ritorno


Restituisce la stringa codificata json contenente i dati sullo stato della campagna in caso di successo.

Campaign_Stop

Questa funzione interrompe una campagna il cui ID viene fornito.

parametri


$ campaign_id: ID della campagna

Valore di ritorno


Restituisce la stringa codificata json contenente i dati sullo stato della campagna in caso di successo.

Campaign_Contact_Create

Questa funzione aggiunge un determinato contatto che verrà composto dalla campagna il cui ID viene fornito.

parametri


$ contact_id: matrice contenente i dati di contatto che verranno creati.


$ campaign_id: ID della campagna

Valore di ritorno


Restituisce la stringa codificata json contenente i dati della campagna in caso di successo.

Campaign_Summary

Questa funzione restituisce il riepilogo della campagna. Elencherà lo stato (occupato, congestione, mancata risposta, errore) di ciascun contatto nella campagna.

parametri


$ campaign_id: ID della campagna il cui stato è richiesto


$ usr_id: ID dell'utente proprietario di questa campagna

Valore di ritorno


Restituisce la stringa codificata json contenente i dati della campagna in caso di successo.

Campaign_Result

Questa funzione aggiorna una campagna, il suo stato.

parametri


$ campaign_id: ID della campagna il cui stato è richiesto


$ status: stato della campagna


$ usr_id: ID dell'utente proprietario di questa campagna

Valore di ritorno


Restituisce la stringa codificata json contenente i dati della campagna in caso di successo.

Campaign_Filter

Questa funzione fornisce un filtro di ricerca per la ricerca di campagne.

parametri


$ search: matrice di query di ricerca per i dati della campagna.

Valore di ritorno


Restituisce la stringa codificata json contenente i dati della campagna in caso di successo.

Contact_Create

Questa funzione crea un nuovo contatto nel gruppo specificato.

parametri


$ contact: matrice contenente i dati di contatto.


$ contact_group_id: ID del gruppo di contatti.

Valore di ritorno


Restituisce la stringa codificata json contenente lo stato del contatto in caso di successo.

Contact_Delete

Questa funzione rimuove un contatto il cui ID viene fornito.

parametri


$ contact_id: ID del contatto da rimuovere.

Valore di ritorno


Restituisce la stringa codificata json contenente lo stato del contatto in caso di successo.

Ecco esempi di implementazioni di API REST ICTBroadcast

Integrazione ICTBroadcast con EspoCRM

Integrazione ICTBroadcast con VtigerRM

Fai clic qui per diventare un provider di servizi di telefonia Internet per avviare un'attività in proprio