Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Specific Response Codes: N/A
HTTP Method: GET
Examples: XML format
<phones>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"<description>Phone 1 - YES</description>
</phone>
<phone>
<serialNumber>000000c0ffee</serialNumber>
<model>testPhoneModel</model>"
<description>NO - duplicate serial number</description> </phone>
</phones>
JSON format
{
"phones": {

Wiki Markup
"phone": \[


{
"serialNumber": "000000c0ffea",
"model": "testPhoneModel",
"description": "Phone 1 - YES"
},
{
"serialNumber": "000000c0ffeb",
"model": "testPhoneModel",
"description": "NO - duplicate serial number"
}
]}
}
HTTP Method: POST
Creates a new phone.
Unsupported HTTP Methods: PUT, DELETE

Anchor
__RefHeading__4275_380902303
__RefHeading__4275_380902303
Retrieve phone profile

...

Wiki Markup
"autoAttendants": \[


{"name": "Operator",
"systemId": "operator",
"specialSelected": false},
{
"name": "After hours",
"systemId": "afterhour",
"specialSelected": false}
]}
Unsupported HTTP Methods: POST, PUT, DELETE

Anchor
__RefHeading__4281_380902303
__RefHeading__4281_380902303
View or modify AAs special mode

...

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all users. Parameters to specify sorting are optional, but you should use both if you want sorting. If you only use the "sortdir" parameter, it defaults to "name".
Example: XML format
<user>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
 <id>21</id>
 <userName>208</userName>
 <lastName>Zor-El</lastName>
 <firstName>Kara</firstName>
 <pin></pin>
 <sipPassword>208</sipPassword>
 <groups>
   <group>
     <id>5</id>
     <name>JusticeLeague</name>
     <description>Superheroes of America</description>
   </group>
 </groups>
 <branch>
   <id>1</id>
   <name>HallOfJustice</name>
   <description>API Testing</description>
 </branch>
 <aliases>
   <alias>
     <alias>supergirl</alias>
   </alias>
   <alias>
     <alias>kara</alias>
   </alias>
 </aliases>
</user>
JSON format
{"user": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

Wiki Markup
"users": \[


{
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

Wiki Markup
"groups": \[


{
"id": 9,
"name": "IMGroup"
}
],

Wiki Markup
"aliases": \[


]
},
{
"id": 11,
"userName": "206",
"pin": "",
"sipPassword": "",

Wiki Markup
"groups": \[


],

Wiki Markup
"aliases": \[


]
}
]
}}
HTTP Method: PUT
Adds a new user. Notes:

  • The ID is auto-generated and any value will be ignored.
  • If the Pin is empty the current PIN value will be preserved.
  • The Branch, Groups and Aliases elements are optional.

...

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified ID
Example: XML format
<user>
<id>10</id>
<userName>205</userName>
<pin />
<sipPassword />
<groups>
<group>
<id>9</id>
<name>IMGroup</name> </group>
</groups>
<aliases /> </user>
JSON format
{"user": {
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

Wiki Markup
"groups": \[


{
"id": 9,
"name": "IMGroup"
}
],

Wiki Markup
"aliases": \[


]
}}
HTTP Method: PUT
Updates user with specified ID. Uses same XML as for creation. After an update the response data will contain an ID element with the "id" value of the item affected.
HTTP Method: DELETE
Removes user with the specified ID.
Unsupported HTTP Method: POST

Anchor
__RefHeading__4297_380902303
__RefHeading__4297_380902303
View permissions for all users

...

Wiki Markup
https://\[server\]/sipxconfig/rest/branch?sortdir=forward&sortby=description&page=1&pagesize=1


HTTP Method: PUT
Adds a new branch. The ID is auto-generated and any value is ignored:
<branch>
<id>1</id>
<name>HallOfJustice</name>
<description>API Testing</description>
<address>
<id>3</id>
<street>1 Justice Way</street>
<city>Smallville</city>
<country>United States</country>
<state>MidAmerica</state>
<zip>55555</zip>
<officeDesignation>stop</officeDesignation>
</address>
<phoneNumber>555-HERO</phoneNumber>
</branch>
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__4311_380902303
__RefHeading__4311_380902303
View or modify a branch ID

...

Wiki Markup
https://\[server\]/sipxconfig/rest/user-group?sortdir=forward&sortby=description&page=1&pagesize=1


<user-group>
<metadata>
<totalResults>7</totalResults>
<currentPage>1</currentPage>
<totalPages>7</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<groups>
<group>
<id>19</id>
<name>ldap_imports</name>
</group>
</groups>
</user-group>
JSON format
{"usergroup": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

Wiki Markup
"groups": \[


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IMGroup"
}
]
}}
HTTP Method: PUT
Adds a new user group. The "id" is auto-generated and any value is ignored. The "branch" element is optional.
<userGroup>
<id>5</id>
<name>JusticeLeague</name>
<description>Superheroes Unlimited</description>
<branch>
<id>1</id>
<name>HallOfJustice</name>
<description>Hall of Superheroes</description>
<address>
<id>3</id>
<street>1 Justice Way</street>
<city>Smallville</city>
<country>United States</country>
<state>MidAmerica</state>
<zip>55555</zip>
<officeDesignation>MailStop</officeDesignation>
</address>
<phoneNumber>555-HERO</phoneNumber>
</branch>
</userGroup>
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__4317_380902303
__RefHeading__4317_380902303
View or modify a user group ID

...

Specific Response Codes: Error 400 - when {id} is invalid or not found
HTTP Method: GET
Retrieves information on the user group with the specified ID.
Example: XML format
<user-group>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
<groups>
<group>
<id>5</id>
<name>administrators</name>
<description>Users with superadmin privileges</description>
</group>
<group>
<id>9</id>
<name>IM-Group</name>
</group>
</groups>
</user-group>
JSON format
{"user-group": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

Wiki Markup
"groups": \[


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IM-Group"
}
]
}}
HTTP Method: PUT
Updates group with the specified ID. Uses the same XML as for creation.
HTTP Method: DELETE
Removes branch with the specified ID.

Anchor
__DdeLink__81289_1685120373
__DdeLink__81289_1685120373
Unsupported HTTP Method: POST

Anchor
__RefHeading__4319_380902303
__RefHeading__4319_380902303
View or modify user group permissions

...

Wiki Markup
*Resource URI{*}: /erl/phone/\{serial_number\}\[,\{serial_numer2\},...\]


Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

location

 

elin

ELIN number.

addressInfo

 

description

Short description of the ERL.

serial

 

...

Specific Response Codes: N/A
HTTP Method: GET
Returns registrations for the given IP
Example: JSON format only

Wiki Markup
\[ 1\]


0: {
_id: {
$oid: "53ece9c9c9dbca3ae42b0c9c"
}
-
timestamp: 1408035273
localAddress: "192.168.2.93/RegDB::_bindingsNameSpace"
identity: "201@ezuce.ro"
uri: "sip:201@ezuce.ro"
callId: "ce9f17b8-f65e3fef-8725ec82@192.168.2.55"
contact: "<sip:201@192.168.2.55;x-sipX-nonat>"
binding: "sip:201@192.168.2.55"
qvalue: ""
instanceId: ""
gruu: ""
shardId: 3
path: ""
cseq: 46
expirationTime: 1408037748
instrument: "0004f2acf001"
expired: false
}
-
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__4591_1290585556
__RefHeading__4591_1290585556
Filter registrations for lines

...

HTTP Method: GET
Returns registrations for the given Line / Extension
Example: JSON format only

Wiki Markup
\[ 1\]


0: {
_id: {
$oid: "53e9fae1981c85c27cb59838"
}
-
instrument: ""
instanceId: ""
callId: "vU6HMrOMktGUJriyZRJuY.RpLxAEiAZ6"
binding: "sip:206@192.168.2.101:49102"
uri: "sip:206@ezuce.ro"
localAddress: ""
shardId: 2
gruu: ""
contact: "<sip:206@192.168.2.101:49102;ob;x-sipX-nonat>"
cseq: 19033
qvalue: ""
timestamp: 1407843041
path: ""
expirationTime: 1407843915
expired: false
identity: "206@ezuce.ro"
}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__26766_1685120373
__RefHeading__26766_1685120373
Filter registrations by mac

...

Specific Response Codes: N/A
HTTP Method: GET
Returns registrations for the given Line / Extension
Example: JSON format only

Wiki Markup
\[ 2\]


0: {
_id: {
$oid: "53ece9c9c9dbca3ae42b0c9c"
}
-
timestamp: 1408035273
localAddress: "192.168.2.93/RegDB::_bindingsNameSpace"
identity: "201@ezuce.ro"
uri: "sip:201@ezuce.ro"
callId: "ce9f17b8-f65e3fef-8725ec82@192.168.2.55"
contact: "<sip:201@192.168.2.55;x-sipX-nonat>"
binding: "sip:201@192.168.2.55"
qvalue: ""
instanceId: ""
gruu: ""
shardId: 3
path: ""
cseq: 46
expirationTime: 1408037748
instrument: "0004f2acf001"
expired: false
}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__4593_1290585556
__RefHeading__4593_1290585556
Phones

...

Specific Response Codes: N/A
HTTP Method: GET
Retrieves user call forwarding scheme, with the schedule.
Example: XML format
<callsequence>
<rings>
<ring>
<expiration>30</expiration>
<type>If no response</type>
<enabled>true</enabled>
<number>333</number>
</ring>
<ring>
<expiration>30</expiration>
<type>At the same time</type>
<enabled>true</enabled>
<number>232</number>
</ring>
</rings>
<expiration>20</expiration>
<withVoicemail>true</withVoicemail>
</callsequence>
JSON format
{"callsequence": {

Wiki Markup
"rings": \[


{
"expiration": 30,
"type": "If no response",
"enabled": true,
"number": "333"
},
{
"expiration": 30,
"type": "At the same time",
"enabled": true,
"number": "232"
}
],
"expiration": 20,
"withVoicemail": true
}}
HTTP Method: PUT
Modifies user call forwarding scheme.
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__5792_958082936
__RefHeading__5792_958082936
View or modify call forwarding schedules

...

Wiki Markup
\{"expiration":20,"rings":\[\{"expiration":30,"type":"If no response","enabled":true,"number":"11112","scheduleId":1\},\{"expiration":30,"type":"At the same time","enabled":true,"number":"444333","scheduleId":2\}\],"withVM":true\}


HTTP Method: PUT
Saves call forwarding schedules (includes schedule ID)
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__5794_958082936
__RefHeading__5794_958082936
View or modify a schedule ID

...

Wiki Markup
\{"description":"Desc","periods":\[\{"start":\{"hrs":9,"min":0\},"end":\{"hrs":18,"min":0\},"scheduledDay":7\}\],"scheduleId":3,"name":"Sunday"\}


HTTP Method: PUT
Updates existing schedule given {id}
HTTP Method: DELETE
Deletes existing schedule given {id}
Unsupported HTTP Method: POST

Anchor
__RefHeading__5796_958082936
__RefHeading__5796_958082936
View active calls

...

Specific Response Codes: N/A
HTTP Method: GET
Retrieves user active calls in XML or JSON format
Example: XML format
<cdrs>
<cdr>
<from>2011</from>
<from-aor>"2011" <sip:2011@openuc.ezuce.com></from-aor>
<to>32011</to>
<to-aor><sip:32011@openuc.ezuce.com></to-aor>
<direction>INCOMING</direction>
<recipient>32011</recipient>
<internal>false</internal>
<type>Unknown</type>
<start-time>1400239363000</start-time>
<duration>45976</duration>
</cdr>
</cdrs>scheduledDay":7}],"scheduleId":3,"name":"Sunday"}
JSON format

Wiki Markup
\{"cdrs": \[


{
"from": "2011",
"from-aor": "\"2011\" <sip:2011@openuc.ezuce.com>",
"to": "32011",
"to-aor": "<sip:32011@openuc.ezuce.com>",
"direction": "INCOMING",
"recipient": "32011",
"internal": false,
"type": "Unknown",
"start-time": 1400240496000,
"duration": 483896
}
]}
Unsupported HTTP Method: POST, PUT, DELETE

Anchor
__RefHeading__5798_958082936
__RefHeading__5798_958082936
Voicemail

...

Wiki Markup
\{"description":"Desc","periods":\[\{"start":\{"hrs":9,"min":0\},"end":\{"hrs":18,"min":0\},"scheduledDay":7\}\],"scheduleId":3,"name":"Sunday"\}


HTTP Method: PUT
Updates existing schedule given {id}
HTTP Method: DELETE
Deletes existing schedule given {id}
Unsupported HTTP Method: POST

Anchor
__RefHeading__5802_958082936
__RefHeading__5802_958082936
View or modify voicemail settings

...

Wiki Markup
\{"phonebook": \[


{
"number": "205",
"contactinformation": {
"homeAddress": {},
"officeAddress": {},
"imId": "205",
"imDisplayName": "205",
"avatar": "https://mircea.workezuce.ro/sipxconfig/rest/avatar/205"
}
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__42076_131641563
__RefHeading__42076_131641563
View phone book page by page

...

Specific Response Codes: N/A
HTTP Method: GET
Phonebook representation, page by page, returns users from start-row to end-row. Useful for large size phonebooks (thousands of users)
Example: XML format
<phonebook>
<size>5</size>
<filtered-size>5</filtered-size>
<start-row>1</start-row>
<end-row>2</end-row>
<show-on-phone>n/a</show-on-phone>
<google-domain>gmail.com</google-domain>
<entries>
<entry>
<id>-1</id>
<first-name>John</first-name>
<last-name>Smith</last-name>
<number>201</number>
<contact-information>
<homeAddress/>
<officeAddress/>
<imId>georgen</imId>
<imDisplayName>John Smith</imDisplayName>
<avatar>
https://john.work-ezuce.ro/sipxconfig/rest/avatar/201
</avatar>
</contact-information>
</entry>
</entries>
</phonebook>
JSON format
{"phonebook": {
"size": 1,
"filteredsize": 1,
"startrow": 0,
"endrow": 1,
"showonphone": "n/a",
"googledomain": "gmail.com",

Wiki Markup
"entries": \[


{
"id": "1",
"number": "205",
"contactinformation": {
"homeAddress": {},
"officeAddress": {},
"imId": "205",
"imDisplayName": "205",
"avatar": "https://mircea.workezuce.ro/sipxconfig/rest/avatar/205"
}
}
]
}}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__24177_958082936
__RefHeading__24177_958082936
Private phone book entries

...

Wiki Markup
\{"phonebook": \[


{
"first-name": "FirstName1",
"last-name": "LastName1",
"number": "200",
"contact-information": {}
},
{
"first-name": "FirstName2",
"last-name": "LastName2",
"number": "201",
"contact-information": {}
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__24181_958082936
__RefHeading__24181_958082936
Create or delete a private phone book

...

Wiki Markup
\{"updatePhones":false,"canSubscribeToPresence":true,"buttons":\[\],"groupSpeedDial":false\}


HTTP Method: PUT
Saves the modified speed dial preferences
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__24197_958082936
__RefHeading__24197_958082936
Activate active greeting

...

Wiki Markup
\{"conferences": \[


{
"enabled": true,
"name": "myConf",
"description": "description",
"extension": "22123",
"accessCode": "555"
}
]}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__24203_958082936
__RefHeading__24203_958082936
View conference details

...

Specific Response Codes:
Error 404 - when {confName} not found
Error 403 - when authenticated user is not owner of {confName}
Error 406 - when {confName} is found but not active (no participant in conference)
HTTP Method: GET
Returns conference details including members and details about members that are participants in conference XML, JSON
If the 'confName' does not exist or the conference is not active (no participants) then an error is returned
Example: XML format
<conference>
<extension>555</extension>
<description>desc</description>
<locked>false</locked>
<members>
<member>
<id>1</id>
<name>200</name>
<imId>200im</imId>
<uuid>33ee33ee</uuid>
<volumeIn>0</volumeIn>
<volumeOut>0</volumeOut>
<energyLevel>30</energyLevel>
<canHear>true</canHear>
<canSpeak>true</canSpeak>
</member>
<member>
<id>1</id>
<name>201</name>
<imId>201im</imId>
<uuid>333eee333</uuid>
<volumeIn>0</volumeIn>
<volumeOut>0</volumeOut>
<energyLevel>30</energyLevel>
<canHear>true</canHear>
<canSpeak>false</canSpeak>
</member>
</members>
</conference>
JSON format
{"conference": {
"extension": "555",
"description": "desc",
"locked": false,

Wiki Markup
"members": \[


{
"id": 1,
"name": "200",
"imId": "200im",
"uuid": "33ee33ee",
"volumeIn": 0,
"volumeOut": 0,
"energyLevel": 30,
"canHear": true,
"canSpeak": true
},
{
"id": 1,
"name": "201",
"imId": "201im",
"uuid": "333eee333",
"volumeIn": 0,
"volumeOut": 0,
"energyLevel": 30,
"canHear": true,
"canSpeak": false
}
]
}}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__24205_958082936
__RefHeading__24205_958082936
View conference settings for all users

...

Wiki Markup
\{"conferences": \[


{
"enabled": true,
"name": "myConf",
"description": "description",
"extension": "22123",
"accessCode": "555"
}
]}
Unsupported HTTP Method: POST, DELETE

Anchor
__RefHeading__24207_958082936
__RefHeading__24207_958082936
View user conference details

...

Wiki Markup
"im-locations": \[


{
"fqdn": "mircea.work-ezuce.ro"
}
]
}
Unsupported HTTP Method: PUT, POST, DELETE

Anchor
__RefHeading__42528_958082936
__RefHeading__42528_958082936
Keep session alive

...

Wiki Markup
_<conference name> (<member_count> member\[s\]\[locked\]),_


where locked can represent either the locked or unlockes status of the conference.
The following items are a separated list in CSV format for each conference leg:

Item

Description

ID of participant

 

Register string of participants

 

UUID of participants call leg

 

Caller ID number

 

Caller ID name

 

Status

Options are:

  • Hear - The mute/unmute status of the member.
  • Speak - The "deaf /undeaf" status of the member.
  • Talking - The input channel is providing some amount of sound energy.
  • Video - Providing video?
  • Floor - This member currently owns the floor.

Volume In

 

Volume Out

 

Energy Level

 

...