Voici la liste des API que nous fournissons pour intégrer avec une application tierce afin d'obtenir une automatisation complète et une fonctionnalité transparente.

API REST

L'ensemble Elégante composé API REST fournit une interface externe pour appeler certaines fonctions importantes de ICTBroadcast. ICTBroadcast définit 3 classes API_User, API_contact et API_Campaign dans l'API REST qui définit toutes les fonctions nécessaires pour être accédées depuis l'extérieur de la portée de l'application. L'exemple de code suivant décrit comment appeler ces fonctions:

User_Create

Cette fonction crée un nouvel utilisateur dans ICTBroadcast. Le code suivant décrit comment appeler cette fonction.

Paramètres

$ user: tableau sérialisé contenant des données utilisateur

Valeur de retour

Renvoie un tableau contenant des données utilisateur en cas de succès. Sinon, renvoie un tableau contenant une valeur fausse.

User_Update

Cette fonction met à jour les données utilisateur.

Paramètres


$ user_id: ID de l'utilisateur dont les données doivent être mises à jour


$ user: données de l'utilisateur

Valeur de retour


Retourne une chaîne codée json contenant des données utilisateur en cas de succès. Sinon, renvoie un tableau contenant une valeur fausse.

User_Get

Cette fonction renvoie les données de l'utilisateur dont l'ID est fourni en argument.

Paramètres


$ user_id: ID de l'utilisateur


$ search: recherche


$ value: valeur

Valeur de retour


Retourne une chaîne codée json contenant des données utilisateur en cas de succès. Sinon, renvoie un tableau contenant une valeur fausse.

User_Delete

Cette fonction supprime un utilisateur dont l'ID est fourni.

Paramètres


$ user_id: ID de l'utilisateur

Valeur de retour


Renvoie vrai si la suppression a réussi sinon renvoie faux.

User_Extension_Create

Cette fonction crée une extension pour l'utilisateur donné.

Paramètres


$ user_id: ID de l'utilisateur


$ extension: tableau contenant des données pour la nouvelle extension

Valeur de retour


Renvoie une chaîne codée json contenant des données d'extension en cas de succès. Sinon, renvoie un tableau contenant une valeur fausse.

User_Role_List

Cette fonction renvoie tous les rôles disponibles.

Paramètres


Aucun

Valeur de retour


Renvoie une chaîne codée json contenant des rôles utilisateur en cas de succès.

User_Payment_Create

Cette fonction ajoute du crédit dans le compte utilisateur

Paramètres


$ user_id: ID de l'utilisateur


$ value: montant payé à ajouter


$ description: brève description


$ type: type de paiement

Valeur de retour


Renvoie vrai si l'ajout de crédit est réussi sinon renvoie faux.

Utilisateur en ligne

Cette fonction connecte un utilisateur.

Paramètres


$ session_id: ID de session

Valeur de retour


Renvoie le nom de la session en cas de succès sinon renvoie false.

User_Logout

Cette fonction détruit la session utilisateur afin de le déconnecter.

Paramètres


$ session_id: ID de session

Valeur de retour


Renvoie le nom de la session en cas de succès sinon renvoie false.

Campaign_Status

Cette fonction donne le statut de la campagne dont l'ID est donné.

Paramètres


$ campaign_id: ID de la campagne dont le statut est obligatoire

Valeur de retour


Renvoie une chaîne codée json contenant les données d'état de la campagne en cas de succès.

Campaign_Start

Cette fonction démarre une campagne dont l'ID est donné.

Paramètres


$ campaign_id: ID de la campagne

Valeur de retour


Renvoie une chaîne codée json contenant les données d'état de la campagne en cas de succès.

Campaign_Stop

Cette fonction arrête une campagne dont l'ID est donné.

Paramètres


$ campaign_id: ID de la campagne

Valeur de retour


Renvoie une chaîne codée json contenant les données d'état de la campagne en cas de succès.

Campaign_Contact_Create

Cette fonction ajoute un contact donné qui sera composé par la campagne dont l'ID est donné.

Paramètres


$ contact_id: tableau contenant les données de contact qui seront créées.


$ campaign_id: ID de la campagne

Valeur de retour


Renvoie une chaîne codée json contenant les données de campagne en cas de succès.

Campaign_Summary

Cette fonction renvoie le résumé de la campagne. Il répertorie l'état (occupé, congestion, absence de réponse, échec) de chaque contact dans la campagne.

Paramètres


$ campaign_id: ID de la campagne dont le statut est obligatoire


$ usr_id: identifiant de l'utilisateur propriétaire de cette campagne

Valeur de retour


Renvoie une chaîne codée json contenant les données de campagne en cas de succès.

Campaign_Result

Cette fonction met à jour une campagne, son statut.

Paramètres


$ campaign_id: ID de la campagne dont le statut est obligatoire


$ status: état de la campagne


$ usr_id: identifiant de l'utilisateur propriétaire de cette campagne

Valeur de retour


Renvoie une chaîne codée json contenant les données de campagne en cas de succès.

Campaign_Filter

Cette fonction fournit un filtre de recherche pour rechercher des campagnes.

Paramètres


$ search: Tableau de requête de recherche pour les données de campagne.

Valeur de retour


Renvoie une chaîne codée json contenant les données de campagne en cas de succès.

Contact_Créer

Cette fonction crée un nouveau contact dans le groupe spécifié.

Paramètres


$ contact: tableau contenant des données de contact.


$ contact_group_id: ID du groupe de contact.

Valeur de retour


Renvoie une chaîne codée json contenant l'état du contact en cas de succès.

Contact_Supprimer

Cette fonction supprime un contact dont l'ID est donné.

Paramètres


$ contact_id: ID du contact à supprimer.

Valeur de retour


Renvoie une chaîne codée json contenant l'état du contact en cas de succès.

Voici des exemples de déploiements de API REST ICTBroadcast

Intégration ICTBroadcast avec EspoCRM

ICTBroadcast integeration avec VtigerRM

Cliquez ici pour devenir un fournisseur de services de téléphonie Internet pour démarrer votre propre entreprise