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 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:

Header parameters

Parameter	Description
Content-Type	application/json

Body Params

{
"userName":"xxxx",
"phoneName":"xxxx"
}

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"