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 into the CloudAgent toolbar and available in inbound and blended modes. Calls can be routed through appropriate skill by passing the parameter ‘skill’.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
| Parameter | Description |
|---|---|
| Content-Type* | Should be - application/json |
| userName* | Your CloudAgent account username |
| skill* | Skill through which the call is to be routed |
| 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. |
| did* | Number assigned to campaign from which calls are to be dialed out |
| uui | Additional info through parameter |
Note
Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
| Success Call | {"ucid":"90XXXXXXXXXXXXX","status":"queued successfully"} |
| Hitting the request when the token is expired. | {"status": "false","message": "Token Expired","data": null} |
| Missing Token. | {"status": "false","message": "Token Expired","data": null} |
| Passing Invalid Token. | {"status": "false","message": "Invalid Token","data": null} |
| Hitting API with valid inputs when the setting "API Authentication" is set to - "Basic Auth" | "{""status"": ""false"",""message"": ""Api Key Should Not be Null or Empty."", ""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"" }" |
| When the DID is correct but the campaign is stopped | {"status": "Fail","message": "Please pass Valid Campaign Details"} |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.