Enable/Disable PBX Advanced Features

Enable or disable the Linkus Chat, PBX Upgrade, and Call Recording on the PBX.

HTTP method and endpoint

PUT /api/v1/pbx/instances/{instance_id}/advanced_features

Request parameters

Parameter Importance Type Description Restriction
instance_id Required Integer PBX ID. Only numbers are allowed.
upgradeInPBX Required Boolean Whether to enable Upgrade feature on the PBX or not.
  • false: Disable Upgrade feature.
  • true: Enable Upgrade feature.
linkusChat Required Boolean Whether to enable Linkus Chat feature on the PBX or not.
  • false: Disable Linkus Chat feature.
  • true: Enable Linkus Chat feature.
callRecording Required Boolean Whether to enable Call Recording feature on the PBX or not.
  • false: Disable Call Recording feature.
  • true: Enable Call Recording feature.

Examples

Request example

PUT /api/v1/pbx/instances/951/advanced_features HTTP/1.1
Host: ympapi.yeastarcloud.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9uYW1lIjoiY2VjaWxpYUB5ZWFzdGFyLmNvbSIsInNjb3BlIjpbInRydXN0Il0sImV4cCI6MTU0NzAxNzk3MywiYXV0aG9yaXRpZXMiOlsiUk9MRV9hZG1pbiJdLCJqdGkiOiI5NWU5OTBiNS01ZTRjLTQyYjItYTgxZS1lMGU3NWJkNjFhNDkiLCJjbGllbnRfaWQiOiI5Nzg5OTNmMDk2YzQ0MTFmYTljYzgwZWUyZTYyZjFmMiJ9.r9D4eX4tiEla3EodK0Oo0aODDzodhFid5FAxukTd7IA
Content-Type: application/json
Cache-Control: no-cache
{
    "upgradeInPBX": true,
    "linkusChat": true,
    "callRecording":true
}

Response example

HTTP/1.1 200 OK
{
    "status": "Success"
}