Manage Agents
Add Agent
Add Agent API
Description
This API endpoint is used to add agents in PBX.
Request Body
-
userExtension (text, Required): The extension number to dial to reach this user.
-
displayName (text, Required): The CallerID name for calls from this user will be set to this name. Only enter the name, NOT the number.
-
format (text): The format of the response.
-
desksName (text): Desks names to add, can add more than one (e.g. desk1, desk2, desk3).
Response
{
"success": "",
"message": ""
}
post/api/addAgent
Request
- Base URLhttps://your-instance.stats.pbx.commpeak.com
- URLhttps://your-instance.stats.pbx.commpeak.com/api/addAgent
- AuthAPI key in header X-API-KEY
Request body application/x-www-form-urlencoded
Example request
{
"desksName": "<string>",
"displayName": "<string>",
"format": "json",
"userExtension": "<number>"
}Response
successful
Example response
{
"message": "<string>",
"success": "<boolean>"
}Changes
No recorded changes to this operation across all 1 revision of this API.