post https://{domainname}/ca_apis/PhoneManageV2
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.
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":"xxxx",
"action":"create",
"phoneNumber":"xxxxx",
"phoneName":"xxxxxx",
"skill":"xxx"}
| Parameter | Description |
|---|---|
| action* | "create" to create a new phone number |
| userName* | CloudAgent user name |
| phoneNumber* | The phone number that is to be created. |
| phoneName* | Optional name to the Phone number or lead adding. |
| skill | To 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" |