get https://{domainname}/CAServices/ReleaseFwpNumber.php
Deprecation Update
This API will be deprecated by 31st Dec 2024.
We recommend to start using the new version of the APIs:
This API is used to force release an agent's phone number when an agent disconnects a call with the customer, however, the call does not get disconnected and the agent's phone number is still mapped with the customer.
To access this API the following parameters are required.
| Parameter | Description |
|---|---|
| apiKey* | Available in CloudAgent admin login |
| userName* | CloudAgent account name |
| phoneName* | Mapped to the phone number |
Note
Parameters with ‘*’ are mandatory parameters.
All possible responses
| success message | "status": "success", "FwpNumbers": ["xxxx"] |
| Invalid apiKey | "status": "error" "message": "userName or apiKey not valid" |
| Invalid userName | "status": "error" "message": "userName or apiKey not valid" |
| empty userName | "status": "error" "message: "userName cannot be empty" |
| empty apiKey | "status": "error" "message": "apiKey cannot be empty" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.