This API is used to delete existing phone number details in CloudAgent. The user has to update the ‘action’ parameter with the delete function.

📘
APIs Domain Name
For domestic ccaas - enter the domain: in1-ccaas-api.ozonetel.com
For international ccaas - enter the domain: api.ccaas.ozonetel.com
For Partners - enter the respective URL

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",
"action":"delete",
"phoneNumber":"xxxx",
"phoneName":"xxxxx"

}

Parameter	Description
userName*	CloudAgent user name
action*	"delete" to delete an existing phone number
phoneNumber*	The phone number that is to be deleted.
phoneName*	Optional name to the Phone number or lead

❗️
Note

Parameters with ‘*’ are considered to be mandatory parameters.

phoneNumber with special characters(+1, +91 etc.,) are to be encoded(add %2B instead of ‘+’) while passing in the request.

The ‘phoneName’ parameter is not case-sensitive.

Possible responses


Success response	"status": "success" "message": "record inserted successfully"
Invalid api_key	"status": "error" "message": "userName or apiKey not valid"
Invalid action	"status": "error" "message": "action not valid"
Invalid phoneNumber	"status": "error" "message": "phoneNumber must be numeric"
Invalid username	"status": "error" "message": "userName or apiKey not valid"
Empty phoneName	"status": "error" "message": "phoneName cannot be empty"
Empty phoneNumber	"status": "error" "message": "phoneNumber cannot be empty"

200Successful response