post https://{domainname}/ca_apis/AgentManualDial
Skillwise Agent Manual dial (Click2Call) API is used to make outbound calls through any web application, as we perform from the agent toolbar manually. This API works only if the agent is logged in as an agent in the CloudAgent toolbar and available in inbound and blended modes. Calls can be routed through appropriate skill by passing the parameter ‘skill’.
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| apiKey* | Available in CloudAgent admin login |
| Content-Type | Should be - application/json |
| userName* | CloudAgent user name |
| skill* | Skill through which the call is to be routed |
| did* | Number assigned to campaign from which calls are to be dialed out |
| customerNumber* | Number to be dialed out |
| UCID | true - Paaing 'true' as a parameter gives you the UCID of the call in the API response. false - Passing 'false' or any other invalid value doesn't provide you the UCID in the API response. |
| uui | Additional info through parameter |
Note
Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
| Success Call | {"ucid":"90XXXXXXXXXXXXX","status":"queued successfully"} |
| Hitting API with valid inputs when the setting "API Authentication' is set to "Token Auth" | "{""status"": ""false"",""message"": ""Api Key Should Not be Null or Empty."", ""data"": null}" |
| Passing Invalid apiKey Key | "{""status"": ""false"",""message"": ""Api Key Should Not be Null or Empty."", ""data"": null}" |
| Passing Invalid apiKey Value | {"status": "false","message": "Invalid User Details","data": null} |
| Missing apiKey key | "{""status"": ""false"",""message"": ""Api Key Should Not be Null or Empty."", ""data"": null}" |
| Missing apiKey Value | {"status": "false","message": "Invalid User Details","data": null} |
| Passing Invalid userName Key | "{""status"": ""false"",""message"": ""Username Should Not be Null or Empty."", ""data"": null}" |
| Passing Invalid userName Value | "{""status"": ""false"",""message"": ""Invalid User Details"", ""data"": null}" |
| Missing userName key | "{""status"": ""false"",""message"": ""Username Should Not be Null or Empty."", ""data"": null}" |
| Missing userName Value | "{""status"": ""false"",""message"": ""Username Should Not be Null or Empty."", ""data"": null}" |
| Passing Invalid customerNumber Key | "{ ""status"": ""Fail"", ""message"": ""custNumber should not be null are empty"" }" |
| Passing Invalid customerNumber Value | {"ucid":"9022169883666821","status":"queued successfully"} |
| Missing customerNumber Key | "{ ""status"": ""Fail"", ""message"": ""custNumber should not be null are empty"" }" |
| Missing customerNumber Value | "{ ""status"": ""Fail"", ""message"": ""custNumber should not be null are empty"" }" |
| Invalid customerNumber like 12345/Abc | {"ucid":"90XXXXXXXXXXXXX","status":"queued successfully"} |
| Passing Invalid DID Key | "{ ""status"": ""Fail"", ""message"": ""DID Should Not Null or Empty"" }" |
| Passing Invalid DID Value | "{ ""status"": ""Fail"", ""message"": ""Please pass Valid Campaign Details"" }" |
| Missing DID Key | "{ ""status"": ""Fail"", ""message"": ""DID Should Not Null or Empty"" }" |
| Missing DID Value | "{ ""status"": ""Fail"", ""message"": ""DID Should Not Null or Empty"" }" |
| Passing Invalid Skill Key | "{ ""status"": ""Fail"", ""message"": ""Please Pass Valid AgentId are Valid skillName "" }" |
| Passing Invalid Skill Value | "{ ""status"": ""Fail"", ""message"": ""Please pass Valid Skill Details"" }" |
| Missing Skill Key | "{ ""status"": ""Fail"", ""message"": ""Please Pass Valid AgentId are Valid skillName "" }" |
| Missing Skill Value | "{ ""status"": ""Fail"", ""message"": ""Please Pass Valid AgentId are Valid skillName "" }" |
| ucid =false / empty/ missing/ invalid | {status":"queued successfully"} |
| when agent is neither in blended nor in inbound mode/ not ready/not available | "{ ""status"": ""Fail"", ""message"": ""Agent is not available"" }" |
| When the campaign is offline. | "{ ""status"": ""Fail"", ""message"": ""Please pass Valid Campaign Details"" }" |