Grandstream Networks UCM630X Series - API Queries Supported

To Next Page

To Previous Page

P a g e | 475

UCM630X Series User Manual

Version 1.0.11.10

• REC API

• PMS API

API Queries Supported

The new API supports now new queries listed below which will accomplish certain requests and get data about

different modules on UCM630X.

Table 124: New API Supported Queries

Queries Supported

getSystemStatus

getSystemGeneralStatus

listAccount

getSIPAccount

updateSIPAccount

listVoIPTrunk

addSIPTrunk

getSIPTrunk

updateSIPTrunk

deleteSIPTrunk

listOutboundRoute

addOutboundRoute

getOutboundRoute

updateOutboundRoute

deleteOutboundRoute

Main Page

Default Chapter4
- Table of Contents4
Document Purpose41
Change Log42
- Firmware Version 1.0.11.1042
- Firmware Version 1.0.11.942
- Firmware Version 1.0.9.1043
- Firmware Version 1.0.7.1243
- Firmware Version 1.0.7.943
- Firmware Version 1.0.5.444
- Firmware Version 1.0.3.1045
- Firmware Version 1.0.2.2547
Welcome48
Product Overview50
- Technical Specifications50
- Table 1: Technical Specifications50
Installation55
- Equipment Packaging55
- Connect Your UCM630X (UCM6301 as an Example)55
Getting Started60
- Use the LCD Menu60
- Table 3: LCD Menu Options61
- Use the LED Indicators62
- Table 4: UCM6304/6308 LED Indicators62
- Figure 10: Ports Status62
- Using the Web UI63
- Setting up an Extension67
- Figure 14: UCM630X Web GUI Language67
- Figure 15: Web GUI Search Bar67
System Settings69
- General Settings69
- Table 5: General Settings Parameters69
- Figure 16: General Settings Interface69
- IM Settings70
- HTTP Server72
- Table 7: IM Server Parameters72
- Table 8: HTTP Server Settings72
- Network Settings74
- Openvpn90
- Table 14: UCM630X System Settings→Network Settings→Openvpn90
- DDNS Settings91
- Figure 29: Open VPN® Feature on the UCM630X91
- Figure 30: Register Domain Name on Noip.com92
- Figure 31: UCM630X DDNS Setting93
- Figure 32: Using Domain Name to Connect to UCM630X93
- Security Settings94
- LDAP Server104
- Time Settings113
- Email Settings118
Provisioning130
- Overview130
- Configuration Architecture for End Point Device130
- Auto-Provisioning Settings131
- Figure 61: Zero Config Configuration Architecture for End Point Device131
- Figure 62: UCM630X Zero Config132
- Table 28: Auto Provision Settings133
- Figure 63: Auto Provision Settings133
- Discovery135
- Figure 64: Auto Discover135
- Uploading Devices List136
- Managing Discovered Devices136
- Figure 65: Discovered Devices136
- Figure 66: Device List - CSV File Sample136
- Figure 67: Managing Discovered Devices137
- Global Configuration138
  - Global Policy138
  - Table 29: Global Policy Parameters - Localization139
  - Figure 68: Global Policy Categories139
  - Table 30: Global Policy Parameters - Phone Settings140
  - Table 31: Global Policy Parameters - Contact List141
  - Table 32: Global Policy Parameters - Maintenance143
  - Table 33: Global Policy Parameters - Network Settings146
  - Table 34: Global Policy Parameters - Customization147
  - Table 35: Global Policy Parameters - Communication Settings149
  - Global Templates150
  - Table 36: Create New Template150
  - Figure 69: Edit Global Template151
- Model Configuration152
  - Model Templates152
  - Table 37: Create New Model Template152
  - Model Update154
  - Figure 70: Edit Model Template154
  - Figure 71: OEM Models155
- Device Configuration156
  - Figure 72: Template Management156
  - Figure 73: Upload Model Template Manually156
  - Create New Device157
  - Figure 74: Create New Device157
  - Figure 75: Manage Devices158
  - Manage Devices158
  - Figure 76: Edit Device159
  - Figure 77: Edit Customize Device Settings161
  - Figure 78: Modify Selected Devices - same Model162
  - Figure 79: Modify Selected Devices - Different Models162
- Sample Application163
- Figure 80: Device List in Zero Config163
- Figure 81: Zero Config Sample - Global Policy164
- Figure 82: Zero Config Sample - Device Preview 1165
- Figure 83: Zero Config Sample - Device Preview 2166
- Figure 84: Zero Config Sample - Device Preview 3167
Extensions168
- Create New User168
  - Create New SIP Extension168
  - Figure 85: Create New Device168
  - Table 38: SIP Extension Configuration Parameters→Basic Settings169
  - Table 39: SIP Extension Configuration Parameters→Media172
  - Table 40: SIP Extension Configuration Parameters→Features173
  - Table 41: SIP Extension Configuration Parameters→Specific Time181
  - Table 42: Table 34: SIP Extension Configuration Parameters→Follow Me181
  - Create New IAX Extension182
  - Table 43: IAX Extension Configuration Parameters→Basic Settings182
  - Table 44: IAX Extension Configuration Parameters→Media184
  - Table 45: IAX Extension Configuration Parameters→Features184
  - Table 46: IAX Extension Configuration Parameters→Specific Time188
  - Create New FXS Extension189
  - Table 47: IAX Extension Configuration Parameters→Follow Me189
  - Table 48: FXS Extension Configuration Parameters→Basic Settings190
  - Table 49: FXS Extension Configuration Parameters→Media191
  - Table 50: FXS Extension Configuration Parameters→Features193
  - Table 51: FXS Extension Configuration Parameters→Specific Time197
  - Table 52: FXS Extension Configuration Parameters→Follow Me198
- Batch Add Extensions199
  - Batch Add SIP Extensions199
  - Table 53: Batch Add SIP Extension Parameters199
  - Batch Add IAX Extensions208
  - Table 54: Batch Add IAX Extension Parameters209
- Batch Extension Resetting Functionality214
- Search and Edit Extension215
- Figure 86: Manage Extensions215
- Export Extensions216
- Figure 87: Export Extensions216
- Import Extensions217
- Figure 88: Import Extensions217
- Table 55: SIP Extensions Imported File Example218
- Figure 89: Import File218
- Table 56: IAX Extensions Imported File Example221
- Table 57: FXS Extensions Imported File Example224
- Extension Details227
- Figure 90: Import Error227
- E-Mail Notification228
- Figure 91: Extension Details228
- Figure 92: E-Mail Notification - Prompt Information228
- Figure 93: Account Registration Information229
- Figure 94: Wave Settings and QR Code229
- Multiple Registrations Per Extension230
- Figure 95: Multiple Registrations Per Extension230
- SMS Message Support231
- Figure 96: Extension - Concurrent Registration231
- Figure 97: SMS Message Support231
Extension Groups232
- Configure Extension Groups232
- Using Extension Groups233
- Figure 98: Edit Extension Group233
- Figure 99: Select Extension Group in Outbound Route233
Analog Trunks234
- Analog Trunk Configuration234
- Table 58: Analog Trunk Configuration Parameters234
- PSTN Detection239
- Figure 100: UCM630X FXO Tone Settings240
- Figure 101: UCM630X PSTN Detection240
- Figure 102: UCM630X PSTN Detection: Auto-Detect241
- Figure 103: UCM630X PSTN Detection: Semi-Auto Detect241
- Table 59: PSTN Detection for Analog Trunk242
Voip Trunks244
- Voip Trunk Configuration244
- Table 60: Create New SIP Trunk244
- Table 61: SIP Register Trunk Configuration Parameters247
- Table 62: SIP Peer Trunk Configuration Parameters252
- Table 63: Create New IAX Trunk256
- Table 64: IAX Register Trunk Configuration Parameters257
- Table 65: IAX Peer Trunk Configuration Parameters258
- Trunk Groups259
- Figure 104: Trunk Group259
- Direct Outward Dialing (DOD)260
- Figure 105: Trunk Group Configuration260
- Figure 106: DOD Extension Selection262
- Figure 107: Edit DOD262
Sla Station263
- Create/Edit SLA Station263
- Table 66: SLA Station Configuration Parameters263
- Figure 108: SLA Station263
- Sample Configuration264
- Figure 109: Enable SLA Mode for Analog Trunk264
- Figure 110: Analog Trunk with SLA Mode Enabled265
- Figure 111: SLA Example - SLA Station265
- Figure 112: SLA Example - MPK Configuration265
Call Routes267
- Outbound Routes267
- Inbound Routes276
Fax Server292
- Configure Fax/T.38292
- Figure 133: Fax Settings292
- Table 71: FAX/T.38 Settings293
- Receiving Fax295
- FAX Sending299
- Figure 140: List of Fax Files299
- Figure 141: Fax Sending in Web GUI300
- Figure 142: Fax Send Progress300
Multimedia Meeting301
- Multimedia Room Configurations302
- Table 72: Conference Room Configuration Parameters302
- Table 73: Conference Settings304
- Multimedia Meeting Call Operations305
- Meeting Schedule311
- Figure 149: Schedule Meeting Interface311
- Table 75: Scheduled Meeting Parameters312
- Figure 150: Meetings Schedule314
- Figure 151: Meeting Details315
- Figure 152: Meeting Scheduled - Ongoing315
- Meeting Recordings316
- Figure 153: Meeting Schedule - Completed316
- Call Statistics317
- Figure 154: Meeting Recordings317
- Figure 155: Meeting Call Statistics317
- Figure 156: Meeting Report on Web317
- Figure 157: Meeting Report on CSV318
Ivr319
- Configure IVR319
- Table 76: IVR Configuration Parameters319
- Figure 158: Create New IVR319
- Black/Whitelist in IVR323
- Figure 159: Key Pressing Events323
- Create Custom Prompt325
- Figure 160: Black/Whitelist325
- Key Pressing Events326
- Figure 161: Click on Prompt to Create IVR Prompt326
- Figure 162: Key Pressing Events326
- Figure 163: Specific Time327
Language Settings for Voice Prompt328
- Download and Install Voice Prompt Package328
- Figure 164: Language Settings for Voice Prompt328
- Figure 165: Voice Prompt Package List329
- Figure 166: New Voice Prompt Language Added329
- Customize Specific Prompt330
- Username Prompt Customization330
Voicemail332
- Configure Voicemail332
- Figure 168: Voicemail Settings332
- Table 77: Voicemail Settings333
- Access Voicemail335
- Table 78: Voicemail IVR Menu335
- Leaving Voicemail337
- Voicemail Email Settings337
- Table 79: Voicemail Email Settings337
- Configure Voicemail Group338
- Figure 169: Voicemail Email Settings338
- Table 80: Voicemail Group Settings339
- Figure 170: Voicemail Group339
Ring Group341
- Configure Ring Group341
- Table 81: Ring Group Parameters341
- Figure 171: Ring Group341
- Remote Extension in Ring Group345
- Figure 172: Ring Group Configuration345
- Figure 173: Sync LDAP Server Option346
- Figure 174: Manually Sync LDAP Server346
- Figure 175: Ring Group Remote Extension347
Restrict Calls348
- Configure Restrict Calls348
- Figure 176: Restrict Calls348
Paging and Intercom Group349
- Configure Paging/Intercom Group349
- Configure a Scheduled Paging/Intercom357
- Table 86: Schedule Paging / Intercom Settings357
- Figure 182: Schedule Paging/Intercom Page357
- Figure 183: Creating a Scheduled Paging/Intercom Call358
Operator Panel359
- Configure Operator Panel359
- Table 87: Operator Panel Settings359
- Figure 184: Operator Panel Configuration Page359
Call Queue361
- Configure Call Queue361
- Figure 185: Call Queue361
- Table 88: Call Queue Configuration Parameters362
- Table 89: Static Agent Limitation366
- Figure 186: Agent Login Settings366
- Call Center Settings and Enhancements367
- Table 90: Call Center Parameters367
- Call Queue Statistics369
- Figure 187: Call Queue Statistics370
- Figure 188: Queue's Call Log Details371
- Figure 189: Automatic Download Settings - Queue Statistics371
- Figure 190: Agent Details372
- Figure 191: Login Record373
- Figure 192: Pause Log373
- Switchboard374
- Figure 193: Switchboard Summary374
- Table 91: Switchboard Parameters375
- Figure 194: Call Queue Switchboard375
- Figure 195: Queue Chairman376
- Global Queue Settings377
- Figure 196: Queue Agent377
- Figure 197: Global Queue Settings377
- Table 92: Global Queue Settings378
Pickup Groups379
- Configure Pickup Groups379
- Figure 198: Pickup Groups Interface379
- Configure Pickup Feature Code380
- Figure 199: Edit Pickup Group380
- Figure 200: Edit Pickup Feature Code381
Music on Hold382
- Figure 201: Music on Hold Default Class382
- Figure 202: Play Custom Prompt383
- Figure 203: Information Prompt384
- Figure 204: Record Custom Prompt384
Busy Camp-On386
Presence387
- Figure 205: SIP Presence Configuration387
- Table 93: SIP Presence Status388
- Figure 206: SIP Presence Feature Code389
- Figure 207: Presence Status CDR389
Follow Me390
- Figure 208: Edit Follow Me390
- Table 94: Follow Me Settings391
- Table 95: Follow Me Options392
Speed Dial393
- Figure 209: Speed Dial Destinations393
- Figure 210: List of Speed Dial394
Disa395
- Figure 211: Create New DISA395
- Table 96: DISA Settings396
Emergency397
- Figure 212: Emergency Number Configuration398
- Table 97: Emergency Numbers Parameters399
- Figure 213: 911 Emergency Sample400
Callback401
- Table 98: Callback Configuration Parameters401
Blf and Event List403
- Blf403
- Event List403
- Table 99: Event List Settings403
- Figure 214: Create New Event List404
Dial by Name406
- Dial by Name Configuration406
- Figure 215: Create Dial by Name Group406
- Figure 216: Configure Extension First Name and Last Name407
- Figure 217: Dial by Name Group in IVR Key Pressing Events408
- Figure 218: Dial by Name Group in Inbound Rule409
Active Calls and Monitor410
- Active Calls Status410
- Figure 219: Status→Pbx Status→Active Calls - Ringing410
- Figure 220: Status→Pbx Status→Active Calls - Call Established410
- Figure 221: Call Connection Less than Half Hour411
- Figure 222: Call Connection between Half an Hour and One Hour411
- Hang up Active Calls412
- Call Monitor412
- Figure 223: Call Connection more than One Hour412
- Figure 224: Configure to Monitor an Active Call412
Call Features414
- Feature Codes414
- Table 100: UCM630X Feature Codes414
- Parking Lot421
- Figure 225: Enable/Disable Feature Codes421
- Figure 226: Parking Lot421
- Table 101 : Parking Lot422
- Figure 227: New Parking Lot422
- Call Park423
  - Park a Call423
  - Retrieve Parked Call423
  - Monitor Call Park CID Name Information (Gxp21Xx, Grp261X Phones Only)424
- Call Recording424
- Figure 228: Monitored Call Park CID Name424
- Figure 229: Download Recording File from CDR Page424
- Enable Spy425
- Shared Call Appearance (SCA)425
- Figure 230: Download Recording File from Recording Files Page425
- Figure 231: Enabling SCA Option under Extension's Settings426
- Figure 232: SCA Number Configuration426
- Figure 233: SCA Private Number Configuration427
- Figure 234: SCA Options427
- Table 102: Add SCA Private Number428
- Table 103: Editing the SCA Number428
Announcement430
- Table 104: Announcement Parameters430
- Figure 235: Announcement Settings430
Pbx Settings431
- PBX Settings/General Settings431
- Table 105: Internal Options/General431
- PBX Settings/Rtp Settings434
- PBX Settings/Voice Prompt Customization437
- PBX Settings/ Call Failure Tone Settings439
- PBX Settings/ File Storage Management441
- Figure 240: General Call Failure Prompts441
- Figure 241: Settings→File Storage Management441
- Figure 242: Recordings Storage Prompt Information442
- Figure 243: Recording Storage Category442
- PBX Settings/Nas443
- Table 108: NAS Settings443
Sip Settings444
- SIP Settings/General444
- Table 109: SIP Settings/General444
- SIP Settings/Misc445
- Table 110: SIP Settings/Misc445
- SIP Settings/Session Timer446
- SIP Settings/Tcp and TLS446
- Table 111: SIP Settings/Session Timer446
- Table 112: SIP Settings/Tcp and TLS446
- SIP Settings/Nat447
- Table 113: SIP Settings/Nat447
- SIP Settings/Tos448
- Table 114: SIP Settings/Tos448
- SIP Settings/Stir/Shaken450
- Figure 244:SIP Settings/Stir/Shaken - Add Authentication Number450
- Table 115: SIP Settings/Stir/Shaken - Add Authentication Number Settings451
- Table 116: SIP Settings/Stir/Shaken - Certificate Settings452
- Figure 245: SIP Settings/Stir/Shaken - Certificate Settings452
- Transparent Call-Info Header453
- Figure 246: Transparent Call-Info453
Iax Settings454
- IAX Settings/General454
- Table 117: IAX Settings/General454
- IAX Settings/Registration455
- Table 118: IAX Settings/Registration455
- IAX Settings/Security456
- Table 119: IAX Settings/Static Defense456
Interface Settings457
- Analog Hardware457
- Figure 247: FXS Ports Signaling Preference457
- Figure 248: FXO Ports ACIM Settings457
- Table 120: PBX Interface Settings458
- DAHDI Settings459
- Figure 249: DAHDI Settings459
Iot Device Management461
- IPC Devices461
- Table 121: IPC Devices Settings461
- Figure 250: IPC Devices461
- Figure 251: IPC Devices Settings462
UCM Remoteconnect463
- Figure 252: Remoteconnect463
- Figure 253: Remote Diagnosis464
- Figure 254: UCM Remoteconnect - Effective Plan465
- Plan Settings465
- Figure 255: UCM Remoteconnect Plan Settings466
- Figure 256: UCM SIP Extensions Synchronized to GDMS467
- Figure 257: Integrated Customer Service SDK Interface468
- Integrated Customer Service SDK468
- UI Customization468
- Figure 258: UI Customization469
- Statistics469
- Figure 259: Concurrent Remote Calls470
Ucm6300'S Wave APP471
- Figure 260: Grandstream Wave Interface471
- Figure 261: Download Wave Client472
Api Configuration473
- API Configuration Parameters473
- Upload Voice Prompt Via API478
- Figure 262: Upload Prompt User Configuration478
Cti Server480
- Figure 263: CTI Server Listening Port480
Asterisk Manager Interface (Restricted Access)481
Crm Integration482
- Sugarcrm482
- Table 126: Sugarcrm Settings482
- Figure 264: Sugarcrm Basic Settings482
- Figure 265: CRM User Settings483
- Vtigercrm484
- Table 127: Vtigercrm Settings484
- Figure 266: Vtigercrm Basic Settings484
- Zohocrm485
- Figure 267: CRM User Settings485
- Table 128: Zohocrm Settings486
- Figure 268: Zohocrm Basic Settings486
- Figure 269: CRM User Settings487
- Salesforce CRM488
- Table 129: Salesforce Settings488
- Figure 270: Salesforce Basic Settings488
- Act! Crm489
- Figure 271: Salesforce User Settings489
- Figure 272: Enabling ACT! CRM490
- Figure 273: Enabling CRM on the User Portal490
Pms Integration491
- Table 130: PMS Supported Features491
Wakeup Service502
- Wake up Service Using Admin Login502
- Figure 287: Create New Wakeup Service502
- Table 135: Wakeup Service503
- Table 136: Max Wakeup Members503
- Wake up Service from User Portal504
- Wake up Service Using Feature Code504
Announcements Center505
- Figure 288: Announcements Center505
- Announcements Center Settings506
- Group Settings506
- Table 137: Announcements Center Settings506
- Table 138: Group Settings506
- Figure 289: Announcements Center Group Configuration507
- Figure 290: Announcements Center Code Configuration508
- Figure 291: Announcements Center Example508
Queue Metrics509
- Table 139: Queue Metrics Configuration Parameters509
- Figure 292: Queue Metrics509
Status and Reporting510
- PBX Status510
- System Status514
- System Events519
- Cdr528
User Portal542
- Figure 322: Edit User Information by Super Admin542
- Figure 323: User Portal Login543
- Figure 324: User Portal Layout543
- Basic Information544
- Personal Data544
- Value-Added Features544
Maintenance545
- User Management545
  - User Information545
  - Table 149: User Management→Create New User545
  - Figure 325: User Management Page Display545
  - Figure 326: Create New User545
  - Multi-Factor Authentication546
  - Figure 327: User Management - New Users546
  - Custom Privilege547
  - Figure 328: MFA Settings547
  - Figure 329: Assign Backup Permission to "Admin" Users548
  - Figure 330: General User549
  - Concurrent Multi-User Login551
  - Figure 331: Create New Custom Privilege551
  - Figure 332: Multiple User Operation Error Prompt551
- Address Book Management552
  - Contact Management552
  - Figure 333: Extension Contacts552
  - Table 150: Extension Contact Settings553
  - Figure 334: Edit Extension Contact553
  - Figure 335: External Contacts554
  - Department Management555
  - Figure 336: Import External Contacts555
  - Figure 337: Department Management555
  - Figure 338: Edit Department556
  - Table 151: Extension Contact Settings557
  - Figure 339: External Contacts557
  - Figure 340: Import External Contacts558
  - Figure 341: Department Management559
- Login Settings560
  - Change Password560
  - Figure 342: Edit Department560
  - Change Username561
  - Figure 343: Change Password561
  - Change Binding Email562
  - Login Security562
  - Table 152: Change Binding Email Option562
  - Figure 344: Change Username562
  - Figure 345: Change Binding Email562
- Operation Log563
- Figure 346: Login Timeout Settings563
- Table 153: Operation Log Column Header564
- Figure 347: Operation Logs564
- Upgrading565
  - Figure 348: Operation Logs Filter565
  - Figure 349: Local Upgrade566
  - Figure 350: Upgrading Firmware Files566
  - Figure 351: Reboot UCM630X566
  - No Local Firmware Servers566
- Backup567
  - Backup/Restore567
  - Figure 352: Create New Backup568
  - Figure 353: Restore Warning569
  - Figure 354: Backup / Restore569
  - Data Sync570
  - Figure 355: Local Backup570
  - Table 154: Data Sync Configuration571
  - Figure 356: Data Sync571
  - Restore Configuration from Backup File572
- System Cleanup/Reset573
  - Reset and Reboot573
  - Figure 357: Restore UCM630X from Backup File573
  - Cleaner574
  - Figure 358: Reset and Reboot574
  - Figure 359: Manual Cleaning575
  - Figure 360: Automatic Cleaning576
  - USB/SD Card Files Cleanup580
  - Figure 361: USB/SD Card Files Cleanup580
- System Recovery581
- Figure 362: UCM6302 Recovery Web Page581
- Syslog582
- Figure 363: Recovery Mode582
- Network Troubleshooting583
  - Ethernet Capture583
  - Figure 364: Ethernet Capture584
  - IP Ping585
  - Traceroute586
  - Figure 365: Ping586
  - Figure 366: Traceroute586
  - Record Meeting for Diagnosis587
- Signaling Troubleshooting587
  - Analog Record Trace587
  - Figure 367: Record Meeting for Diagnosis587
  - Figure 368: Troubleshooting Analog Trunks588
- Service Check589
- Figure 369: a Key Dial-Up FXO589
- Network Status590
- Figure 370: Service Check590
- Figure 371: Network Status590
Experiencing the Ucm630X Series Ip Pbx591

Grandstream Networks UCM630X Series - API Queries Supported

Table of Contents

Other manuals for Grandstream Networks UCM630X Series

Related product manuals