PBX API : GET /Personal/Settings/

To get a settings, make an HTTP GET request with basic authorization, resource URI:

http(s)://<PBX>/api/v1/Personal/Settings/

GET Parameters

Required Parameters

NameDescription

Optional Parameters:

NameDefaultPossible valuesDescription

fields

All

features
fkeys
personal
ringtones
sharedvm
cwtone 

A list of fields that should be returned

Maybe using with comma "," for listing all required fields

Ringtone can download it here:

http(s)://<PBX>/spoolview/sounds/00000/RingTones/<filename>

Function keys options:

KeyName
EXTColleague
PORBITPark Location
LINELine
SDSpeed dial
EMPTYEmpty key
TRUNKTrunk
STIMETimetable
SWITCHSwitch
3SWITCH3 state switch
GPICKUPGroup pick up
QPICKUPCall group status
QCALLDial call group
DTMFSend DTMF
LOCALGROUPLocal phonebook
ExpExp module

Response example:

Personal:

GET http(s)://<PBX>/api/v1/personal/settings/?fields=personal
{
  "type": "result",
  "result": {
    "personal":{
      "email":"slawutich@mail111.ru",
      "mobilePhone":"+380984388280"
    }
  }
}

Features:

GET http(s)://<PBX>/api/v1/personal/settings/?fields=features
{
  "type": "result",
  "result": {
    "features":{
      "internal":{
        "DND":{
          "status":"0",
          "value":"reject"
        },
        "_ACTIVATED":{
          "status":"1"
        },
        "MEXT":{
          "status":"0",
          "value":""
        },
        "BCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "UCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "SMSMCN":{
          "status":"0"
        },
        "FCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "EMAILMCN":{
          "status":"1"
        },
        "TOUT":{
          "status":"0",
          "value":""
        },
        "CW":{
          "status":"1"
        },
        "MOBCONFIRMATION":{
          "status":"1"
        },
        "RING":{
          "status":"1",
          "value":"Ring1"
        }
      },
      "external":{
        "DND":{
          "status":"0",
          "value":"reject"
        },
        "_ACTIVATED":{
          "status":"1"
        },
        "MEXT":{
          "status":"0",
          "value":""
        },
        "BCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "UCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "SMSMCN":{
          "status":"0"
        },
        "FCF":{
          "status":"0",
          "value":"VOICEMAIL"
        },
        "EMAILMCN":{
          "status":"1"
        },
        "TOUT":{
          "status":"0",
          "value":""
        },
        "CW":{
          "status":"1"
        },
        "MOBCONFIRMATION":{
          "status":"1"
        },
        "RING":{
          "status":"1",
          "value":"Ring1"
        }
      }
    }
  }
}

Ringtones:

GET http(s)://<PBX>/api/v1/personal/settings/?fields=ringtones
{
  "type": "result",
  "result": {
    "ringtones":{
      "Emergency":[
        "Emergency.ulaw",
        "Emergency.wav"
      ],
      "External":[
        "External.ulaw",
        "External.wav"
      ],
      "Ring1":[
        "Ring1.ulaw",
        "Ring1.wav"
      ],
      "Ring2":[
        "Ring2.ulaw",
        "Ring2.wav"
      ]
    }
  }
}

Function keys:

GET http(s)://<PBX>/api/v1/personal/settings/?fields=fkeys
{
  "type": "result",
  "result": {
    "fkeys":{
      "keys":[{
        "key":"EXT",
        "value":"222",
        "title":"44555"
      },{
        "key":"LINE",
        "value":"",
        "title":""
      },{
        "key":"SD",
        "value":"",
        "title":""
      },{
        "key":"EMPTY",
        "value":"",
        "title":""
      },{
        "key":"TRUNK",
        "value":"trunk1",
        "title":""
      },{
        "key":"STIME",
        "value":"",
        "title":""
      },{
        "key":"SWITCH",
        "value":"",
        "title":""
      },{
        "key":"Exp",
        "value":"1",
        "title":""
      },{
         "key":"QPICKUP",
         "value":"2",
         "title":""
      }],
      "list":{
        "STIME":[],
        "TRUNK":[
          "trunk1",
          "trunk2",
          "bri0_0_0",
          "bri0_1_0",
          "bri0_2_0",
          "bri0_3_0"
        ],
        "SWITCH":[],
        "3SWITCH":[],
        "GPICKUP":{
          "1":"Admin",
          "2":"Default"
        },
        "QPICKUP":{
           "2":"multiring"
        },
        "QCALL":{
          "2":"multiring"
        }
      }
    }
  }
}

Shared voicemail:

GET /api/v1/personal/settings/
{
    features: {…}, 
    personal: {…},
    features: {…},
    fkeys: {…},
    personal: {…},
    ringtones: {…},
    sharedvm: {
        status: "1",  // 1 - enabled, 0 - disabled
        value: "111"  // extension
    }
}