Following is a list of APIs we provide to integrate with third-party applications to achieve full automation and seamless functionality.
REST API
This REST API provides an 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:
Click here for complete API list
User_Create
This function creates a new user in ICTBroadcast. The following code describes how to call this function.
Parameters
$user: a serialized array containing user data
Return value
Returns array containing user data if successful. Otherwise returns an array containing the 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 an array containing the false value.
User_Get
This function returns data of the user whose id is provided as an 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 an array containing the 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 an extension for the given user.
Parameters
$user_id: ID of the user
$extension: an array containing data for the new extension
Return value
Returns JSON encoded string containing extension data if successful. Otherwise returns an array containing the 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 to 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 the 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 the 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 the 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, it’s 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 search campaigns.
Parameters
$search: Array of search queries for the campaign data.
Return value
Returns JSON encoded string containing campaign data if successful.
Contact_Create
This function creates a new contact in the 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 contract 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 contract if successful.
Here are example deployments of ICTBroadcast REST APIs
ICTBroadcast integration with EspoCRM
ICTBroadcast integration with VtigerRM
Click here to become an Internet Telephony Service Provider to start your own business