Add Agent

Add Agent API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 Body

{
  "success": "",
  "message": ""
}
Form Data
string
string
string
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json