Broker Function Calls
12/21/2023 5:10 pm EST
// Broker Functions
#define BRKFUNC_GET_PROCESS_TAG 0
#define BRKFUNC_REGISTER_THREAD 1
#define BRKFUNC_DEREGISTER_THREAD 2
#define BRKFUNC_KEEPALIVE 3
#define BRKFUNC_REGISTER_SESSION 10
#define BRKFUNC_DEREGISTER_SESSION 11
#define BRKFUNC_ADOPT_SESSION 12
#define BRKFUNC_GET_USR_FOR_ALARM 13
#define BRKFUNC_REGISTER_VIRT_SESSION 14
#define BRKFUNC_KEEPALIVE_VIRT_SESSION 15
#define BRKFUNC_DEREGISTER_VIRT_SESSION 16
#define BRKFUNC_SET_INSTNO_LIST 17
#define BRKFUNC_STORE_ACCESS 20
#define BRKFUNC_VALIDATE_ACCESS 21
#define BRKFUNC_LOCK_FACILITY 30
#define BRKFUNC_UNLOCK_FACILITY 31
#define BRKFUNC_CHECK_LOCK_FACILITY 32
#define BRKFUNC_CHECK_LOCK 33
//#define BRKFUNC_NEXT_NOTIFY 40
#define BRKFUNC_NOTIFY_LIST 41
#define BRKFUNC_GET_TIME 50
#define BRKFUNC_GET_BUSY_INDEX 51
#define BRKFUNC_SET_UPDATE_NEXT_SEQ 60
#define BRKFUNC_GET_NEXT_SEQ 61
#define BRKFUNC_REGISTER_HANDLER 70
#define BRKFUNC_DEREGISTER_HANDLER 71
#define BRKFUNC_SP_INSERT_ALARM 80
#define BRKFUNC_SP_CANCEL_ALARM 81
#define BRKFUNC_SP_DELETE_ALARM 82
#define BRKFUNC_SP_COMMIT_ROLLBACK 83
#define BRKFUNC_SP_INSERT_SIGNAL 84
#define BRKFUNC_SP_COUNT_ALARMS 85
#define BRKFUNC_SP_PROGRESSING 86
#define BRKFUNC_SP_CHECK_MON_GRP 87
#define BRKFUNC_SP_UPDATE_FEP 88
#define BRKFUNC_SP_UPDATE_ALARM 89
#define BRKFUNC_ALLOCATE_ALARM 90
#define BRKFUNC_ALLOCATE_NEXT_ALARM 91
#define BRKFUNC_DEALLOCATE_ALARM 92
#define BRKFUNC_DEALLOCATE_ALL_ALARMS 93
#define BRKFUNC_UPDATE_ALARM 94
#define BRKFUNC_DELETE_ALARM 95
#define BRKFUNC_ALARM_STATUS 96
#define BRKFUNC_PRELOAD_ALARM 97
#define BRKFUNC_PROGRESS_ALARM 98
#define BRKFUNC_DO_QUEUE_UPDATE 99 // More alarm calls at 290
#define BRKFUNC_SET_EVENT_MASK 100
#define BRKFUNC_DECLARE_EVENT 101
#define BRKFUNC_DECLARE_WATCHDOG_EVENT 102
#define BRKFUNC_DECLARE_REVCMD_EVENT 103
#define BRKFUNC_ACTIONS_EVENT 104
#define BRKFUNC_PRELOAD_WDOGMESS 107
#define BRKFUNC_UPDATE_WDOGMESS 108
#define BRKFUNC_REGISTER_COUNTS 110
#define BRKFUNC_DEREGISTER_COUNTS 111
#define BRKFUNC_REGISTER_STATS 112
#define BRKFUNC_DEREGISTER_STATS 113
#define BRKFUNC_SET_LOGMON_VALS 114
#define BRKFUNC_SET_PRI_EVENT_CENTRE 115
#define BRKFUNC_ACTIVE_PRI_EVENT_CENTRE 116
#define BRKFUNC_GET_REVCMD_UNIQUE_ID 117
#define BRKFUNC_REGISTER_TRACK 120
#define BRKFUNC_DEREGISTER_TRACK 121
#define BRKFUNC_CREATE_SERVER 130
#define BRKFUNC_DELETE_SERVER 131
#define BRKFUNC_UPDATE_SERVER 132
#define BRKFUNC_FIND_BEST_SERVER 133
#define BRKFUNC_RETIRE_SERVER 134
#define BRKFUNC_SET_INFO 140
#define BRKFUNC_GET_INFO 141
#define BRKFUNC_SET_PRIMARY_DB 142
#define BRKFUNC_REFRESH_LICENSE 143
#define BRKFUNC_SET_CONFIG_OPTIONS 144
#define BRKFUNC_SET_WEB_MEMBER_DB 145
#define BRKFUNC_GET_WEB_MEMBER_DB 146
#define BRKFUNC_CREATE_FEP 150
#define BRKFUNC_DELETE_FEP 151
#define BRKFUNC_KEEPALIVE_FEP 153
#define BRKFUNC_INCONTACT_FEP 154
#define BRKFUNC_LOSTCONTACT_FEP 155
#define BRKFUNC_GET_LSEQ_FEP 156
#define BRKFUNC_GET_FEP_ADDRESS 157
#define BRKFUNC_CHECKOUT_LICENSE_FEP 158
#define BRKFUNC_SET_BROKER_STATE 160
#define BRKFUNC_CLOSE_DOWN 161
#define BRKFUNC_GET_BROKER_STATE 162
#define BRKFUNC_GET_LIST_INFO 170
#define BRKFUNC_GET_SESS_LIST_INFO 171
#define BRKFUNC_SET_LOG_LEVEL 180
#define BRKFUNC_DELETE_WRKSTN 182
#define BRKFUNC_UPDATE_WRKSTN 183
#define BRKFUNC_STATUS_WRKSTN 184
#define BRKFUNC_PRELOAD_WRKSTN 185
#define BRKFUNC_GET_OWS_FOR_SESSION 186
#define BRKFUNC_PRELOAD_OPTION 190
#define BRKFUNC_UPDATE_OPTION 191
#define BRKFUNC_DELETE_OPTION 192
#define BRKFUNC_IS_OPTION_ENABLED 193
#define BRKFUNC_PRELOAD_MONGRP 200
#define BRKFUNC_ADD_MONGRP 201
#define BRKFUNC_DELETE_MONGRP 202
#define BRKFUNC_PRELOAD_APPTYPE 210
#define BRKFUNC_UPDATE_APPTYPE 211
#define BRKFUNC_DELETE_APPTYPE 212
#define BRKFUNC_PRELOAD_DEVCONF 220
#define BRKFUNC_UPDATE_DEVCONF 221
#define BRKFUNC_DELETE_DEVCONF 222
#define BRKFUNC_PRELOAD_DEVCONF_D 223
#define BRKFUNC_UPDATE_DEVCONF_D 224
#define BRKFUNC_DELETE_DEVCONF_D 225
#define BRKFUNC_GET_CURRENT_SENTRY 226
#define BRKFUNC_GET_DEVCONF_D 227
#define BRKFUNC_SET_CLIENT_TYPE 230
#define BRKFUNC_NO_CLIENTS_CONNECTED 231
#define BRKFUNC_FEP_CHANGE_OCCURRED 240
#define BRKFUNC_GET_CURRENT_CONF 241
#define BRKFUNC_GET_PROC_LIST_STATUS 242
#define BRKFUNC_UPDATE_OOS_STATS 243
#define BRKFUNC_BROADCAST_USR_MSG 250
#define BRKFUNC_BROADCAST_USR_GRP_MSG 251
#define BRKFUNC_REGISTER_USR_SESSION 252
#define BRKFUNC_DECLARE_SESS_MSG 253
#define BRKFUNC_GET_TRACKING_FOR_USR 260
#define BRKFUNC_GET_TRACKING_FOR_MONGRP 261
#define BRKFUNC_GET_TRACKING_FOR_SYSTEM 262
#define BRKFUNC_CANCEL_TRACKING_ENTRY 263
#define BRKFUNC_ADOPT_TRACKING_ENTRY 264
#define BRKFUNC_INSERT_TRACKING_ENTRY 265
#define BRKFUNC_GET_ALARMS_BY_TRACKING 266
#define BRKFUNC_CANCEL_TRKG_ALARM 267
#define BRKFUNC_GET_TRKG_FOR_CUST 268
#define BRKFUNC_ADOPT_LIMBO_TRACKING 269
#define BRKFUNC_GIVE_TRACKING_TO_WRKSTN 288 // # Jumps // TODO: Fix #
#define BRKFUNC_ADOPT_LIMBO_TRACKING_BY_WRKSTN 289 // # Jumps // TODO: Fix #
#define BRKFUNC_PRELOAD_CUSTOMER 270
#define BRKFUNC_ADD_CUSTOMER 271
#define BRKFUNC_DELETE_CUSTOMER 272
#define BRKFUNC_GET_CUSTOMER 273
#define BRKFUNC_REGISTER_VRT_LINES 280
#define BRKFUNC_DEREGISTER_VRT_LINES 281
// ....
// See BRKFUNC_GIVE_TRACKING_TO_WRKSTN 288
// See BRKFUNC_ADOPT_LIMBO_TRACKING_BY_WORKSTNUID 289
// ....
#define BRKFUNC_UPDATE_ALARM_STORM 290
#define BRKFUNC_ALARM_RESET_SUSP_TIME 291
#define BRKFUNC_ALARM_PRECANCEL 292
#define BRKFUNC_ALARM_PAGEDCONT 293
#define BRKFUNC_GET_ALARM_HANDLERS 294
#define BRKFUNC_ALARM_SET_MORE_ACTIVITY 295
#define BRKFUNC_ALARM_GET_MORE_ACTIVITY 296
#define BRKFUNC_ALARM_GET_SUSPAUTOREVCMD 297
#define BRKFUNC_GET_ALARMS_FOR_SESSION 298
#define BRKFUNC_LICENSE_FEP 300
#define BRKFUNC_LICENSE_USR 301
#define BRKFUNC_LICENSE_MONGRP 302
#define BRKFUNC_LICENSE_OPTIONS 303
#define BRKFUNC_LICENSE_EVENT_CENTRE 304
#define BRKFUNC_LICENSE_CUSTOMER 305
#define BRKFUNC_LICENSE_INSTALLER 306
#define BRKFUNC_LICENSE_EFF_DATES 307
#define BRKFUNC_LICENSE_WEB_LIMITS 308
#define BRKFUNC_LICENSE_INFO 309
#define BRKFUNC_LICENSE_VRT_LIMITS 310
#define BRKFUNC_LICENSE_WINPAK_GTWYS 311
#define BRKFUNC_LICENSE_MEDIA_GTWYS 312
#define BRKFUNC_LICENSE_XML_DRIVERS 313
#define BRKFUNC_LICENSE_EXPIRY 314
#define BRKFUNC_LICENSE_PBX_AUTODIALERS 315
#define BRKFUNC_LICENSE_PBX_SERVER_AUTOMATION 316
#define BRKFUNC_LICENSE_USR_COUNT 317
//#define BRKFUNC_LICENSE_PBX_ASSISTANT_LINES 316
//#define BRKFUNC_LICENSE_TWO_WAY_PLUS_LINES 317
//#define BRKFUNC_LICENSE_STEALTH_LOGGER 318
//#define BRKFUNC_LICENSE_AUTO_TEXT 319
//#define BRKFUNC_LICENSE_OPEN_VOICE_OUTBOUND 400 // NOTE: # jumps!
//#define BRKFUNC_LICENSE_OPEN_VOICE_INBOUND 401
//#define BRKFUNC_LICENSE_SOLO_PROTECT 402
//#define BRKFUNC_LICENSE_PBX_ASSISTANT 403
//#define BRKFUNC_LICENSE_LINE_CHECK 404
//#define BRKFUNC_LICENSE_TWO_WAY_PLUS 405
//#define BRKFUNC_LICENSE_UNIVERSAL_CONNECTOR 406
//#define BRKFUNC_LICENSE_CHANNEL_BANK 407
//#define BRKFUNC_LICENSE_SOCIAL_MEDIA 408
#define BRKFUNC_CALL_SESSION_PRELOAD 320
#define BRKFUNC_CALL_SESSION_ADD 321
#define BRKFUNC_CALL_SESSION_REMOVE 322
#define BRKFUNC_CALL_SESSION_UPD_CALLSTATUS 323
#define BRKFUNC_CALL_SESSION_UPD_EXTENSION 324
#define BRKFUNC_CALL_SESSION_UPD_KADETAILS 325
#define BRKFUNC_CALL_SESSION_GET_CALL_SESSION_NO 326
#define BRKFUNC_CALL_SESSION_GET_STATUS 327
#define BRKFUNC_CALL_SESSION_ALLOCATE_CALL 328
#define BRKFUNC_CALL_SESSION_DECLARE_EVENT_AVAIL 329
#define BRKFUNC_CALL_SESSION_DROPCALL 330
#define BRKFUNC_CALL_SESSION_ADD_EX 331
#define BRKFUNC_CALL_SESSION_ADOPT 332
#define BRKFUNC_CALL_SESSION_GET_INFO 333
#define BRKFUNC_CALL_SESSION_ADD_MULTI_RCVR 334
#define BRKFUNC_CALL_SESSION_PRELOAD_MULTI_RCVR 335
#define BRKFUNC_PBXASSIST_GET_SESSION_LIST 340
#define BRKFUNC_PBXASSIST_UPDATE_SESSION_AGENTAVAIL 341
#define BRKFUNC_PBXASSIST_UPDATE_SESSION_AGENTSTATE 342
#define BRKFUNC_PBXASSIST_UPDATE_SESSION_AGENTSTATE_BY_SERVER 343
#define BRKFUNC_PBXASSIST_UPDATE_ACD_QUEUE 344
#define BRKFUNC_PBXASSIST_NOTIFY_CALL_AVAIL 345
#define BRKFUNC_PBXASSIST_NOTIFY_CALL_DROPPED 346
#define BRKFUNC_PBXASSIST_REJECT_CALL 347
#define BRKFUNC_PBXASSIST_PLAY_MESSAGE 348
#define BRKFUNC_PBXASSIST_HOLD_CALL 349
#define BRKFUNC_PBXASSIST_RETRIEVE_CALL 350
#define BRKFUNC_PBXASSIST_ACK_DROP_CALL 351
#define BRKFUNC_MAX 352 // Must be highest broker call number plus 1!
Was this article helpful?
Thank you for your feedback!