This API is used to create new phone number details in CloudAgent. The user has to update the ‘action’ parameter with the create. For example, if the action parameter = Create along with the following parameters, this API creates a new phone number.

To access this API the following parameters MUST be passed

ParameterDescription
action*"create" to create a new phone number
apiKey*Available in CloudAgent admin login
userName*CloudAgent user name
phoneNumber*The phone number that is to be created or deleted.
phoneName*Optional name to the Phone number or lead adding.
skillTo assign skills while creating the phone number

❗️

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"
Number/Name exists"status": "error"
"message": "phone_name or phone_number already exist"
Passing invalid phoneNumber like less than 3 digits or more than 16 digits"status":"error","message":"phoneNumber should be between 3 to 17 digits long and allows prefix +"
Passing phoneName with special characters"status":"error","message":"phoneName should be between 2 to 50 alphanumeric characters long allows prefix + and special characters like .,@,_,- and Name cannot start and end with Special characters."
If the phone number creation limit exceeded"status": "error"
"message":" Phone Number Limit Exceeded. Please
refer to the 'Phone Number Creation Limit' option under 'Edit Profile'
for reference. "
Invalid Skill Key"status": "success"
"message": "record inserted successfully and failed to insert skills please pass the valid skills"
Missing Skill Value"status": "success"
"message": "record inserted successfully and failed to insert skills please pass the valid skills"

📘

Further Insights

By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.

Language
URL
Click Try It! to start a request and see the response here!