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.

👍
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.

Header parameters

Parameter	Description
apiKey*	Your CloudAgent account API Key
Content-Type	application/json

Body Params

{
"userName":"xxxxx",
"phoneName":"xxxxx"
}

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"