Table of Content 
 

 
Overview 2 

Prerequisite 2 

Sample request 3 

Possible responses in XML 3 

Possible responses in ​JSON 3 

 
 

 
 
 
 
 
 

CloudAgent API documentation 1 

  

Agent Manual Dial (Online) 

 

Overview 
Agent Manual dial Online (Click2Call) API is used to make Outbound calls through any web 
application, as we perform in the Agent Toolbar manually. This API works only if the agent is 
logged in as agent in CloudAgent toolbar and available in Manual/Blended mode. 

Prerequisite 
To access this API we need to pass following parameters. 

API  https://api1.cloudagent.in/CAServices/AgentManualDial.php? 

Method  GET  Size 

Parameter api_key* ​(Available in Cloudagent Admin login)  250 Characters 

s 
username* ​(CloudAgent user name)  255 Characters 

agentID* ​(Agent’s ID through which respective agent is logged in)  255 Characters 

campaignName*​ (Name of the campaign through which Outbound  255 Characters 

calls are initiated) 

customerNumber* ​(Number to be dialed out)  50 Characters 

uui ​(Additional info through parameter)  500 Characters 

UCID=true ​(To see Unique Caller ID of that respective call in response) 

format ​( ​json/xml ​Response format ) 

Note:  

● Parameters with ‘*’ are considered to be mandatory parameters. 

CloudAgent API documentation 2 

  

Sample request 
https://api1.cloudagent.in/CAServices/AgentManualDial.php?api_key=KKXXXXXXXXXXXXXX&
username=mdxxxxxxx&agentID=DXXXXXXX&campaignName=Skxxxxxxxx&customerNumber=
040XXXX&UCID=true&uui=Test

Possible responses in XML 

Success response  <status>queued successfully</status><ucid>90XXXXXXXXX</ucid> 

Invalid api_key  <status>please provide proper user credentials</status> 

Invalid Campaign name  <status>Campaign is invalid</status> 

Invalid username  <status>please provide proper user credentials</status> 

Invalid agentID/ Agent  <status>Agent is not available</status> 

not logged in/NotReady 

Missing parameters  <status>All parameters are mandatory</status> 

Possible responses in json 

Success response  {"ucid":"91XXXXXXXXXX","status":"queued successfully"} 

Invalid api_key  {"status":"please provide proper user credentials"} 

Invalid Campaign name  {"status":"Campaign is invalid"} 

Invalid username  {"status":"please provide proper user credentials"} 

Invalid agentID/ Agent  {"status":"Agent is not available"} 

not logged in/NotReady 

Missing parameters  {"status":"All parameters are mandatory"} 

CloudAgent API documentation 3