Using REST-based API to integrate ICTBroadcast with third party application and autodialer automation

Following is list of API's we provide to integrate with third party application to achieve full automation and seamless functionality.

REST API

This REST API provides external interface to call some important functions of ICTBroadcast. ICTBroadcast defines 3 classes API_User, API_contact and API_Campaign in REST API that defines all the functions necessary to be accessed from outside of the application scope. Following is code example describes how to call these functions:

User_Create

This function creates a new user in ICTBroadcast. Following code describes how to call this function.

Parameters

$user: serialized array containing user data

Return value

Returns array containing user data if successful. Otherwise returns array containing false value.

User_Update

This function updates the user data.

Parameters


$user_id: ID of the user whose data is to be updated


$user: Data of the user

Return value


Returns json encoded string containing user data if successful. Otherwise returns array containing false value.

User_Get

This functions returns data of the user whose id is provided as argument.

Parameters


$user_id: ID of the user


$search: search


$value: value

Return value


Returns json encoded string containing user data if successful. Otherwise returns array containing false value.

User_Delete

This function deletes a user whose id is provided.

Parameters


$user_id: ID of the user

Return value


Returns true if delete successful otherwise returns false.

User_Extension_Create

This function creates extension for the given user.

Parameters


$user_id: ID of the user


$extension: array containing data for the new extension

Return value


Returns json encoded string containing extension data if successful. Otherwise returns array containing false value.

User_Role_List

This function returns all available roles.

Parameters


None

Return value


Returns json encoded string containing user roles if successful.

User_Payment_Create

This function adds credit in the user account

Parameters


$user_id: ID of the user


$value: paid amount to add


$description: brief description


$type: type of payment

Return value


Returns true if add credit successful otherwise returns false.

User_Login

This function logs in a user.

Parameters


$session_id: Session ID

Return value


Returns session name if successful otherwise returns false.

User_Logout

This function destroys user session in order to log him out.

Parameters


$session_id: Session ID

Return value


Returns session name if successful otherwise returns false.

Campaign_Status

This function gives status of the campaign whose ID is given.

Parameters


$campaign_id: ID of the campaign whose status is required

Return value


Returns json encoded string containing campaign status data if successful.

Campaign_Start

This function starts a campaign whose ID is given.

Parameters


$campaign_id: ID of the campaign

Return value


Returns json encoded string containing campaign status data if successful.

Campaign_Stop

This function stops a campaign whose ID is given.

Parameters


$campaign_id: ID of the campaign

Return value


Returns json encoded string containing campaign status data if successful.

Campaign_Contact_Create

This function adds a given contact that will be dialed by the campaign whose ID is given.

Parameters


$contact_id: Array containing contact data that will be created..


$campaign_id: ID of the campaign

Return value


Returns json encoded string containing campaign data if successful.

Campaign_Summary

This function returns the summary of the campaign. It will list status (busy, congestion, no-response, failed) of each contact in the campaign.

Parameters


$campaign_id: ID of the campaign whose status is required


$usr_id: ID of the user owns this campaign

Return value


Returns json encoded string containing campaign data if successful.

Campaign_Result

This function updates a campaign, its status.

Parameters


$campaign_id: ID of the campaign whose status is required


$status: status of the campaign


$usr_id: ID of the user owns this campaign

Return value


Returns json encoded string containing campaign data if successful.

Campaign_Filter

This function provides a search filter for searching campaigns.

Parameters


$search: Array of search query for the campaign data.

Return value


Returns json encoded string containing campaign data if successful.

Contact_Create

This function creates a new contact in specified group.

Parameters


$contact: Array containing contact data.


$contact_group_id: ID of the contact group.

Return value


Returns json encoded string containing status of the contact if successful.

Contact_Delete

This function removes a contact whose ID is given.

Parameters


$contact_id: ID of the contact to remove.

Return value


Returns json encoded string containing status of the contact if successful.