Update your Cloud PBX exten

Update your exten by PBX subscription id and exten unique id. 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. The exten unique id can be retrieved from GET /api/v1/pbx/subscriptions/{pbx_id}/extens, which returns the list of extens in the given Cloud PBX. This endpoint allows you to specify SIP authentication credentials for you exten. Also, you can update a password for your exten via this endpoint.

Path Parameters

id*integer

PBX subscription id

Range1 <= value

exten_id*integer

Exten unique id

Range1 <= value

Header Parameters

Authorization*string

Your API token

Request Body

application/json

Exten request

first_name?string

Optional field. If provided, will update the exten user's first name.

last_name?string

Optional field. If provided, will update the exten user's last name.

regenerate_sip_password?boolean

Optional field. If the value is true, a new SIP authentication password will be generated and set for exten, ignoring the value in sip_password. The password can then be obtained via GET /api/v1/pbx/subscriptions/{id}/extens/pwd/{type} passing sip as password type.

regenerate_user_password?boolean

Optional field. If the value is true, update will generate new user password for exten, ignoring user_password passed alongside, and set exten's password to the newly generated value. The password can then be obtained via GET api/v1/pbx/subscriptions/{id}/extens/{exten_id}/pwd/{type} passing web as password type.

sip_name?string

Optional field. If provided, will update the SIP username that the device uses when sending a REGISTER request to the Cloud PBX.

sip_password?string

Optional field. If provided, will update the secret password used for SIP authentication during registration.

user_password?string

Optional field. If provided, will update exten's password to the one you provided.

Response Body

`application/json`

curl -X PATCH "https://dev-refactor-api-e.voipenv.uk/api/v1/pbx/subscriptions/1/extens/1" \  -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"
}

Update your Cloud PBX exten

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`