Utilizzo di API basata su REST per integrare ICTBroadcast con l'applicazione di terze parti e automazione autodialer

Segue elenco di API forniamo per l'integrazione con applicazioni di terze parti per ottenere la completa automazione e la funzionalità senza soluzione di continuità.

REST API

REST API fornisce l'interfaccia esterna per richiamare alcune importanti funzioni di ICTBroadcast. ICTBroadcast definisce 3 classi API_User, API_contact e API_Campaign in REST API che definisce tutte le funzioni necessarie per essere accessibile dall'esterno del campo di applicazione. Di seguito è riportato il codice di esempio viene descritto come chiamare queste funzioni:

User_Create

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

Parametri

$user: array serializzato contenente i dati degli utenti

valore di ritorno

Matrice restituisce contenente i dati degli utenti in caso di successo. Altrimenti restituisce array contenente falso valore.

User_Update

Questa funzione aggiorna i dati dell'utente.

Parametri

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

$user: I dati degli utenti

Valore di ritorno

Restituisce JSON stringa codificata che contiene i dati degli utenti in caso di successo. Altrimenti restituisce array contenente falso valore.

User_Get

Questa funzione restituisce i dati degli utenti il cui ID viene fornito come argomento.

Parametri

$user_id: ID dell'utente

$search: Ricerche |
$ value: valore

Valore di ritorno

Restituisce JSON stringa codificata che contiene i dati degli utenti in caso di successo. Altrimenti restituisce array contenente falso valore.

User_Delete

Questa funzione elimina un utente il cui ID è fornito.

Parametri

$user_id: ID dell'utente

Valore di ritorno

Restituisce vero se cancellare successo altrimenti restituisce FALSE.

User_Extension_Create

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

Parametri

$user_id: ID dell'utente

$estensione: array contenente i dati per la nuova estensione

Valore di ritorno

Restituisce JSON stringa codificata che contiene i dati di estensione in caso di successo. Altrimenti restituisce array contenente falso valore.

User_Role_List

Questa funzione riporta tutti i ruoli disponibili.

Parametri

Nessuno

Valore di ritorno

Restituisce JSON stringa codificata che contiene i ruoli utente in caso di successo.

User_Payment_Create

Questa funzione aggiunge credito nell'account utente

Parametri

$user_id: ID dell'utente

$value: ammontare pagato per aggiungere

$description: Descrizione breve

$type: tipo di pagamento

Valore di ritorno

Restituisce true se aggiungi credito di successo in caso contrario restituisce false.

User_Login

Questa funzione registra in un utente.

Parametri

$session_id: ID di sessione

Valore di ritorno

Restituisce il nome della sessione in caso di successo in caso contrario restituisce false.

User_Logout

Questa funzione distrugge la sessione utente per effettuare il login farlo fuori.

Parametri

$session_id: ID di sessione

Valore di ritorno

Restituisce il nome della sessione in caso di successo in caso contrario restituisce false.

Campaign_Status

Questa funzione fornisce lo stato della campagna il cui ID è dato.

Parametri

$campaign_id: ID della campagna il cui status è richiesto

Valore di ritorno

Restituisce JSON stringa codificata contenente i dati di stato della campagna in caso di successo.

Campaign_Start

Questa funzione avvia una campagna il cui ID è dato.

Parametri

$campaign_id: ID della campagna

Valore di ritorno

Restituisce JSON stringa codificata contenente i dati di stato della campagna in caso di successo.

Campaign_Stop

Questa funzione arresta una campagna il cui ID è dato.

Parametri

$campaign_id: ID della campagna

Valore di ritorno

Restituisce JSON stringa codificata contenente i dati di stato della campagna in caso di successo.

Campaign_Contact_Create

Questa funzione aggiunge un dato di contatto che verrà composto dalla campagna il cui ID è dato.

Parametri

$contact_id: Array che contiene i dati di contatto che verrà creato ..

$campaign_id: ID della campagna

Valore di ritorno

Restituisce JSON stringa codificata che contiene i dati della campagna in caso di successo.

Campaign_Summary

Questa funzione restituisce il riassunto della campagna. Sarà lista di stato (occupato, congestione, non-risposta, non) di ogni contatto nella campagna.

Parametri

$campaign_id: ID della campagna il cui status è richiesto

$usr_id: ID dell'utente che possiede questa campagna

Valore di ritorno

Restituisce JSON stringa codificata che contiene 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 status è richiesto

$status: lo stato della campagna

$usr_id: ID dell'utente che possiede questa campagna

Valore di ritorno

Restituisce JSON stringa codificata che contiene i dati della campagna in caso di successo.

Contact_Create

Questa funzione crea un nuovo contatto nel gruppo specificato.

Parametri

$contact:. Array contenente i dati del contatto

$contact_group_id:. ID del gruppo di contatto

Valore di ritorno

Restituisce JSON codificato stringa di stato contenente del contatto in caso di successo.

Contact_Delete

Questa funzione rimuove un contatto il cui ID è dato.

Parametri

$contact_id:. ID del contatto per rimuovere

Valore di ritorno

Restituisce JSON codificato stringa di stato contenente del contatto in caso di successo.