Create new exten

Create new exten in your Cloud PBX system. Cloud PBX is determined from PBX subscription id passed as a parameter. The PBX subscription unique id can be retrieved from GET /api/v1/pbx/subscriptions, which returns the list of PBX subscriptions assigned to the current customer. Creation parameters are passed in body, look for the specification below. During creation, if number or password were not provided, out system will generate them automatically. Password can then be retrieved through a separate endpoint. If your Cloud PBX has not been configured yet, you will receive a status code 425 Too Early (refer to responses).

Path Parameters

id*integer

PBX subscription id

Range1 <= value

Header Parameters

Authorization*string

Your API token

Request Body

application/json

Exten creation parameters

email?string

Optional parameter. Used for system notifications, Linkus login, and user identification. As it is used for identification, it is recommended to provide this value. This value must be unique across the Cloud PBX.

first_name?string

Optional field. First name of the user. Display name components used in caller ID, directory listings, and user profiles.

last_name?string

Optional field. Last name of the user. Display name components used in caller ID, directory listings, and user profiles.

number?string

Optional field. The extension number (the internal dialing number) and the SIP username. If number is not provided, it will be selected by our system. This value must be unique across the Cloud PBX.

password?string

Optional field. The extension password used for authentication and the secret password used for SIP authentication during registration. If password is not provided, it will be automatically generated by our system. You can retrieve it from the separate endpoint.

role_id?integer

Assigns a system role that defines the user’s permissions in the PBX web portal.

Response Body

`application/json`

curl -X POST "https://dev-refactor-api-e.voipenv.uk/api/v1/pbx/subscriptions/1/extens" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "code": 0,
  "message": "string",
  "request_id": "string",
  "status": "ok"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

Create new exten

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

425application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`