Utilisation de l'API REST pour intégrer ICTBroadcast avec application tierce et l'automatisation de composeur automatique

Voici la liste des API que nous offrons à intégrer avec une application tierce pour réaliser une automatisation complète et une fonctionnalité sans faille.

REST API

Cette API REST fournit une interface externe pour appeler des 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 accessible depuis l'extérieur de la portée de l'application. Voici un exemple de code 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.

Parametres

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

Valeur de retour

Retourne un tableau contenant des données de l'utilisateur en cas de succès. Sinon retourne tableau contenant la valeur false.

User_Update

Cette fonction met à jour les données d'utilisateur.

Parametres

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

$user: Les données de l'utilisateur

Valeur de retour

Retourne chaîne encodée JSON contenant des données de l'utilisateur en cas de succès. Sinon retourne tableau contenant la valeur false.

User_Get

Cette fonction retourne les données de l'utilisateur dont l'id est fourni comme argument.

Parametres

$user_id: Identification de l'utilisateur

$search: rechercher

$value: valeur

Valeur de retour

Retourne chaîne encodée JSON contenant des données de l'utilisateur en cas de succès. Sinon retourne tableau contenant la valeur false.

User_Delete

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

Parametres

$user_id: Identification de l'utilisateur

Valeur de retour

Renvoie true si supprimer réussi sinon retourne false.

User_Extension_Create

Cette fonction crée poste pour l'utilisateur donné.

Parametres

$user_id: Identification de l'utilisateur

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

Valeur de retour

Retourne chaîne encodée JSON contenant les données d'extension en cas de succès. Sinon retourne tableau contenant la valeur false.

User_Role_List

Cette fonction retourne tous les rôles disponibles.

Parametres

aucun

Valeur de retour

Retourne chaîne encodée JSON contenant les rôles des utilisateurs en cas de succès.

User_Payment_Create

Cette fonction ajoute crédit du compte de l'utilisateur

Parametres

$user_id: Identification de l'utilisateur

$value: montant versé à ajouter

$description: brève description

$type: type de paiement

Valeur de retour

Retourne true si ajouter du crédit réussi sinon retourne false.

User_Login

Cette fonction se connecte à un utilisateur.

Parametres

$session_id: Session ID

Valeur de retour

Retourne le nom de session en cas de succès sinon retourne false.

User_Logout

Cette fonction détruit session de l'utilisateur afin de lui fermer la session.

Parametres

$session_id: Session ID

Valeur de retour

Retourne le nom de session en cas de succès sinon retourne false.

Campaign_Status

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

Parametres

$campaign_id: ID de la campagne dont le statut est nécessaire

Valeur de retour

Retours chaîne codée json contenant des 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é.

Parametres

$campaign_id: ID de la campagne

Valeur de retour

Retours chaîne codée json contenant des 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é.

Parametres

$campaign_id: ID de la campagne

Valeur de retour

Retours chaîne codée json contenant des 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é.

Parametres

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

$campaign_id: ID de la campagne

Valeur de retour

Retourne chaîne encodée JSON contenant des données de la campagne en cas de succès.

Campaign_Summary

Cette fonction retourne le résumé de la campagne. Il donnera la liste statut (occupé, congestion, sans réponse, n'a pas) de chaque contact dans la campagne.

Parametres

$campaign_id: ID de la campagne dont le statut est nécessaire

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

Valeur de retour

Retourne chaîne encodée JSON contenant des données de la campagne en cas de succès.

Campaign_Result

Cette fonction met à jour une campagne, son statut.

Parametres

$campaign_id: ID de la campagne dont le statut est nécessaire

$status: état de la campagne

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

Valeur de retour

Retourne chaîne encodée JSON contenant des données de la campagne en cas de succès.

Contact_Create

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

Parametres

$contact: Tableau contenant les données de contact.

$contact_group_id: ID du groupe de contact.

Valeur de retour

Retours JSON codée chaîne contenant le statut du contact en cas de succès.

Contact_Delete

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

Parametres

$contact_id: ID du contact à supprimer.

Valeur de retour

Retours JSON codée chaîne contenant le statut du contact en cas de succès.