Grandstream Networks, Inc.

Grandstream Networks, Inc.

UCM6510/UCM62xx Series HTTPS API Guide

Table of Contents

INTRODUCTION............................................................................................................. 9

API BASICS.................................................................................................................. 10

Configuring the API ................................................................................................................................ 10 Enabling PBX API Interface ........................................................................................................... 10 Server Configuration ...................................................................................................................... 11 Login Restrictions........................................................................................................................... 11

Communication ...................................................................................................................................... 12 Communication Protocol ................................................................................................................ 12 JSON data into HTTP request ....................................................................................................... 12 Communication Method ................................................................................................................. 12

Version Control ...................................................................................................................................... 12 Operation Log ........................................................................................................................................ 13

API QUERIES ............................................................................................................... 14

ESTABLISHING CONNECTION AND USER AUTHENTICATION ............................... 16

Challenge ............................................................................................................................................... 16 Login ...................................................................................................................................................... 17

DATA DEFINITION........................................................................................................ 19

Request Data ......................................................................................................................................... 19 Response Data ...................................................................................................................................... 19

OPERATION METHODS .............................................................................................. 20

Get System Configuration...................................................................................................................... 20 getSystemStatus ............................................................................................................................ 20 getSystemGeneralStatus ............................................................................................................... 21

Extension ............................................................................................................................................... 22 listAccount ...................................................................................................................................... 22 getSIPAccount................................................................................................................................ 25 updateSIPAccount.......................................................................................................................... 40

Trunk ...................................................................................................................................................... 53 listVoIPTrunk .................................................................................................................................. 53 addSIPTrunk................................................................................................................................... 55

UCM6XXX: HTTPS API Guide

Page | 2

getSIPTrunk.................................................................................................................................... 56 updateSIPTrunk ............................................................................................................................. 64 deleteSIPTrunk............................................................................................................................... 72 listAnalogTrunk............................................................................................................................... 73 addAnalogTrunk ............................................................................................................................. 75 getAnalogTrunk .............................................................................................................................. 77 updateAnalogTrunk ........................................................................................................................ 80 deleteAnalogTrunk ......................................................................................................................... 81 addSLATrunk .................................................................................................................................. 82 updateSLATrunk ............................................................................................................................. 83 listDigitalTrunk ................................................................................................................................ 84 addDigitalTrunk .............................................................................................................................. 86 getDigitalTrunk ............................................................................................................................... 87 updateDigitalTrunk ......................................................................................................................... 89 deleteDigitalTrunk .......................................................................................................................... 90 Outbound Route..................................................................................................................................... 91 listOutboundRoute ......................................................................................................................... 91 addOutboundRoute........................................................................................................................ 93 getOutboundRoute ......................................................................................................................... 96 updateOutboundRoute................................................................................................................. 100 deleteOutboundRoute .................................................................................................................. 102 Inbound Route ..................................................................................................................................... 103 listInboundRoute .......................................................................................................................... 103 addInboundRoute......................................................................................................................... 107 getInboundRoute.......................................................................................................................... 114 updateInboundRoute.................................................................................................................... 120 deleteInboundRoute..................................................................................................................... 125 playPromptByOrg................................................................................................................................. 126 Voice Call ............................................................................................................................................. 127 listBridgedChannels ..................................................................................................................... 127 listUnBridgedChannels................................................................................................................. 129 Hangup......................................................................................................................................... 130 Callbarge ...................................................................................................................................... 131 Mute ............................................................................................................................................. 132 Unmute......................................................................................................................................... 133 Hold .............................................................................................................................................. 134

UCM6XXX: HTTPS API Guide

Page | 3

Unhold .......................................................................................................................................... 135 DialExtension ............................................................................................................................... 135 DialOutbound ............................................................................................................................... 136 CallTransfer .................................................................................................................................. 137 TransferNumberInbound .............................................................................................................. 138 TransferNumberOutbound ........................................................................................................... 139 DialIVR ......................................................................................................................................... 140 DialIVROutbound ......................................................................................................................... 141 DialQueue .................................................................................................................................... 142 DialRinggroup .............................................................................................................................. 142 DialOutboundTwo......................................................................................................................... 143 refuseCall ..................................................................................................................................... 144 AcceptCall .................................................................................................................................... 145 Call Queue ........................................................................................................................................... 146 listQueue ...................................................................................................................................... 146 getQueue ..................................................................................................................................... 148 updateQueue ............................................................................................................................... 156 addQueue .................................................................................................................................... 162 deleteQueue................................................................................................................................. 169 loginLogoffQueueAgent ............................................................................................................... 169 pauseUnpauseQueueAgent......................................................................................................... 170 Paging/Intercom ................................................................................................................................... 171 addPaginggroup ........................................................................................................................... 171 listPaginggroup ............................................................................................................................ 173 getPaginggroup ............................................................................................................................ 175 updatePaginggroup...................................................................................................................... 177 deletePaginggroup ....................................................................................................................... 179 MulticastPaging ............................................................................................................................ 180 MulticastPagingHangup ............................................................................................................... 180 IVR ....................................................................................................................................................... 181 addIVR ......................................................................................................................................... 181 listIVR ........................................................................................................................................... 185 getIVR .......................................................................................................................................... 189 updateIVR .................................................................................................................................... 192 deleteIVR ..................................................................................................................................... 196 User Information .................................................................................................................................. 197

UCM6XXX: HTTPS API Guide

Page | 4

listUser ......................................................................................................................................... 197 getUser......................................................................................................................................... 200 updateUser................................................................................................................................... 202 Extension Groups ................................................................................................................................ 203 listExtensionGroup ....................................................................................................................... 203 listPinSets .................................................................................................................................... 205 cdrapi ................................................................................................................................................... 206 Recapi .................................................................................................................................................. 209 Pmsapi ................................................................................................................................................. 210 Queueapi.............................................................................................................................................. 217 applyChanges ...................................................................................................................................... 219

ERROR RETURN CODES.......................................................................................... 220

Table of Figures

Figure 1: API Flow ......................................................................................................................................... 9 Figure 2: HTTPS API Settings..................................................................................................................... 10 Figure 3: HTTP Server Settings .................................................................................................................. 11 Figure 4: Operation Log .............................................................................................................................. 13

Table of Tables

Table 1: New API Configuration Parameters............................................................................................... 10 Table 2: New API Supported Queries ......................................................................................................... 14 Table 3: Challenge ...................................................................................................................................... 16 Table 4: Login .............................................................................................................................................. 17 Table 5: getSystemStatus ........................................................................................................................... 20 Table 6: getSystemGeneralStatus .............................................................................................................. 21 Table 7: listAccount ..................................................................................................................................... 23 Table 8: getSIPAccount ............................................................................................................................... 29 Table 9: updateSIPAccount ......................................................................................................................... 41 Table 10: listVoIPTrunk................................................................................................................................ 54

UCM6XXX: HTTPS API Guide

Page | 5

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download