PBX API : GET /iOS/Config/

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

http(s)://<PBX>/api/v1/iOS/Config/

GET Parameters

Required Parameters

NameDescription

Optional Parameters:

NameDefaultPossible valuesDescription

fields

All

groups
colleagues
personalInfo
dialplanSettings
pbxInfo
wideband
sip-rtp

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>

Response example:

Groups:

GET http(s)://<PBX>/api/v1/iOS/Config/?fields=groups
{
  "type": "result",
  "result": {
    "groups":[{
      "dn":"gid=287727455,o=com0,dc=wildix",
      "id":"287727455",
      "name":"Admin",
      "wcgrp":"1"
    },{
      "dn":"gid=1971511745,o=com0,dc=wildix",
      "id":"1971511745",
      "name":"Default",
      "wcgrp":"2"
    }]
  }
}

Personal info:

GET http(s)://<PBX>/api/v1/iOS/Config/?fields=personalInfo
{
  "type": "result",
  "result": {
    "personalInfo":{
      "dn":"uid=9010198,o=com0,dc=wildix",
      "id":"9010198",
      "name":"user1",
      "extension":"111",
      "officePhone":"22222",
      "mobilePhone":"",
      "faxNumber":"11111",
      "email":"email@google.com",
      "pbxDn":"pbxid=0800276a7b26,dc=wildix",
      "role":"admin","groupDn":"gid=287727455,o=com0,dc=wildix",
      "language":"en",
      "dialplan":"users",
      "faxDialplan":"users",
      "departament":"",
      "sipPassword":"qdlr8dHCN7@"
    }
  }
}
Dialplan settings:
GET http(s)://<PBX>/api/v1/iOS/Config/?fields=dialplanSettings
{
  "type": "result",
  "result": {
    "dialplanSettings":{
        GEOD: "2", // Send call key (0=none, 1=*, 2=#)
        transferdigittimeout: "600", //First digit timeout (secs)
        transferinterdigittimeout: "2" //Interdigit timeout (secs)
    }
  }
}

 

PBX info:

GET http(s)://<PBX>/api/v1/iOS/Config/?fields=pbxInfo
{
  "type": "result",
  "result": {
    "pbxInfo":{
      "networkAddresses":[
        "192.168.1.243",
        "89.238.100.165"
      ],
      "ports":[
         "9443",
         "443"
      ],
      "failovers":[
         {
            "networkAddresses":["10.100.1.147","85.238.100.162"],
            "ports":["443"]
         }
      ],
      "externalLinePrefix":"0",
      "version":"3.80.28766.11"
    }
  }
}

Colleagues:

GET http(s)://<PBX>/api/v1/iOS/Config/?fields=colleagues
{
  "type": "result",
  "result": {
    "colleagues":[{
      "dn":"uid=1084131938,o=com0,dc=wildix",
      "id":"1084131938",
      "name":"admin",
      "extension":"",
      "officePhone":"",
      "mobilePhone":"",
      "faxNumber":"",
      "email":"",
      "pbxDn":"pbxid=080027ac4c23,dc=wildix",
      "role":"admin",
      "groupDn":"gid=31750520,o=com0,dc=wildix",
      "language":"en",
      "dialplan":"internalcalls",
      "faxDialplan":"internalcalls",
      "departament":""
    },{
       "dn":"uid=5902399,o=com0,dc=wildix",
       "id":"5902399",
       "name":"user2",
       "extension":"222",
       "officePhone":"",
       "mobilePhone":"",
       "faxNumber":"",
       "email":"",
       "pbxDn":"pbxid=080027ac4c23,dc=wildix",
       "role":"user",
       "groupDn":"gid=31750520,o=com0,dc=wildix",
       "language":"en",
       "dialplan":"users",
       "faxDialplan":"users",
       "departament":""
    }]
  }
}

Wideband:

GET http(s)://<PBX>/api/v1/iOS/Config/?fields=wideband
{
  "type": "result",
  "result": {
    "wideband":true
  }
}
sip-rtp:
GET http(s)://<PBX>/api/v1/iOS/Config/?fields=sip-rtp
{
  "type":"result",
  "result":{
    "sip-rtp":{
      "jitter":{"min":"100","average":"200","max":"300"},
      "DSCP":{"RTP":"0","SIP":"224"
      }
    }
  }
}

jitter: 50-500ms
DSCP: 0-224

Attachments:

tos_dscp_table.png (image/png)