get https://{domainname}/CAServices/AgentManualDial.php
Deprecation Update
This Agent Manual Dial API will be deprecated by 31st Dec 2024.
We recommend to start using the new version of the Skill Wise Agent Manual Dial APIs.
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 to the CloudAgent toolbar and available in manual or blended mode.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| api_key* | Available in Cloud agent after admin login |
| username* | Cloud agent username |
| agentID* | Unique id for every agent irrespective to campaign |
| campaignName* | Name of the campaign where the manual dial should be initiated |
| customerNumber | Number to be dialed out |
| UCID | Unique caller ID used for monitoring call details |
| uui | This is an additional data field used to pass application data from an API or user inputs on IVR into the report |
| format | json/xml Response format |
Note
Parameters with ‘*’ are to be considered as mandatory parameters.
Possible responses
| Success response | "status": "queued successfully" "ucid": "90XXXXXXXXX" |
| Invalid api_key | "status": "fail" "message": "please provide proper user credentials" |
| Invalid campaign name | "status": "fails" "message": "Campaign is invalid" |
| Invalid username | "status": "fail" "message": "please provide proper user credentials" |
| Invalid agent ID or agent is not logged in or agent is not in ready state | "status": "Fail" "message": "Agent is not available" |
| Missing parameters | "status": "Fail" "message": "All parameters are mandatory" |
| Attempting to make a call on a configured holiday | "status": "Fail" "message": "Call cannot be initiated on a holiday" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.