UC2.0 API

Link to Swagger documentation.

Auth via Oauth tokens, request one via POST /oauth2/user-credentials.
For client_id use external.{company_name} (change {company_name} to your company name and grant_type=password

Tokens in url

Key Value
adSyncId \d+
argumentId \d+
attemptId \d+
audioType wav|mp3
avatarId \d+
calendarId \d+
callHistoryId \d+
callRoutingId \d+
callRoutingItemId \d+
call_guid [a-fA-F0-9]{32,40}
callbackActionId \d+
callbackAgentId \d+
callbackCalendarId \d+
callbackCategoryId \d+
callbackEntryId \d+
callbackTemplateId \d+
callbackTriggerId \d+
callerId \d+
calleridRouteId \d+
groupId \d+
cdrQueueId \d+
channelId [s0-9_\-\.]+
crmEntryId \d+
audioFrom alaw|mp3|wav
audioTo alaw|mp3|wav
cellE164 [\+\d ]+
chatMessageId \d+
chatRoomId \d+
cidId \d+
companyId \d+
contactId \d+
columnId \d+
destinationAgentId \d+
destinationColumnId \d+
destinationEntryId \d+
destinationId \d+
deviceId \d+
didId \d+
downloadFile [\-_0-9a-z]+\.[a-z0-9]+
dummyId \d+
e164 [\+\d ]+
exceptionId \d+
favoriteId \d+
fieldId \d+
fileType csv|pdf|html|xlsx
hotelId \d+
iconType png|svg
id \d+
instanceId [0-9a-f-]{36}
itemId \d+
teamsPresenceId \d+
tenantId [0-9a-f-]{36}
transcriptId \d+
keyValueId \d+
languageRouteId \d+
imageType png|jpg
mailboxId \d+
communicatorPlatform stable|beta|alpha
communicatorOs linux|osx|windows
communicatorVersion v1|v2
communicatorArch x86|arm64
brandingName [0-9a-z]+
licenseName [0-9a-zA-Z\_]+
profileId \d+
qsCallUniqueId [a-z0-9]+[\.\-][0-9a-zA-Z\.\-]+
queueCallerId \d+
queueId \d+
queueMemberId \d+
recordingId \d+
reportTypeId \d+
roomId \d+
scheduleId \d+
serverId \d+
serviceId \d+
setProfileType force|override
simno \d+
smsId \d+
soundId \d+
subscriptionId \d+
templateType mobile|desktop|teams
timezoneId \d+
topup \d+
unreadType recording|voicemail|chatmessage|callhistory|chatroom
userId \d+
userId2 \d+
userIs alias
userIsWhat [^/]+
voicemailId [0-9a-zA-Z\-\_]+
wallboardId \d+
which [0-9a-zA-Z]+
webhookId \d+
webhookToken [0-9a-z]{64}
accountId \d+

Routes

Name Accountread
Raw url /account/{accountId}
Allowed methods ALL
Description Allowed body fields


Name Accountupdate
Raw url /account/{accountId}
Allowed methods ALL
Description Allowed body fields
  • [number]
  • [status]


Name AccountoriginateCall
Raw url /account/{accountId}/call
Allowed methods ALL
Description Allowed body fields
  • exten
  • [priority]
  • [timeout]
  • [callerid]
  • [async]


Name acl.Groupcreate
Raw url /acl/group
Allowed methods ALL
Description Allowed body fields
  • title
  • [pbx_company_id]
  • [list_type]
  • [parent_acl_group_id]


Name acl.Groupread
Raw url /acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name acl.Groupupdate
Raw url /acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields
  • [title]
  • [list_type]


Name acl.Groupdelete
Raw url /acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name acl.group.Announcementbrowse
Raw url /acl/group/{groupId}/announcement
Allowed methods ALL
Description Allowed body fields


Name acl.group.Announcementcreate
Raw url /acl/group/{groupId}/announcement
Allowed methods ALL
Description Allowed body fields
  • pbx_app_announcement_id
  • permission


Name acl.group.Announcementupdate
Raw url /acl/group/{groupId}/announcement/{id}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.Cfcbrowse
Raw url /acl/group/{groupId}/cfc
Allowed methods ALL
Description Allowed body fields


Name acl.group.Cfccreate
Raw url /acl/group/{groupId}/cfc
Allowed methods ALL
Description Allowed body fields
  • pbx_app_cfc_id
  • permission


Name acl.group.Cfcupdate
Raw url /acl/group/{groupId}/cfc/{id}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.Cfcdelete
Raw url /acl/group/{groupId}/cfc/{id}
Allowed methods ALL
Description Allowed body fields


Name acl.group.CmsDepartmentbrowse
Raw url /acl/group/{groupId}/cmsdepartment
Allowed methods ALL
Description Allowed body fields


Name acl.group.CmsDepartmentcreate
Raw url /acl/group/{groupId}/cmsdepartment
Allowed methods ALL
Description Allowed body fields
  • [cms_department_id]
  • [permission]


Name acl.group.CmsDepartmentupdate
Raw url /acl/group/{groupId}/cmsdepartment/{id}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.Ivrbrowse
Raw url /acl/group/{groupId}/ivr
Allowed methods ALL
Description Allowed body fields


Name acl.group.Ivrcreate
Raw url /acl/group/{groupId}/ivr
Allowed methods ALL
Description Allowed body fields
  • pbx_app_ivr_id
  • permission


Name acl.group.Ivrupdate
Raw url /acl/group/{groupId}/ivr/{id}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.GroupNSpacebrowse
Raw url /acl/group/{groupId}/namespace
Allowed methods ALL
Description Allowed body fields


Name acl.GroupNSpacecreate
Raw url /acl/group/{groupId}/namespace
Allowed methods ALL
Description Allowed body fields
  • namespace


Name acl.GroupNSpacedelete
Raw url /acl/group/{groupId}/namespace/{namespace}
Allowed methods ALL
Description Allowed body fields


Name acl.GroupPermissionbrowse
Raw url /acl/group/{groupId}/permission
Allowed methods ALL
Description Allowed body fields


Name acl.GroupPermissioncreate
Raw url /acl/group/{groupId}/permission
Allowed methods ALL
Description Allowed body fields
  • permission
  • permission_template_id


Name acl.group.QueueMonitorbrowse
Raw url /acl/group/{groupId}/queuemonitor
Allowed methods ALL
Description Allowed body fields


Name acl.group.QueueMonitorcreate
Raw url /acl/group/{groupId}/queuemonitor
Allowed methods ALL
Description Allowed body fields
  • ast_queue_id
  • permission


Name acl.group.QueueMonitorupdate
Raw url /acl/group/{groupId}/queuemonitor/{queueId}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.QueueMonitordelete
Raw url /acl/group/{groupId}/queuemonitor/{queueId}
Allowed methods ALL
Description Allowed body fields


Name acl.group.Tbrbrowse
Raw url /acl/group/{groupId}/tbr
Allowed methods ALL
Description Allowed body fields


Name acl.group.Tbrcreate
Raw url /acl/group/{groupId}/tbr
Allowed methods ALL
Description Allowed body fields
  • pbx_app_tbr_id
  • permission


Name acl.group.Tbrupdate
Raw url /acl/group/{groupId}/tbr/{id}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.Userbrowse
Raw url /acl/group/{groupId}/user
Allowed methods ALL
Description Allowed body fields


Name acl.group.Usercreate
Raw url /acl/group/{groupId}/user
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • permission


Name acl.group.Userupdate
Raw url /acl/group/{groupId}/user/{userId}
Allowed methods ALL
Description Allowed body fields
  • permission


Name acl.group.Userdelete
Raw url /acl/group/{groupId}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name acl.permission.Templatebrowse
Raw url /acl/permission/template
Allowed methods ALL
Description Allowed body fields


Name acl.Permissionupdate
Raw url /acl/permission/{permissionId}
Allowed methods ALL
Description Allowed body fields
  • [permission]


Name acl.Permissiondelete
Raw url /acl/permission/{permissionId}
Allowed methods ALL
Description Allowed body fields


Name audio.Convertconvert
Raw url /audio-convert/{audioFrom}/to/{audioTo}
Allowed methods ALL
Description Allowed body fields


Name Calendarcreate
Raw url /calendar
Allowed methods ALL
Description Allowed body fields
  • name
  • type


Name CalendarreadSchedule
Raw url /calendar/schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields


Name CalendarbrowseSchedules
Raw url /calendar/schedules
Allowed methods ALL
Description Allowed body fields


Name Calendarread
Raw url /calendar/{calendarId}
Allowed methods ALL
Description Allowed body fields


Name Calendarupdate
Raw url /calendar/{calendarId}
Allowed methods ALL
Description Allowed body fields
  • name


Name Calendardelete
Raw url /calendar/{calendarId}
Allowed methods ALL
Description Allowed body fields


Name Schedulecreate
Raw url /calendar/{calendarId}/schedule
Allowed methods ALL
Description Allowed body fields
  • [name]
  • start
  • end
  • [repeat]
  • [repeat_every]
  • [repeat_every_end]
  • [recurrence]
  • [force_pbx_destination_id]


Name Scheduleread
Raw url /calendar/{calendarId}/schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields


Name Scheduleupdate
Raw url /calendar/{calendarId}/schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [start]
  • [end]
  • [repeat]
  • [repeat_every]
  • [repeat_every_end]
  • [pbx_calendar_id]
  • [recurrence]
  • [force_pbx_destination_id]


Name Scheduledelete
Raw url /calendar/{calendarId}/schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields


Name ScheduledeleteAtTimestamp
Raw url /calendar/{calendarId}/schedule/{scheduleId}/at-timestamp
Allowed methods ALL
Description Allowed body fields


Name Schedulebrowse
Raw url /calendar/{calendarId}/schedules
Allowed methods ALL
Description Allowed body fields


Name CallHistorydelete
Raw url /call/history/{callHistoryId}
Allowed methods ALL
Description Allowed body fields


Name callback.Actionupdate
Raw url /callback/action/{callbackActionId}
Allowed methods ALL
Description Allowed body fields
  • [action]
  • [value]
  • [pbx_callback_entry_data_key]


Name callback.Actiondelete
Raw url /callback/action/{callbackActionId}
Allowed methods ALL
Description Allowed body fields


Name callback.Agentupdate
Raw url /callback/agent/{callbackAgentId}
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_id]
  • [pbx_account_id]


Name callback.Agentdelete
Raw url /callback/agent/{callbackAgentId}
Allowed methods ALL
Description Allowed body fields


Name callback.agent.Entrycall
Raw url /callback/agent/{destinationAgentId}/entry/{destinationEntryId}/call
Allowed methods ALL
Description Allowed body fields
  • [override_pbx_account_id]


Name callback.Attemptcreate
Raw url /callback/attempt
Allowed methods ALL
Description Allowed body fields
  • agentId
  • entryId


Name callback.attempt.Logbrowse
Raw url /callback/attempt/{attemptId}/log
Allowed methods ALL
Description Allowed body fields


Name callback.attempt.Logcreate
Raw url /callback/attempt/{attemptId}/log
Allowed methods ALL
Description Allowed body fields
  • [header]
  • [text]


Name callback.attempt.TriggerrunTrigger
Raw url /callback/attempt/{attemptId}/trigger/{callbackTriggerId}
Allowed methods ALL
Description Allowed body fields


Name callback.Attemptread
Raw url /callback/attempt/{callbackAttemptId}
Allowed methods ALL
Description Allowed body fields


Name callback.Categoryupdate
Raw url /callback/category/{callbackCategoryId}
Allowed methods ALL
Description Allowed body fields
  • [category]
  • [default]
  • [sort]


Name callback.Categorydelete
Raw url /callback/category/{callbackCategoryId}
Allowed methods ALL
Description Allowed body fields


Name callback.Columnupdate
Raw url /callback/column/{destinationColumnId}
Allowed methods ALL
Description Allowed body fields
  • [column]
  • [source]
  • [transform]
  • [transform_params]
  • [align]
  • [sort]


Name callback.Columndelete
Raw url /callback/column/{destinationColumnId}
Allowed methods ALL
Description Allowed body fields


Name callback.data.Templatebrowse
Raw url /callback/data/template
Allowed methods ALL
Description Allowed body fields


Name callback.data.Transformbrowse
Raw url /callback/data/transform
Allowed methods ALL
Description Allowed body fields


Name callback.Destinationread
Raw url /callback/destination/{destinationId}
Allowed methods ALL
Description Allowed body fields


Name callback.Destinationupdate
Raw url /callback/destination/{destinationId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [type]
  • [max_per_day]
  • [no_slots_pbx_soundfile_id]
  • [no_slots_pbx_destination_id]
  • [get_personal_number]
  • [get_case_number]
  • [allow_duplicates]
  • [force_enter_cid]
  • [pbx_destination_id]
  • [allow_reuse_slots]
  • [allow_web_booking]
  • [web_booking_percent]
  • [entry_notice_seconds]
  • [entry_notification_email]
  • [web_booking_use_captcha]


Name callback.Destinationdelete
Raw url /callback/destination/{destinationId}
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Agentbrowse
Raw url /callback/destination/{destinationId}/agent
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Agentcreate
Raw url /callback/destination/{destinationId}/agent
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • [pbx_account_id]


Name callback.destination.Categorybrowse
Raw url /callback/destination/{destinationId}/category
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Categorycreate
Raw url /callback/destination/{destinationId}/category
Allowed methods ALL
Description Allowed body fields
  • category
  • [default]
  • [sort]


Name callback.destination.Columnbrowse
Raw url /callback/destination/{destinationId}/column
Allowed methods ALL
Description Allowed body fields
  • [column]
  • [source]
  • [transform]
  • [transform_params]
  • [align]
  • [sort]


Name callback.destination.Columncreate
Raw url /callback/destination/{destinationId}/column
Allowed methods ALL
Description Allowed body fields
  • column
  • source
  • [transform]
  • [transform_params]
  • [align]
  • [sort]


Name callback.destination.data.Templatebrowse
Raw url /callback/destination/{destinationId}/data/template
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Entrybrowse
Raw url /callback/destination/{destinationId}/entry
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Entrycreate
Raw url /callback/destination/{destinationId}/entry
Allowed methods ALL
Description Allowed body fields
  • data
  • [categories]


Name callback.destination.entry.Historybrowse
Raw url /callback/destination/{destinationId}/entry/history
Allowed methods ALL
Description Allowed body fields


Name callback.destination.entry.Logbrowse
Raw url /callback/destination/{destinationId}/entry/{destinationEntryId}/log
Allowed methods ALL
Description Allowed body fields


Name callback.destination.entry.Logcreate
Raw url /callback/destination/{destinationId}/entry/{destinationEntryId}/log
Allowed methods ALL
Description Allowed body fields
  • text


Name callback.DestinationgetBookableTimes
Raw url /callback/destination/{destinationId}/getbookabletimes
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Schedulebrowse
Raw url /callback/destination/{destinationId}/schedule
Allowed methods ALL
Description Allowed body fields


Name callback.destination.slot.Calendarbrowse
Raw url /callback/destination/{destinationId}/slot/calendar
Allowed methods ALL
Description Allowed body fields


Name callback.destination.slot.Calendarcreate
Raw url /callback/destination/{destinationId}/slot/calendar
Allowed methods ALL
Description Allowed body fields
  • slot_count
  • slot_count_per
  • agent_count
  • [name]
  • [pbx_color_id]
  • [priority]


Name callback.destination.Triggerbrowse
Raw url /callback/destination/{destinationId}/trigger
Allowed methods ALL
Description Allowed body fields


Name callback.destination.Triggercreate
Raw url /callback/destination/{destinationId}/trigger
Allowed methods ALL
Description Allowed body fields
  • pbx_color_id
  • label
  • [sort]
  • [status]
  • [hangup]


Name callback.destination.user.Agentbrowse
Raw url /callback/destination/{destinationId}/user/{userId}/agent
Allowed methods ALL
Description Allowed body fields


Name callback.Entryread
Raw url /callback/entry/{callbackEntryId}
Allowed methods ALL
Description Allowed body fields


Name callback.Entryupdate
Raw url /callback/entry/{callbackEntryId}
Allowed methods ALL
Description Allowed body fields
  • [status]
  • [slot_booked]


Name callback.entry.Eventbrowse
Raw url /callback/entry/{callbackEntryId}/event
Allowed methods ALL
Description Allowed body fields


Name callback.Entrymove
Raw url /callback/entry/{callbackEntryId}/move
Allowed methods ALL
Description Allowed body fields
  • pbx_app_callback_destination_id


Name callback.entry.SMScreate
Raw url /callback/entry/{callbackEntryId}/sms
Allowed methods ALL
Description Allowed body fields
  • number
  • sender
  • body


Name callback.entry.Attemptbrowse
Raw url /callback/entry/{destinationEntryId}/attempt
Allowed methods ALL
Description Allowed body fields


Name callback.entry.Logbrowse
Raw url /callback/entry/{destinationEntryId}/log
Allowed methods ALL
Description Allowed body fields


Name callback.slot.Calendarread
Raw url /callback/slot/calendar/{callbackCalendarId}
Allowed methods ALL
Description Allowed body fields


Name callback.slot.Calendarupdate
Raw url /callback/slot/calendar/{callbackCalendarId}
Allowed methods ALL
Description Allowed body fields
  • [slot_count]
  • [slot_count_per]
  • [agent_count]
  • [name]
  • [pbx_color_id]
  • [priority]


Name callback.slot.Calendardelete
Raw url /callback/slot/calendar/{callbackCalendarId}
Allowed methods ALL
Description Allowed body fields


Name callback.Triggerupdate
Raw url /callback/trigger/{callbackTriggerId}
Allowed methods ALL
Description Allowed body fields
  • [pbx_color_id]
  • [label]
  • [sort]
  • [status]
  • [hangup]


Name callback.Triggerdelete
Raw url /callback/trigger/{callbackTriggerId}
Allowed methods ALL
Description Allowed body fields


Name callback.trigger.Actioncreate
Raw url /callback/trigger/{callbackTriggerId}/action
Allowed methods ALL
Description Allowed body fields
  • action
  • value
  • pbx_callback_entry_data_key


Name callback.trigger.Actionbrowse
Raw url /callback/trigger/{callbackTriggerId}/action
Allowed methods ALL
Description Allowed body fields


Name callback.user.Agentupdate
Raw url /callback/user/{userId}/agent
Allowed methods ALL
Description Allowed body fields
  • [pbx_account_id]


Name callback.user.Entrycall
Raw url /callback/user/{userId}/entry/{destinationEntryId}/call
Allowed methods ALL
Description Allowed body fields
  • [override_pbx_account_id]


Name callback.WebBookingbook
Raw url /callback/webbooking/{id}/book
Allowed methods ALL
Description Allowed body fields
  • data
  • [captcha-response]
  • [domain]


Name callback.WebBookinggetTimes
Raw url /callback/webbooking/{id}/times
Allowed methods ALL
Description Allowed body fields


Name Cfcread
Raw url /cfc/{id}
Allowed methods ALL
Description Allowed body fields


Name Cfcupdate
Raw url /cfc/{id}
Allowed methods ALL
Description Allowed body fields
  • [state]
  • [pbx_soundfile_id_on]
  • [pbx_soundfile_id_off]


Name CfcSoundbrowse
Raw url /cfc/{id}/sound
Allowed methods ALL
Description Allowed body fields


Name CfcSoundcreate
Raw url /cfc/{id}/sound
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]


Name CfcSounddownloadFile
Raw url /cfc/{id}/sound/{soundId}/file/{audioType}
Allowed methods ALL
Description Allowed body fields


Name Channelbridge
Raw url /channel/{channelId1}/bridge/{channelId2}
Allowed methods ALL
Description Allowed body fields


Name Channeljoin
Raw url /channel/{channelId1}/join/{channelId2}
Allowed methods ALL
Description Allowed body fields


Name Channelmerge
Raw url /channel/{channelId1}/merge/{channelId2}
Allowed methods ALL
Description Allowed body fields


Name ChannelgetChannel
Raw url /channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name ChanneldeleteChannel
Raw url /channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name ChannelanswerChannel
Raw url /channel/{channelId}/answer
Allowed methods ALL
Description Allowed body fields


Name Channelatxfer
Raw url /channel/{channelId}/atxfer
Allowed methods ALL
Description Allowed body fields
  • exten


Name ChannelatxferCancel
Raw url /channel/{channelId}/atxfer
Allowed methods ALL
Description Allowed body fields


Name ChannelatxferTransfer
Raw url /channel/{channelId}/atxfer/transfer
Allowed methods ALL
Description Allowed body fields


Name ChannelplayDTMF
Raw url /channel/{channelId}/dtmf
Allowed methods ALL
Description Allowed body fields
  • digit


Name ChannelholdChannel
Raw url /channel/{channelId}/hold
Allowed methods ALL
Description Allowed body fields


Name ChanneldeleteHold
Raw url /channel/{channelId}/hold
Allowed methods ALL
Description Allowed body fields


Name ChannelmoveToAccount
Raw url /channel/{channelId}/move-to/account
Allowed methods ALL
Description Allowed body fields
  • pbx_account_id


Name ChannelmuteChannel
Raw url /channel/{channelId}/mute
Allowed methods ALL
Description Allowed body fields


Name ChanneldeleteMute
Raw url /channel/{channelId}/mute
Allowed methods ALL
Description Allowed body fields


Name ChannelrecordChannel
Raw url /channel/{channelId}/record
Allowed methods ALL
Description Allowed body fields


Name Channeltransfer
Raw url /channel/{channelId}/transfer
Allowed methods ALL
Description Allowed body fields
  • exten


Name ChannelwaitOn
Raw url /channel/{channelId}/waiton/{userId}
Allowed methods ALL
Description Allowed body fields


Name ChanneldeleteChannelsByGuid
Raw url /channels/by/guid/{call_guid}
Allowed methods ALL
Description Allowed body fields


Name ChatMessageread
Raw url /chat/message/{chatMessageId}
Allowed methods ALL
Description Allowed body fields


Name ChatMessagedelete
Raw url /chat/message/{chatMessageId}
Allowed methods ALL
Description Allowed body fields


Name ChatMessageupdate
Raw url /chat/message/{chatMessageId}
Allowed methods ALL
Description Allowed body fields
  • message


Name ChatRoomcreate
Raw url /chat/room
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [users]


Name ChatRoomread
Raw url /chat/room/{chatRoomId}
Allowed methods ALL
Description Allowed body fields


Name ChatRoomupdate
Raw url /chat/room/{chatRoomId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_user_id]


Name ChatRoomdelete
Raw url /chat/room/{chatRoomId}
Allowed methods ALL
Description Allowed body fields


Name ChatRoomcreateMessage
Raw url /chat/room/{chatRoomId}/message
Allowed methods ALL
Description Allowed body fields
  • message


Name ChatRoombrowseMessages
Raw url /chat/room/{chatRoomId}/messages
Allowed methods ALL
Description Allowed body fields


Name chatroom.Usercreate
Raw url /chat/room/{chatRoomId}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name chatroom.Userdelete
Raw url /chat/room/{chatRoomId}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name chatroom.Webhookbrowse
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods ALL
Description Allowed body fields


Name chatroom.Webhookcreate
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods ALL
Description Allowed body fields


Name chatroom.Webhookdelete
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods ALL
Description Allowed body fields


Name chatroom.Webhookread
Raw url /chat/room/{chatRoomId}/webhook/{webhookId}
Allowed methods ALL
Description Allowed body fields


Name chatroom.webhook.Messagecreate
Raw url /chat/room/{chatRoomId}/webhook/{webhookToken}/message
Allowed methods ALL
Description Allowed body fields


Name ChatRoomwriteStatus
Raw url /chat/room/{chatRoomId}/write-status
Allowed methods ALL
Description Allowed body fields
  • status


Name Colorbrowse
Raw url /color
Allowed methods ALL
Description Allowed body fields


Name Communicatordownload
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}
Allowed methods ALL
Description Allowed body fields


Name Communicatorchangelog
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}/changelog
Allowed methods ALL
Description Allowed body fields


Name Communicatorversions
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}/versions
Allowed methods ALL
Description Allowed body fields


Name Companiesbrowse
Raw url /companies
Allowed methods ALL
Description Allowed body fields


Name Companyread
Raw url /company
Allowed methods ALL
Description Allowed body fields


Name Companyupdate
Raw url /company
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [pbx_areacode_id]
  • [ast_language_id]
  • [description]


Name company.AclUserbrowse
Raw url /company/acl/group/{groupId}/users
Allowed methods ALL
Description Allowed body fields


Name company.AclUserbrowseDepartment
Raw url /company/acl/group/{groupId}/usersdepartment
Allowed methods ALL
Description Allowed body fields


Name company.Aclbrowse
Raw url /company/acl/groups
Allowed methods ALL
Description Allowed body fields


Name Companyactivate
Raw url /company/activate
Allowed methods ALL
Description Allowed body fields


Name company.Areacodebrowse
Raw url /company/areacode
Allowed methods ALL
Description Allowed body fields


Name company.auth.AzuregetToken
Raw url /company/auth/azure/codeswap
Allowed methods ALL
Description Allowed body fields


Name company.auth.AzurerenewAccessToken
Raw url /company/auth/azure/renew
Allowed methods ALL
Description Allowed body fields
  • tenant
  • id


Name company.Blogbrowse
Raw url /company/blog
Allowed methods ALL
Description Allowed body fields


Name company.Blogcreate
Raw url /company/blog
Allowed methods ALL
Description Allowed body fields
  • title
  • message


Name company.Blogread
Raw url /company/blog/{id}
Allowed methods ALL
Description Allowed body fields


Name company.callbackAgent.browse
Raw url /company/callback/agent
Allowed methods ALL
Description Allowed body fields


Name company.callbackDestination.browse
Raw url /company/callback/destination
Allowed methods ALL
Description Allowed body fields


Name company.callbackDestination.create
Raw url /company/callback/destination
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • [type]
  • [max_per_day]
  • [no_slots_pbx_soundfile_id]
  • [no_slots_pbx_destination_id]
  • [get_personal_number]
  • [get_case_number]
  • [allow_duplicates]
  • [force_enter_cid]
  • [pbx_destination_id]
  • [allow_reuse_slots]
  • [allow_web_booking]
  • [web_booking_percent]
  • [entry_notice_seconds]
  • [entry_notification_email]
  • [web_booking_use_captcha]


Name company.callbackDestination.browseTemplate
Raw url /company/callback/destination/from-template
Allowed methods ALL
Description Allowed body fields


Name company.callbackDestination.createFromTemplate
Raw url /company/callback/destination/from-template/{callbackTemplateId}
Allowed methods ALL
Description Allowed body fields


Name company.CallBlockbrowse
Raw url /company/callblock
Allowed methods ALL
Description Allowed body fields


Name company.CallBlockread
Raw url /company/callblock/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Cfcbrowse
Raw url /company/cfc
Allowed methods ALL
Description Allowed body fields


Name CompanycheckAlias
Raw url /company/checkAlias/{userId}/{alias}
Allowed methods ALL
Description Allowed body fields


Name company.Cidbrowse
Raw url /company/cid
Allowed methods ALL
Description Allowed body fields


Name company.Cidread
Raw url /company/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name company.Crmbrowse
Raw url /company/crm
Allowed methods ALL
Description Allowed body fields


Name company.Crmcreate
Raw url /company/crm
Allowed methods ALL
Description Allowed body fields
  • [crm_type]
  • [active]
  • [settings]
  • [triggers]


Name company.CrmreadActive
Raw url /company/crm/active
Allowed methods ALL
Description Allowed body fields


Name company.Crmallowed
Raw url /company/crm/allowed
Allowed methods ALL
Description Allowed body fields


Name company.Crmread
Raw url /company/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields


Name company.Crmupdate
Raw url /company/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields
  • [active]
  • [settings]
  • [triggers]


Name company.Crmdelete
Raw url /company/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields


Name company.CrmreadCaller
Raw url /company/crm/{crmEntryId}/caller
Allowed methods ALL
Description Allowed body fields


Name company.CustomerDataread
Raw url /company/customerdata
Allowed methods ALL
Description Allowed body fields


Name company.CustomerDataupdate
Raw url /company/customerdata
Allowed methods ALL
Description Allowed body fields
  • customer-data


Name company.CompanyDataread
Raw url /company/customerdata/companydata
Allowed methods ALL
Description Allowed body fields


Name company.CompanyDataupdate
Raw url /company/customerdata/companydata
Allowed methods ALL
Description Allowed body fields
  • domain_name
  • office_name
  • area
  • delivery_address
  • visiting_address
  • box_address
  • billing_address
  • directions
  • opening_hours
  • greeting
  • message_type
  • transfer_type
  • important_info
  • [sms]
  • [email]


Name company.customerdata.KeyValuecreate
Raw url /company/customerdata/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.customerdata.KeyValueupdate
Raw url /company/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.customerdata.KeyValueread
Raw url /company/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields


Name company.customerdata.KeyValuedelete
Raw url /company/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields


Name company.customerdata.UserDataread
Raw url /company/customerdata/userdata/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.customerdata.UserDataupdate
Raw url /company/customerdata/userdata/{userId}
Allowed methods ALL
Description Allowed body fields
  • title
  • place
  • manager
  • section
  • subsection
  • floor
  • building
  • room
  • plant
  • nickname
  • office
  • sales
  • location


Name company.customerdata.userdata.KeyValuecreate
Raw url /company/customerdata/userdata/{userId}/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.customerdata.userdata.KeyValuebrowse
Raw url /company/customerdata/userdata/{userId}/keyvalue
Allowed methods ALL
Description Allowed body fields


Name company.customerdata.userdata.KeyValueupdate
Raw url /company/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.customerdata.userdata.KeyValueread
Raw url /company/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields


Name company.customerdata.userdata.KeyValuedelete
Raw url /company/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields


Name Companydeactivate
Raw url /company/deactivate
Allowed methods ALL
Description Allowed body fields


Name CompanyremoveDefaultDid
Raw url /company/defaultdid
Allowed methods ALL
Description Allowed body fields


Name CompanysetDefaultDidForUnusedNumbers
Raw url /company/defaultdid/{id}
Allowed methods ALL
Description Allowed body fields


Name Companydeletable
Raw url /company/deletable
Allowed methods ALL
Description Allowed body fields


Name Companydelete
Raw url /company/delete/{answer}
Allowed methods ALL
Description Allowed body fields


Name company.Departmentbrowse
Raw url /company/department
Allowed methods ALL
Description Allowed body fields


Name company.Departmentcreate
Raw url /company/department
Allowed methods ALL
Description Allowed body fields
  • name
  • description


Name company.Departmentread
Raw url /company/department/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Departmentupdate
Raw url /company/department/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • description


Name company.Departmentdelete
Raw url /company/department/{id}
Allowed methods ALL
Description Allowed body fields


Name company.department.acl.Groupbrowse
Raw url /company/department/{id}/acl/group
Allowed methods ALL
Description Allowed body fields


Name company.department.acl.Groupcreate
Raw url /company/department/{id}/acl/group
Allowed methods ALL
Description Allowed body fields
  • group_id


Name company.department.acl.Groupdelete
Raw url /company/department/{id}/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name company.department.Userdelete
Raw url /company/department/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.department.Userupdate
Raw url /company/department/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.Didbrowse
Raw url /company/did
Allowed methods ALL
Description Allowed body fields


Name company.DidreadAvailable
Raw url /company/did/available
Allowed methods ALL
Description Allowed body fields


Name company.Didread
Raw url /company/did/{didId}
Allowed methods ALL
Description Allowed body fields


Name company.FieldTypesbrowse
Raw url /company/fieldtypes
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.GenericRecordingread
Raw url /company/generic-recordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.GenericRecordingdelete
Raw url /company/generic-recordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.GenericRecordingmp3
Raw url /company/generic-recordings/{id}/mp3
Allowed methods ALL
Description Allowed body fields


Name CompanygetDeleteQuestion
Raw url /company/getdeletequestion
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Hotelbrowse
Raw url /company/hotel
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Hotelcreate
Raw url /company/hotel
Allowed methods ALL
Description Allowed body fields
  • name
  • [extension_reception]
  • [room_can_call_reception]
  • [room_can_call_room]
  • [prefix_wakeup]
  • [prefix_cleaning]
  • [cdr_multiple]


Name company.hotel.HotelgetAvailableUsers
Raw url /company/hotel/getavailableusers
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roombrowse
Raw url /company/hotel/{hotelId}/room
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roomcreate
Raw url /company/hotel/{hotelId}/room
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • room_number
  • phone_opened


Name company.hotel.Roomread
Raw url /company/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roomupdate
Raw url /company/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_id]
  • [room_number]
  • [wakeup_failed]
  • [cleaned]


Name company.hotel.Roomdelete
Raw url /company/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomaccCleaned
Raw url /company/hotel/{hotelId}/room/{id}/cleaned
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomclosePhone
Raw url /company/hotel/{hotelId}/room/{id}/closephone
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomdownloadInvoicePDF
Raw url /company/hotel/{hotelId}/room/{id}/downloadinvoicepdf
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomdoInvoice
Raw url /company/hotel/{hotelId}/room/{id}/invoice
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomshowInvoice
Raw url /company/hotel/{hotelId}/room/{id}/invoice/{invoiceId}
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomlistInvoices
Raw url /company/hotel/{hotelId}/room/{id}/invoices
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roomlog
Raw url /company/hotel/{hotelId}/room/{id}/log
Allowed methods ALL
Description Allowed body fields


Name company.hotel.RoomopenPhone
Raw url /company/hotel/{hotelId}/room/{id}/openphone
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roomcleaned
Raw url /company/hotel/{hotelId}/room/{id}/setcleaned
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Roomwakeup
Raw url /company/hotel/{hotelId}/room/{id}/wakeup
Allowed methods ALL
Description Allowed body fields
  • [wakeup]


Name company.hotel.Hotelread
Raw url /company/hotel/{id}
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Hotelupdate
Raw url /company/hotel/{id}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [extension_reception]
  • [room_can_call_reception]
  • [room_can_call_room]
  • [prefix_wakeup]
  • [prefix_cleaning]
  • [cdr_multiple]


Name company.hotel.Hoteldelete
Raw url /company/hotel/{id}
Allowed methods ALL
Description Allowed body fields


Name company.hotel.Hotellog
Raw url /company/hotel/{id}/log
Allowed methods ALL
Description Allowed body fields


Name company.hotel.HotelisUserAvailable
Raw url /company/hotel/{userId}/isuseravailable
Allowed methods ALL
Description Allowed body fields


Name company.Invoicebrowse
Raw url /company/invoice
Allowed methods ALL
Description Allowed body fields


Name company.Invoicedetails
Raw url /company/invoice/details
Allowed methods ALL
Description Allowed body fields


Name company.Invoicedownload
Raw url /company/invoice/{id}/download
Allowed methods ALL
Description Allowed body fields


Name company.Licensecreate
Raw url /company/license
Allowed methods ALL
Description Allowed body fields
  • license_id
  • [service_id]
  • [start_cost]
  • [monthly_cost]
  • [extra_text]


Name company.Licensebrowse
Raw url /company/license
Allowed methods ALL
Description Allowed body fields


Name company.license.ServicesgetWebullServices
Raw url /company/license/services
Allowed methods ALL
Description Allowed body fields


Name company.Licensedelete
Raw url /company/license/{id}
Allowed methods ALL
Description Allowed body fields


Name company.LicensecreateWebullService
Raw url /company/license/{id}/service/create
Allowed methods ALL
Description Allowed body fields
  • service_id
  • [start_cost]
  • [monthly_cost]
  • [extra_text]


Name company.LicensedeleteWebullService
Raw url /company/license/{id}/service/delete
Allowed methods ALL
Description Allowed body fields


Name company.HasLicensehasLicense
Raw url /company/license/{licenseType}/has
Allowed methods ALL
Description Allowed body fields


Name company.Loggerbrowse
Raw url /company/logger
Allowed methods ALL
Description Allowed body fields


Name company.Loggerread
Raw url /company/logger/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.Messagebrowse
Raw url /company/messages
Allowed methods ALL
Description Allowed body fields


Name company.Mobilebrowse
Raw url /company/mobile
Allowed methods ALL
Description Allowed body fields


Name company.Mobileread
Raw url /company/mobile/{simno}
Allowed methods ALL
Description Allowed body fields


Name company.Mobileactivate
Raw url /company/mobile/{simno}/activate
Allowed methods ALL
Description Allowed body fields


Name company.Mobiledeactivate
Raw url /company/mobile/{simno}/deactivate
Allowed methods ALL
Description Allowed body fields


Name company.Mobiletopup
Raw url /company/mobile/{simno}/topup/{topup}
Allowed methods ALL
Description Allowed body fields


Name company.MobiletopupHistory
Raw url /company/mobile/{simno}/topuphistory
Allowed methods ALL
Description Allowed body fields


Name company.Overviewread
Raw url /company/overview
Allowed methods ALL
Description Allowed body fields


Name company.Partnerread
Raw url /company/partner
Allowed methods ALL
Description Allowed body fields


Name company.PbxFlowbrowse
Raw url /company/pbxflow
Allowed methods ALL
Description Allowed body fields


Name company.PbxFlowcreate
Raw url /company/pbxflow
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • items
  • users
  • [pbx_did_id]


Name company.PbxFlowread
Raw url /company/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name company.PbxFlowupdate
Raw url /company/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • items
  • users
  • [pbx_did_id]


Name company.PbxFlowdelete
Raw url /company/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name company.PingPongping
Raw url /company/pingpong
Allowed methods ALL
Description Allowed body fields


Name company.profile.Standardbrowse
Raw url /company/profile/standard
Allowed methods ALL
Description Allowed body fields


Name Company.Profilebrowse
Raw url /company/profiles
Allowed methods ALL
Description Allowed body fields


Name company.PstnNumberbrowse
Raw url /company/pstnnumber
Allowed methods ALL
Description Allowed body fields


Name company.PstnNumberupdateNumber
Raw url /company/pstnnumber/{e164}/edit
Allowed methods ALL
Description Allowed body fields
  • [SmsFixed2CellE164]
  • [callforward_congestion]
  • [callforward_always]
  • [callforward_busy]
  • [callforward_noanswer]
  • [callforward_noanswer_time]


Name company.PstnNumbersetFixedSms
Raw url /company/pstnnumber/{e164}/setsms/{cellE164}
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.PstnRecordingbrowse
Raw url /company/pstnrecordings
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.PstnRecordingdelete
Raw url /company/pstnrecordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Queuebrowse
Raw url /company/queues
Allowed methods ALL
Description Allowed body fields


Name company.QueuebrowseAll
Raw url /company/queues/all
Allowed methods ALL
Description Allowed body fields


Name company.QueueStatbrowse
Raw url /company/queuestat
Allowed methods ALL
Description Allowed body fields


Name company.QueueStatbrowseAgentData
Raw url /company/queuestat/agents
Allowed methods ALL
Description Allowed body fields


Name company.QueueStatbrowseAgentAvailability
Raw url /company/queuestat/agents/availability
Allowed methods ALL
Description Allowed body fields


Name company.queuestat.Callsbrowse
Raw url /company/queuestat/calls
Allowed methods ALL
Description Allowed body fields


Name company.queuestat.Callsexport
Raw url /company/queuestat/calls/download
Allowed methods ALL
Description Allowed body fields


Name company.queuestat.Callsread
Raw url /company/queuestat/calls/{qsCallUniqueId}
Allowed methods ALL
Description Allowed body fields


Name company.queuestat.CallsexportCallsDetail
Raw url /company/queuestat/calls/{qsCallUniqueId}/download
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.Recordingbrowse
Raw url /company/recordings
Allowed methods ALL
Description Allowed body fields


Name company.Pbx.Recordingretin
Raw url /company/recordings
Allowed methods ALL
Description Allowed body fields


Name company.Reportcreate
Raw url /company/report
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • interval
  • active
  • arguments
  • [name]
  • [description]
  • [email_link_only]


Name company.report.argument.Fieldsbrowse
Raw url /company/report/argument/fields
Allowed methods ALL
Description Allowed body fields


Name company.ReportdownloadNotSaved
Raw url /company/report/download/{format}
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • arguments
  • interval
  • [date_from]
  • [date_to]


Name company.ReportgetReportHTMLNotSaved
Raw url /company/report/html
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • [arguments]
  • interval
  • [date_from]
  • [date_to]


Name company.Reportread
Raw url /company/report/read/{id}
Allowed methods ALL
Description Allowed body fields


Name company.report.Typebrowse
Raw url /company/report/type
Allowed methods ALL
Description Allowed body fields


Name company.Reportupdate
Raw url /company/report/{id}
Allowed methods ALL
Description Allowed body fields
  • interval
  • active
  • [name]
  • [description]
  • [email_link_only]


Name company.Reportdelete
Raw url /company/report/{id}
Allowed methods ALL
Description Allowed body fields


Name company.report.Argumentcreate
Raw url /company/report/{id}/argument
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.report.Argumentupdate
Raw url /company/report/{id}/argument/{argumentId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company.report.Argumentdelete
Raw url /company/report/{id}/argument/{argumentId}
Allowed methods ALL
Description Allowed body fields


Name company.Reportdownload
Raw url /company/report/{id}/download/{format}
Allowed methods ALL
Description Allowed body fields


Name company.ReportgetReportHTML
Raw url /company/report/{id}/html
Allowed methods ALL
Description Allowed body fields


Name company.Reportsend
Raw url /company/report/{id}/send
Allowed methods ALL
Description Allowed body fields


Name company.Reportbrowse
Raw url /company/report{/reportTypeId}
Allowed methods ALL
Description Allowed body fields


Name company.Retainmentcreate
Raw url /company/retainment
Allowed methods ALL
Description Allowed body fields
  • retainment_type_id
  • value


Name company.Retainmentbrowse
Raw url /company/retainment
Allowed methods ALL
Description Allowed body fields


Name company.RetainmentTypesbrowse
Raw url /company/retainment/types
Allowed methods ALL
Description Allowed body fields


Name company.Retainmentupdate
Raw url /company/retainment/{id}
Allowed methods ALL
Description Allowed body fields
  • value


Name company.skype.Eventevent
Raw url /company/skype/event
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • event


Name company.skype.Usersusers
Raw url /company/skype/users
Allowed methods ALL
Description Allowed body fields


Name company.smsbrowse
Raw url /company/sms
Allowed methods ALL
Description Allowed body fields


Name company.smsread
Raw url /company/sms/{smsId}
Allowed methods ALL
Description Allowed body fields


Name company.Soundfilebrowse
Raw url /company/soundfile
Allowed methods ALL
Description Allowed body fields


Name company.Templatebrowse
Raw url /company/template
Allowed methods ALL
Description Allowed body fields


Name company.Templatecreate
Raw url /company/template
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • type


Name company.template.FieldbrowseAll
Raw url /company/template/field
Allowed methods ALL
Description Allowed body fields


Name company.template.Fieldbrowse
Raw url /company/template/field/{templateType}
Allowed methods ALL
Description Allowed body fields


Name company.Templateread
Raw url /company/template/{id}
Allowed methods ALL
Description Allowed body fields


Name company.Templateupdate
Raw url /company/template/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]


Name company.Templatedelete
Raw url /company/template/{id}
Allowed methods ALL
Description Allowed body fields


Name company.template.Userbrowse
Raw url /company/template/{id}/user
Allowed methods ALL
Description Allowed body fields


Name company.template.Usercreate
Raw url /company/template/{id}/user
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id


Name company.template.UserbrowseAvailable
Raw url /company/template/{id}/user/available
Allowed methods ALL
Description Allowed body fields


Name company.template.Userdelete
Raw url /company/template/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.template.Valuebrowse
Raw url /company/template/{id}/value
Allowed methods ALL
Description Allowed body fields


Name company.template.Valueupdate
Raw url /company/template/{id}/value/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • value


Name company.UserReportsbrowse
Raw url /company/userreports
Allowed methods ALL
Description Allowed body fields


Name company.UserReportsexport
Raw url /company/userreports/download
Allowed methods ALL
Description Allowed body fields


Name Company.Userbrowse
Raw url /company/users
Allowed methods ALL
Description Allowed body fields


Name company.pbx.Wallboardcreate
Raw url /company/wallboard
Allowed methods ALL
Description Allowed body fields
  • name
  • column_amount
  • theme
  • theme_color
  • timeout
  • queues_per_page
  • [unpin]
  • [expanded]


Name company.pbx.Wallboardbrowse
Raw url /company/wallboard
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardbrowseCommon
Raw url /company/wallboard/common
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardreadCommon
Raw url /company/wallboard/common/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardThemesbrowse
Raw url /company/wallboard/theme
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardThemeColorsbrowse
Raw url /company/wallboard/theme/color
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardThemeColorsread
Raw url /company/wallboard/theme/color/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardThemesread
Raw url /company/wallboard/theme/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardTokenbrowse
Raw url /company/wallboard/token
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardTokencreate
Raw url /company/wallboard/token
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id


Name company.pbx.WallboardTokenread
Raw url /company/wallboard/token/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardTokendelete
Raw url /company/wallboard/token/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.Wallboardupdate
Raw url /company/wallboard/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • column_amount
  • theme
  • theme_color
  • timeout
  • queues_per_page
  • [unpin]
  • [expanded]


Name company.pbx.Wallboarddelete
Raw url /company/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.Wallboardread
Raw url /company/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardQueuecreate
Raw url /company/wallboard/{id}/queue
Allowed methods ALL
Description Allowed body fields
  • [queue_id]
  • queue_type
  • position
  • timeout
  • [wallboard_queue_id]
  • [hidden]
  • [x]
  • [y]
  • [width]
  • [height]


Name company.pbx.WallboardQueueupdate
Raw url /company/wallboard/{id}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields
  • position
  • timeout
  • [hidden]
  • [x]
  • [y]
  • [width]
  • [height]


Name company.pbx.WallboardQueuedelete
Raw url /company/wallboard/{id}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields


Name company.pbx.WallboardDummycreate
Raw url /company/wallboard/{id}/queue/{queueId}/dummy
Allowed methods ALL
Description Allowed body fields
  • position
  • type_option
  • value_option


Name company.pbx.WallboardDummyupdate
Raw url /company/wallboard/{id}/queue/{queueId}/dummy/{dummyId}
Allowed methods ALL
Description Allowed body fields
  • position
  • type_option
  • value_option


Name company.pbx.WallboardDummydelete
Raw url /company/wallboard/{id}/queue/{queueId}/dummy/{dummyId}
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.Wallboardbrowse
Raw url /company/wallboardoutgoing
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.Wallboardcreate
Raw url /company/wallboardoutgoing
Allowed methods ALL
Description Allowed body fields
  • [id]
  • [columns]
  • [goal_amount_calls]
  • [goal_avg_talk_time]
  • [goal_total_talk_time]
  • [goal_count_higher]
  • [min_dur_calls]
  • [name]
  • [users]
  • [theme]


Name company.wallboardoutgoing.Wallboarddata
Raw url /company/wallboardoutgoing/data/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.Wallboardread
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.Wallboardupdate
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields
  • [added]
  • [columns]
  • [deleted]
  • [goal_amount_calls]
  • [goal_avg_talk_time]
  • [goal_total_talk_time]
  • [goal_sort]
  • [id]
  • [min_dur_calls]
  • [pbx_company_id]
  • [theme]
  • [name]
  • [users]
  • [goal_count_higher]


Name company.wallboardoutgoing.Wallboarddelete
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.WallboarddeleteColumn
Raw url /company/wallboardoutgoing/{wallboardId}/column/{columnId}
Allowed methods ALL
Description Allowed body fields


Name company.wallboardoutgoing.WallboarddeleteUser
Raw url /company/wallboardoutgoing/{wallboardId}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Channelbrowse
Raw url /company/webchat/channel
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Channelcreate
Raw url /company/webchat/channel
Allowed methods ALL
Description Allowed body fields
  • pbx_omnigroup_id


Name company.webchat.Channelread
Raw url /company/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Channelupdate
Raw url /company/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields
  • [added]
  • [channel_user_input]
  • [id]
  • [media_type]
  • [omni_queue]
  • [pbx_calendar_id]
  • [pbx_omnigroup_id]
  • [schedule]
  • [token]
  • [contact_email]
  • [pbx_company_id]
  • [chat_branding_id]
  • [branding]
  • [config_base64]
  • [agent_first_reserve_text_message]
  • [closed_when_no_agent_available]
  • [push_reminder_minutes]
  • [default_brand]
  • [deleted]


Name company.webchat.ChanneldeleteChannel
Raw url /company/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name company.webchat.ChanneldeleteChannelInput
Raw url /company/webchat/channel/{channelId}/{inputId}
Allowed methods ALL
Description Allowed body fields


Name company_idread
Raw url /company/{companyId}
Allowed methods ALL
Description Allowed body fields


Name company_idupdate
Raw url /company/{companyId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [pbx_areacode_id]
  • [ast_language_id]
  • [description]


Name company_id.AclUserbrowse
Raw url /company/{companyId}/acl/group/{groupId}/users
Allowed methods ALL
Description Allowed body fields


Name company_id.AclUserbrowseDepartment
Raw url /company/{companyId}/acl/group/{groupId}/usersdepartment
Allowed methods ALL
Description Allowed body fields


Name company_id.Aclbrowse
Raw url /company/{companyId}/acl/groups
Allowed methods ALL
Description Allowed body fields


Name company_idactivate
Raw url /company/{companyId}/activate
Allowed methods ALL
Description Allowed body fields


Name company_id.Areacodebrowse
Raw url /company/{companyId}/areacode
Allowed methods ALL
Description Allowed body fields


Name company_id.auth.AzuregetToken
Raw url /company/{companyId}/auth/azure/codeswap
Allowed methods ALL
Description Allowed body fields


Name company_id.auth.AzurerenewAccessToken
Raw url /company/{companyId}/auth/azure/renew
Allowed methods ALL
Description Allowed body fields
  • tenant
  • id


Name company_id.Blogbrowse
Raw url /company/{companyId}/blog
Allowed methods ALL
Description Allowed body fields


Name company_id.Blogcreate
Raw url /company/{companyId}/blog
Allowed methods ALL
Description Allowed body fields
  • title
  • message


Name company_id.Blogread
Raw url /company/{companyId}/blog/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.callbackAgent.browse
Raw url /company/{companyId}/callback/agent
Allowed methods ALL
Description Allowed body fields


Name company_id.callbackDestination.browse
Raw url /company/{companyId}/callback/destination
Allowed methods ALL
Description Allowed body fields


Name company_id.callbackDestination.create
Raw url /company/{companyId}/callback/destination
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • [type]
  • [max_per_day]
  • [no_slots_pbx_soundfile_id]
  • [no_slots_pbx_destination_id]
  • [get_personal_number]
  • [get_case_number]
  • [allow_duplicates]
  • [force_enter_cid]
  • [pbx_destination_id]
  • [allow_reuse_slots]
  • [allow_web_booking]
  • [web_booking_percent]
  • [entry_notice_seconds]
  • [entry_notification_email]
  • [web_booking_use_captcha]


Name company_id.callbackDestination.browseTemplate
Raw url /company/{companyId}/callback/destination/from-template
Allowed methods ALL
Description Allowed body fields


Name company_id.callbackDestination.createFromTemplate
Raw url /company/{companyId}/callback/destination/from-template/{callbackTemplateId}
Allowed methods ALL
Description Allowed body fields


Name company_id.CallBlockbrowse
Raw url /company/{companyId}/callblock
Allowed methods ALL
Description Allowed body fields


Name company_id.CallBlockread
Raw url /company/{companyId}/callblock/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Cfcbrowse
Raw url /company/{companyId}/cfc
Allowed methods ALL
Description Allowed body fields


Name company_idcheckAlias
Raw url /company/{companyId}/checkAlias/{userId}/{alias}
Allowed methods ALL
Description Allowed body fields


Name company_id.Cidbrowse
Raw url /company/{companyId}/cid
Allowed methods ALL
Description Allowed body fields


Name company_id.Cidread
Raw url /company/{companyId}/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name company_id.CustomerDataread
Raw url /company/{companyId}/customerdata
Allowed methods ALL
Description Allowed body fields


Name company_id.CustomerDataupdate
Raw url /company/{companyId}/customerdata
Allowed methods ALL
Description Allowed body fields
  • customer-data


Name company_id.CompanyDataread
Raw url /company/{companyId}/customerdata/companydata
Allowed methods ALL
Description Allowed body fields


Name company_id.CompanyDataupdate
Raw url /company/{companyId}/customerdata/companydata
Allowed methods ALL
Description Allowed body fields
  • domain_name
  • office_name
  • area
  • delivery_address
  • visiting_address
  • box_address
  • billing_address
  • directions
  • opening_hours
  • greeting
  • message_type
  • transfer_type
  • important_info
  • [sms]
  • [email]


Name company_id.customerdata.KeyValuecreate
Raw url /company/{companyId}/customerdata/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.customerdata.KeyValueupdate
Raw url /company/{companyId}/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.customerdata.KeyValueread
Raw url /company/{companyId}/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.customerdata.KeyValuedelete
Raw url /company/{companyId}/customerdata/keyvalue/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.customerdataUserDataread
Raw url /company/{companyId}/customerdata/userdata/{userId}
Allowed methods ALL
Description Allowed body fields


Name company_id.customerdataUserDataupdate
Raw url /company/{companyId}/customerdata/userdata/{userId}
Allowed methods ALL
Description Allowed body fields
  • title
  • place
  • manager
  • section
  • subsection
  • floor
  • building
  • room
  • plant
  • nickname
  • office
  • sales
  • location


Name company_id.customerdata.userdata.KeyValuecreate
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.customerdata.userdata.KeyValuebrowse
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue
Allowed methods ALL
Description Allowed body fields


Name company_id.customerdata.userdata.KeyValueupdate
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.customerdata.userdata.KeyValueread
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields


Name company_id.customerdata.userdata.KeyValuedelete
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods ALL
Description Allowed body fields


Name company_iddeactivate
Raw url /company/{companyId}/deactivate
Allowed methods ALL
Description Allowed body fields


Name company_idremoveDefaultDid
Raw url /company/{companyId}/defaultdid
Allowed methods ALL
Description Allowed body fields


Name company_idsetDefaultDidForUnusedNumbers
Raw url /company/{companyId}/defaultdid/{id}
Allowed methods ALL
Description Allowed body fields


Name company_iddeletable
Raw url /company/{companyId}/deletable
Allowed methods ALL
Description Allowed body fields


Name company_iddelete
Raw url /company/{companyId}/delete/{answer}
Allowed methods ALL
Description Allowed body fields


Name company_id.Departmentbrowse
Raw url /company/{companyId}/department
Allowed methods ALL
Description Allowed body fields


Name company_id.Departmentcreate
Raw url /company/{companyId}/department
Allowed methods ALL
Description Allowed body fields
  • name
  • description


Name company_id.Departmentread
Raw url /company/{companyId}/department/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Departmentupdate
Raw url /company/{companyId}/department/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • description


Name company_id.Departmentdelete
Raw url /company/{companyId}/department/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.department.acl.Groupbrowse
Raw url /company/{companyId}/department/{id}/acl/group
Allowed methods ALL
Description Allowed body fields


Name company_id.department.acl.Groupcreate
Raw url /company/{companyId}/department/{id}/acl/group
Allowed methods ALL
Description Allowed body fields
  • group_id


Name company_id.department.acl.Groupdelete
Raw url /company/{companyId}/department/{id}/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name company_id.department.Userdelete
Raw url /company/{companyId}/department/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company_id.department.Userupdate
Raw url /company/{companyId}/department/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company_id.Didbrowse
Raw url /company/{companyId}/did
Allowed methods ALL
Description Allowed body fields


Name company_id.DidreadAvailable
Raw url /company/{companyId}/did/available
Allowed methods ALL
Description Allowed body fields


Name company_id.Didread
Raw url /company/{companyId}/did/{didId}
Allowed methods ALL
Description Allowed body fields


Name company_id.FieldTypesbrowse
Raw url /company/{companyId}/fieldtypes
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.GenericRecordingread
Raw url /company/{companyId}/generic-recordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.GenericRecordingdelete
Raw url /company/{companyId}/generic-recordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.GenericRecordingmp3
Raw url /company/{companyId}/generic-recordings/{id}/mp3
Allowed methods ALL
Description Allowed body fields


Name company_idgetDeleteQuestion
Raw url /company/{companyId}/getdeletequestion
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Hotelbrowse
Raw url /company/{companyId}/hotel
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Hotelcreate
Raw url /company/{companyId}/hotel
Allowed methods ALL
Description Allowed body fields
  • name
  • [extension_reception]
  • [room_can_call_reception]
  • [room_can_call_room]
  • [prefix_wakeup]
  • [prefix_cleaning]
  • [cdr_multiple]


Name company_id.hotel.HotelgetAvailableUsers
Raw url /company/{companyId}/hotel/getavailableusers
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roombrowse
Raw url /company/{companyId}/hotel/{hotelId}/room
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roomcreate
Raw url /company/{companyId}/hotel/{hotelId}/room
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • room_number
  • phone_opened


Name company_id.hotel.Roomread
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roomupdate
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_id]
  • [room_number]
  • [wakeup_failed]
  • [cleaned]


Name company_id.hotel.Roomdelete
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomaccCleaned
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/cleaned
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomclosePhone
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/closephone
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomdownloadInvoicePDF
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/downloadinvoicepdf
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomdoInvoice
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/invoice
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomshowInvoice
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/invoice/{invoiceId}
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomlistInvoices
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/invoices
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roomlog
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/log
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.RoomopenPhone
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/openphone
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roomcleaned
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/setcleaned
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Roomwakeup
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}/wakeup
Allowed methods ALL
Description Allowed body fields
  • [wakeup]


Name company_id.hotel.Hotelread
Raw url /company/{companyId}/hotel/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Hotelupdate
Raw url /company/{companyId}/hotel/{id}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [extension_reception]
  • [room_can_call_reception]
  • [room_can_call_room]
  • [prefix_wakeup]
  • [prefix_cleaning]
  • [cdr_multiple]


Name company_id.hotel.Hoteldelete
Raw url /company/{companyId}/hotel/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.Hotellog
Raw url /company/{companyId}/hotel/{id}/log
Allowed methods ALL
Description Allowed body fields


Name company_id.hotel.HotelisUserAvailable
Raw url /company/{companyId}/hotel/{userId}/isuseravailable
Allowed methods ALL
Description Allowed body fields


Name company_id.Invoicebrowse
Raw url /company/{companyId}/invoice
Allowed methods ALL
Description Allowed body fields


Name company_id.Invoicedetails
Raw url /company/{companyId}/invoice/details
Allowed methods ALL
Description Allowed body fields


Name company_id.Invoicedownload
Raw url /company/{companyId}/invoice/{id}/download
Allowed methods ALL
Description Allowed body fields


Name company_id.Licensecreate
Raw url /company/{companyId}/license
Allowed methods ALL
Description Allowed body fields
  • license_id
  • [service_id]
  • [start_cost]
  • [monthly_cost]
  • [extra_text]


Name company_id.Licensebrowse
Raw url /company/{companyId}/license
Allowed methods ALL
Description Allowed body fields


Name company_id.Licensedelete
Raw url /company/{companyId}/license/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.LicensecreateWebullService
Raw url /company/{companyId}/license/{id}/service/create
Allowed methods ALL
Description Allowed body fields
  • service_id
  • [start_cost]
  • [monthly_cost]
  • [extra_text]


Name company_id.LicensedeleteWebullService
Raw url /company/{companyId}/license/{id}/service/delete
Allowed methods ALL
Description Allowed body fields


Name company_id.HasLicensehasLicense
Raw url /company/{companyId}/license/{licenseType}/has
Allowed methods ALL
Description Allowed body fields


Name company_id.Loggerbrowse
Raw url /company/{companyId}/logger
Allowed methods ALL
Description Allowed body fields


Name company_id.Loggerread
Raw url /company/{companyId}/logger/{userId}
Allowed methods ALL
Description Allowed body fields


Name company_id.Messagebrowse
Raw url /company/{companyId}/messages
Allowed methods ALL
Description Allowed body fields


Name company_id.Mobilebrowse
Raw url /company/{companyId}/mobile
Allowed methods ALL
Description Allowed body fields


Name company_id.Mobileread
Raw url /company/{companyId}/mobile/{simno}
Allowed methods ALL
Description Allowed body fields


Name company_id.Mobileactivate
Raw url /company/{companyId}/mobile/{simno}/activate
Allowed methods ALL
Description Allowed body fields


Name company_id.Mobiledeactivate
Raw url /company/{companyId}/mobile/{simno}/deactivate
Allowed methods ALL
Description Allowed body fields


Name company_id.Mobiletopup
Raw url /company/{companyId}/mobile/{simno}/topup/{topup}
Allowed methods ALL
Description Allowed body fields


Name company_id.MobiletopupHistory
Raw url /company/{companyId}/mobile/{simno}/topuphistory
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Omnigroupbrowse
Raw url /company/{companyId}/omnigroup
Allowed methods ALL
Description Allowed body fields


Name company_id.Overviewread
Raw url /company/{companyId}/overview
Allowed methods ALL
Description Allowed body fields


Name company_id.Partnerread
Raw url /company/{companyId}/partner
Allowed methods ALL
Description Allowed body fields


Name company_id.PbxFlowbrowse
Raw url /company/{companyId}/pbxflow
Allowed methods ALL
Description Allowed body fields


Name company_id.PbxFlowcreate
Raw url /company/{companyId}/pbxflow
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • items
  • users
  • [pbx_did_id]


Name company_id.PbxFlowread
Raw url /company/{companyId}/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.PbxFlowupdate
Raw url /company/{companyId}/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • items
  • users
  • [pbx_did_id]


Name company_id.PbxFlowdelete
Raw url /company/{companyId}/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.PingPongping
Raw url /company/{companyId}/pingpong
Allowed methods ALL
Description Allowed body fields


Name company_id.profile.Standardbrowse
Raw url /company/{companyId}/profile/standard
Allowed methods ALL
Description Allowed body fields


Name company_id.Profilebrowse
Raw url /company/{companyId}/profiles
Allowed methods ALL
Description Allowed body fields


Name company_id.PstnNumberbrowse
Raw url /company/{companyId}/pstnnumber
Allowed methods ALL
Description Allowed body fields


Name company_id.PstnNumberupdateNumber
Raw url /company/{companyId}/pstnnumber/{e164}/edit
Allowed methods ALL
Description Allowed body fields
  • [SmsFixed2CellE164]
  • [callforward_congestion]
  • [callforward_always]
  • [callforward_busy]
  • [callforward_noanswer]
  • [callforward_noanswer_time]


Name company_id.PstnNumbersetFixedSms
Raw url /company/{companyId}/pstnnumber/{e164}/setsms/{cellE164}
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.PstnRecordingbrowse
Raw url /company/{companyId}/pstnrecordings
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.PstnRecordingdelete
Raw url /company/{companyId}/pstnrecordings/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Queuebrowse
Raw url /company/{companyId}/queues
Allowed methods ALL
Description Allowed body fields


Name company_id.QueuebrowseAll
Raw url /company/{companyId}/queues/all
Allowed methods ALL
Description Allowed body fields


Name company_id.QueueStatbrowse
Raw url /company/{companyId}/queuestat
Allowed methods ALL
Description Allowed body fields


Name company_id.QueueStatbrowseAgentData
Raw url /company/{companyId}/queuestat/agents
Allowed methods ALL
Description Allowed body fields


Name company_id.QueueStatbrowseAgentAvailability
Raw url /company/{companyId}/queuestat/agents/availability
Allowed methods ALL
Description Allowed body fields


Name company_id.queuestat.Callsbrowse
Raw url /company/{companyId}/queuestat/calls
Allowed methods ALL
Description Allowed body fields


Name company_id.queuestat.Callsexport
Raw url /company/{companyId}/queuestat/calls/download
Allowed methods ALL
Description Allowed body fields


Name company_id.queuestat.Callsread
Raw url /company/{companyId}/queuestat/calls/{qsCallUniqueId}
Allowed methods ALL
Description Allowed body fields


Name company_id.queuestat.CallsexportCallsDetail
Raw url /company/{companyId}/queuestat/calls/{qsCallUniqueId}/download
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.Recordingbrowse
Raw url /company/{companyId}/recordings
Allowed methods ALL
Description Allowed body fields


Name company_id.Pbx.Recordingretin
Raw url /company/{companyId}/recordings
Allowed methods ALL
Description Allowed body fields


Name company_id.Reportcreate
Raw url /company/{companyId}/report
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • interval
  • active
  • arguments
  • [name]
  • [description]
  • [email_link_only]


Name company_id.report.argument.Fieldsbrowse
Raw url /company/{companyId}/report/argument/fields
Allowed methods ALL
Description Allowed body fields


Name company_id.ReportdownloadNotSaved
Raw url /company/{companyId}/report/download/{format}
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • arguments
  • interval
  • [date_from]
  • [date_to]


Name company_id.ReportgetReportHTMLNotSaved
Raw url /company/{companyId}/report/html
Allowed methods ALL
Description Allowed body fields
  • report_type_id
  • [arguments]
  • interval
  • [date_from]
  • [date_to]


Name company_id.Reportread
Raw url /company/{companyId}/report/read/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.report.Typebrowse
Raw url /company/{companyId}/report/type
Allowed methods ALL
Description Allowed body fields


Name company_id.Reportupdate
Raw url /company/{companyId}/report/{id}
Allowed methods ALL
Description Allowed body fields
  • interval
  • active
  • [name]
  • [description]
  • [email_link_only]


Name company_id.Reportdelete
Raw url /company/{companyId}/report/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.report.Argumentcreate
Raw url /company/{companyId}/report/{id}/argument
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.report.Argumentupdate
Raw url /company/{companyId}/report/{id}/argument/{argumentId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name company_id.report.Argumentdelete
Raw url /company/{companyId}/report/{id}/argument/{argumentId}
Allowed methods ALL
Description Allowed body fields


Name company_id.Reportdownload
Raw url /company/{companyId}/report/{id}/download/{format}
Allowed methods ALL
Description Allowed body fields


Name company_id.ReportgetReportHTML
Raw url /company/{companyId}/report/{id}/html
Allowed methods ALL
Description Allowed body fields


Name company_id.Reportsend
Raw url /company/{companyId}/report/{id}/send
Allowed methods ALL
Description Allowed body fields


Name company_id.Reportbrowse
Raw url /company/{companyId}/report{/reportTypeId}
Allowed methods ALL
Description Allowed body fields


Name company_id.Retainmentcreate
Raw url /company/{companyId}/retainment
Allowed methods ALL
Description Allowed body fields
  • retainment_type_id
  • value


Name company_id.Retainmentbrowse
Raw url /company/{companyId}/retainment
Allowed methods ALL
Description Allowed body fields


Name company_id.RetainmentTypesbrowse
Raw url /company/{companyId}/retainment/types
Allowed methods ALL
Description Allowed body fields


Name company_id.Retainmentupdate
Raw url /company/{companyId}/retainment/{id}
Allowed methods ALL
Description Allowed body fields
  • value


Name company_id.Soundfilebrowse
Raw url /company/{companyId}/soundfile
Allowed methods ALL
Description Allowed body fields


Name company_id.Templatebrowse
Raw url /company/{companyId}/template
Allowed methods ALL
Description Allowed body fields


Name company_id.Templatecreate
Raw url /company/{companyId}/template
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]
  • type


Name company_id.template.FieldbrowseAll
Raw url /company/{companyId}/template/field
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Fieldbrowse
Raw url /company/{companyId}/template/field/{templateType}
Allowed methods ALL
Description Allowed body fields


Name company_id.Templateread
Raw url /company/{companyId}/template/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.Templateupdate
Raw url /company/{companyId}/template/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • [description]


Name company_id.Templatedelete
Raw url /company/{companyId}/template/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Userbrowse
Raw url /company/{companyId}/template/{id}/user
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Usercreate
Raw url /company/{companyId}/template/{id}/user
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id


Name company_id.template.UserbrowseAvailable
Raw url /company/{companyId}/template/{id}/user/available
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Userdelete
Raw url /company/{companyId}/template/{id}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Valuebrowse
Raw url /company/{companyId}/template/{id}/value
Allowed methods ALL
Description Allowed body fields


Name company_id.template.Valueupdate
Raw url /company/{companyId}/template/{id}/value/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • value


Name company_id.UserReportsbrowse
Raw url /company/{companyId}/userreports
Allowed methods ALL
Description Allowed body fields


Name company_id.UserReportsexport
Raw url /company/{companyId}/userreports/download
Allowed methods ALL
Description Allowed body fields


Name company_id.Userbrowse
Raw url /company/{companyId}/users
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.Wallboardcreate
Raw url /company/{companyId}/wallboard
Allowed methods ALL
Description Allowed body fields
  • name
  • column_amount
  • theme
  • theme_color
  • timeout
  • queues_per_page
  • [unpin]
  • [expanded]


Name company_id.pbx.Wallboardbrowse
Raw url /company/{companyId}/wallboard
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardbrowseCommon
Raw url /company/{companyId}/wallboard/common
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardreadCommon
Raw url /company/{companyId}/wallboard/common/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardThemesbrowse
Raw url /company/{companyId}/wallboard/theme
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardThemeColorsbrowse
Raw url /company/{companyId}/wallboard/theme/color
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardThemeColorsread
Raw url /company/{companyId}/wallboard/theme/color/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardThemesread
Raw url /company/{companyId}/wallboard/theme/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardTokenbrowse
Raw url /company/{companyId}/wallboard/token
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardTokencreate
Raw url /company/{companyId}/wallboard/token
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id


Name company_id.pbx.WallboardTokenread
Raw url /company/{companyId}/wallboard/token/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardTokendelete
Raw url /company/{companyId}/wallboard/token/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.Wallboardupdate
Raw url /company/{companyId}/wallboard/{id}
Allowed methods ALL
Description Allowed body fields
  • name
  • column_amount
  • theme
  • theme_color
  • timeout
  • queues_per_page
  • [unpin]
  • [expanded]


Name company_id.pbx.Wallboarddelete
Raw url /company/{companyId}/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.Wallboardread
Raw url /company/{companyId}/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardQueuecreate
Raw url /company/{companyId}/wallboard/{id}/queue
Allowed methods ALL
Description Allowed body fields
  • [queue_id]
  • queue_type
  • position
  • timeout
  • [wallboard_queue_id]
  • [hidden]
  • [x]
  • [y]
  • [width]
  • [height]


Name company_id.pbx.WallboardQueueupdate
Raw url /company/{companyId}/wallboard/{id}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields
  • position
  • timeout
  • [hidden]
  • [x]
  • [y]
  • [width]
  • [height]


Name company_id.pbx.WallboardQueuedelete
Raw url /company/{companyId}/wallboard/{id}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields


Name company_id.pbx.WallboardDummycreate
Raw url /company/{companyId}/wallboard/{id}/queue/{queueId}/dummy
Allowed methods ALL
Description Allowed body fields
  • position
  • type_option
  • value_option


Name company_id.pbx.WallboardDummyupdate
Raw url /company/{companyId}/wallboard/{id}/queue/{queueId}/dummy/{dummyId}
Allowed methods ALL
Description Allowed body fields
  • position
  • type_option
  • value_option


Name company_id.pbx.WallboardDummydelete
Raw url /company/{companyId}/wallboard/{id}/queue/{queueId}/dummy/{dummyId}
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboardbrowse
Raw url /company/{companyId}/wallboardoutgoing
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboardcreate
Raw url /company/{companyId}/wallboardoutgoing
Allowed methods ALL
Description Allowed body fields
  • [id]
  • [columns]
  • [goal_amount_calls]
  • [goal_avg_talk_time]
  • [goal_total_talk_time]
  • [goal_count_higher]
  • [min_dur_calls]
  • [name]
  • [users]
  • [theme]


Name company_id.wallboardoutgoing.Wallboarddata
Raw url /company/{companyId}/wallboardoutgoing/data/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboardread
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboardupdate
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields
  • [added]
  • [columns]
  • [deleted]
  • [goal_amount_calls]
  • [goal_avg_talk_time]
  • [goal_total_talk_time]
  • [goal_sort]
  • [id]
  • [min_dur_calls]
  • [pbx_company_id]
  • [theme]
  • [name]
  • [users]
  • [goal_count_higher]


Name company_id.wallboardoutgoing.Wallboarddelete
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.WallboarddeleteColumn
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}/column/{columnId}
Allowed methods ALL
Description Allowed body fields


Name company_id.wallboardoutgoing.WallboarddeleteUser
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}/user/{userId}
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Brandingbrowse
Raw url /company/{companyId}/webchat/branding
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Brandingcreate
Raw url /company/{companyId}/webchat/branding
Allowed methods ALL
Description Allowed body fields
  • title
  • data


Name company.webchat.Brandingread
Raw url /company/{companyId}/webchat/branding/{brandingId}
Allowed methods ALL
Description Allowed body fields


Name company.webchat.Brandingupdate
Raw url /company/{companyId}/webchat/branding/{brandingId}
Allowed methods ALL
Description Allowed body fields
  • title
  • data
  • id


Name company_id.webchat.Channelbrowse
Raw url /company/{companyId}/webchat/channel
Allowed methods ALL
Description Allowed body fields


Name company_id.webchat.Channelcreate
Raw url /company/{companyId}/webchat/channel
Allowed methods ALL
Description Allowed body fields
  • pbx_omnigroup_id


Name company_id.webchat.Channelread
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name company_id.webchat.Channelupdate
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields
  • [added]
  • [channel_user_input]
  • [id]
  • [media_type]
  • [omni_queue]
  • [pbx_calendar_id]
  • [pbx_omnigroup_id]
  • [schedule]
  • [token]
  • [contact_email]
  • [pbx_company_id]
  • [chat_branding_id]
  • [branding]
  • [config_base64]
  • [agent_first_reserve_text_message]
  • [closed_when_no_agent_available]
  • [push_reminder_minutes]
  • [default_brand]
  • [deleted]


Name company_id.webchat.ChanneldeleteChannel
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name company_id.webchat.ChanneldeleteChannelInput
Raw url /company/{companyId}/webchat/channel/{channelId}/{inputId}
Allowed methods ALL
Description Allowed body fields


Name Contactbrowse
Raw url /contact
Allowed methods ALL
Description Allowed body fields


Name Contactcreate
Raw url /contact
Allowed methods ALL
Description Allowed body fields
  • name
  • [pbx_user_id]
  • [fields]
  • [origin]


Name Contactread
Raw url /contact/{contactId}
Allowed methods ALL
Description Allowed body fields


Name Contactupdate
Raw url /contact/{contactId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_user_id]
  • [fields]
  • [origin]
  • [pbx_contact_favorite]


Name Contactdelete
Raw url /contact/{contactId}
Allowed methods ALL
Description Allowed body fields


Name contact.Departmentcreate
Raw url /contact/{contactId}/department
Allowed methods ALL
Description Allowed body fields
  • department_id


Name contact.Departmentdelete
Raw url /contact/{contactId}/department/{departmentId}
Allowed methods ALL
Description Allowed body fields


Name contact.Favoritecreate
Raw url /contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields
  • [pbx_contact_favorite]


Name contact.Favoriteread
Raw url /contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields


Name contact.Favoriteupdate
Raw url /contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields
  • pbx_contact_favorite


Name contact.Favoritedelete
Raw url /contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields


Name contact.Fieldcreate
Raw url /contact/{contactId}/field
Allowed methods ALL
Description Allowed body fields
  • field
  • type
  • [label]


Name contact.Fieldread
Raw url /contact/{contactId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name contact.Fieldupdate
Raw url /contact/{contactId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name contact.Fielddelete
Raw url /contact/{contactId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name contact.ProfileExceptioncreate
Raw url /contact/{contactId}/profileexception
Allowed methods ALL
Description Allowed body fields


Name contact.ProfileExceptiondelete
Raw url /contact/{contactId}/profileexception
Allowed methods ALL
Description Allowed body fields


Name contactimport.createjobcreateJob
Raw url /contactimport/createjob
Allowed methods ALL
Description Allowed body fields
  • [delimiter]
  • [enclosure]
  • [escape]
  • [first_line_is_header]
  • [contact_common]


Name contactimport.browseColumnsbrowseColumns
Raw url /contactimport/job/{jobId}/column/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport.updatecolumnupdateColumn
Raw url /contactimport/job/{jobId}/column/{columnId}/update
Allowed methods ALL
Description Allowed body fields
  • [type]
  • [label]


Name contactimport.deletejobdeleteJob
Raw url /contactimport/job/{jobId}/delete
Allowed methods ALL
Description Allowed body fields


Name contactimport.readjobreadJob
Raw url /contactimport/job/{jobId}/read
Allowed methods ALL
Description Allowed body fields


Name contactimport.updaterowupdateRow
Raw url /contactimport/job/{jobId}/row/{rowId}/update
Allowed methods ALL
Description Allowed body fields
  • skip


Name contactimport.updatevalueupdateValue
Raw url /contactimport/job/{jobId}/row/{rowId}/value/{valueId}/update
Allowed methods ALL
Description Allowed body fields
  • new_value


Name contactimport.browserowsbrowseRows
Raw url /contactimport/job/{jobId}/rows/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport.browserowsreadRows
Raw url /contactimport/job/{jobId}/rows/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport.updatejobupdateJob
Raw url /contactimport/job/{jobId}/update
Allowed methods ALL
Description Allowed body fields
  • locked


Name contactimport.browsejobsbrowseJobs
Raw url /contactimport/jobs/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.createjobcreateJob
Raw url /contactimport/{userId}/createjob
Allowed methods ALL
Description Allowed body fields
  • [delimiter]
  • [enclosure]
  • [escape]
  • [first_line_is_header]
  • [contact_common]


Name contactimport_id.browseColumnsbrowseColumns
Raw url /contactimport/{userId}/job/{jobId}/column/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.updatecolumnupdateColumn
Raw url /contactimport/{userId}/job/{jobId}/column/{columnId}/update
Allowed methods ALL
Description Allowed body fields
  • [type]
  • [label]


Name contactimport_id.deletejobdeleteJob
Raw url /contactimport/{userId}/job/{jobId}/delete
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.readjobreadJob
Raw url /contactimport/{userId}/job/{jobId}/read
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.updaterowupdateRow
Raw url /contactimport/{userId}/job/{jobId}/row/{rowId}/update
Allowed methods ALL
Description Allowed body fields
  • skip


Name contactimport_id.updatevalueupdateValue
Raw url /contactimport/{userId}/job/{jobId}/row/{rowId}/value/{valueId}/update
Allowed methods ALL
Description Allowed body fields
  • new_value


Name contactimport_id.browserowsbrowseRows
Raw url /contactimport/{userId}/job/{jobId}/rows/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.browserowsreadRows
Raw url /contactimport/{userId}/job/{jobId}/rows/browse
Allowed methods ALL
Description Allowed body fields


Name contactimport_id.updatejobupdateJob
Raw url /contactimport/{userId}/job/{jobId}/update
Allowed methods ALL
Description Allowed body fields
  • locked


Name contactimport_id.browsejobsbrowseJobs
Raw url /contactimport/{userId}/jobs/browse
Allowed methods ALL
Description Allowed body fields


Name Countrybrowse
Raw url /country
Allowed methods ALL
Description Allowed body fields


Name Countryread
Raw url /country/{countryId}
Allowed methods ALL
Description Allowed body fields


Name Documentationindex
Raw url /documentation
Allowed methods ALL
Description Allowed body fields


Name DocumentationindexAuthentication
Raw url /documentation/authentication
Allowed methods ALL
Description Allowed body fields


Name Documentationdocplain
Raw url /documentation/doc-plain
Allowed methods ALL
Description Allowed body fields


Name DocumentationindexEvents
Raw url /documentation/events
Allowed methods ALL
Description Allowed body fields


Name DocumentationindexHowTo
Raw url /documentation/howto
Allowed methods ALL
Description Allowed body fields


Name DocumentationindexRateLimit
Raw url /documentation/ratelimit
Allowed methods ALL
Description Allowed body fields


Name Documentationswagger
Raw url /documentation/swagger.json
Allowed methods ALL
Description Allowed body fields


Name DocumentationindexUsecase
Raw url /documentation/usecases
Allowed methods ALL
Description Allowed body fields


Name Helpbrowse
Raw url /help
Allowed methods ALL
Description Allowed body fields


Name Helpdownload
Raw url /help/{filename}
Allowed methods ALL
Description Allowed body fields


Name Icon.download
Raw url /icon/{id}/image/{iconType}
Allowed methods ALL
Description Allowed body fields


Name Icon.browse
Raw url /icons{/iconType}
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemailbrowse
Raw url /mailbox/{mailboxId}/voicemail
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemailretin
Raw url /mailbox/{mailboxId}/voicemail
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemailread
Raw url /mailbox/{mailboxId}/voicemail/{voicemailId}
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemaildelete
Raw url /mailbox/{mailboxId}/voicemail/{voicemailId}
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemaildownloadMp3
Raw url /mailbox/{mailboxId}/voicemail/{voicemailId}/mp3
Allowed methods ALL
Description Allowed body fields


Name mailbox.voicemaildownloadWav
Raw url /mailbox/{mailboxId}/voicemail/{voicemailId}/wav
Allowed methods ALL
Description Allowed body fields


Name OAuth2deleteAccessToken
Raw url /oauth2/access-token
Allowed methods ALL
Description Allowed body fields


Name OAuth2refreshToken
Raw url /oauth2/refresh-token
Allowed methods ALL
Description Allowed body fields
  • grant_type
  • client_id
  • [client_secret]
  • [refresh_token]


Name OAuth2userCredentials
Raw url /oauth2/user-credentials
Allowed methods ALL
Description Allowed body fields
  • grant_type
  • client_id
  • [client_secret]
  • username
  • password
  • [tfa]
  • [client_ip]


Name operatorContactgetNote
Raw url /operator/contact/{contactId}/note
Allowed methods ALL
Description Allowed body fields


Name operatorContactaddNote
Raw url /operator/contact/{contactId}/note
Allowed methods ALL
Description Allowed body fields
  • note


Name operatorUsergetNote
Raw url /operator/user/{userId}/note
Allowed methods ALL
Description Allowed body fields


Name operatorUseraddNote
Raw url /operator/user/{userId}/note
Allowed methods ALL
Description Allowed body fields
  • note


Name pbx.CfcsetState
Raw url /pbx/cfc/{cfcId}/{state}
Allowed methods ALL
Description Allowed body fields


Name pbx.SoftPhoneawake
Raw url /pbx/softphone/awake/{userId}/{callGuid}/{callerid}
Allowed methods ALL
Description Allowed body fields


Name Profilecreate
Raw url /profile
Allowed methods ALL
Description Allowed body fields
  • name
  • priority
  • [pbx_user_id]
  • [pbx_color_id]
  • [profile_number]
  • [pbx_icon_id]
  • [default_callerid_pbx_did_id]
  • [pbx_profile_type_id]


Name profile.ProfileExceptioncreate
Raw url /profile/exception
Allowed methods ALL
Description Allowed body fields


Name profile.ProfileExceptionbrowse
Raw url /profile/exception
Allowed methods ALL
Description Allowed body fields


Name profile.ProfileExceptionread
Raw url /profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name profile.ProfileExceptionupdate
Raw url /profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name profile.ProfileExceptiondelete
Raw url /profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name Profiletypes
Raw url /profile/types
Allowed methods ALL
Description Allowed body fields


Name Profileread
Raw url /profile/{profileId}
Allowed methods ALL
Description Allowed body fields


Name Profileupdate
Raw url /profile/{profileId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [priority]
  • [profile_number]
  • [pbx_user_id]
  • [default_callerid_pbx_did_id]
  • [pbx_color_id]
  • [pbx_icon_id]
  • [pbx_profile_type_id]


Name Profiledelete
Raw url /profile/{profileId}
Allowed methods ALL
Description Allowed body fields


Name profile.Calendarcreate
Raw url /profile/{profileId}/calendar
Allowed methods ALL
Description Allowed body fields
  • name
  • origin


Name profile.CallRoutingcreate
Raw url /profile/{profileId}/callrouting
Allowed methods ALL
Description Allowed body fields
  • [pbx_did_id]
  • did_type
  • [timeout]
  • [dst_busy_pbx_destination_id]
  • [dst_noanswer_pbx_destination_id]
  • [dst_unreachable_pbx_destination_id]
  • [dst_busy_pbx_message_id]
  • [dst_noanswer_pbx_message_id]
  • [dst_unreachable_pbx_message_id]
  • [dst_busy_voicemail]
  • [dst_noanswer_voicemail]
  • [dst_unreachable_voicemail]


Name profile.CallRoutingbrowse
Raw url /profile/{profileId}/callrouting
Allowed methods ALL
Description Allowed body fields


Name profile.CallRoutingread
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods ALL
Description Allowed body fields


Name profile.CallRoutingupdate
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods ALL
Description Allowed body fields
  • [did_type]
  • [pbx_did_id]
  • [timeout]
  • [dst_busy_pbx_destination_id]
  • [dst_noanswer_pbx_destination_id]
  • [dst_unreachable_pbx_destination_id]
  • [dst_busy_pbx_message_id]
  • [dst_noanswer_pbx_message_id]
  • [dst_unreachable_pbx_message_id]
  • [dst_busy_voicemail]
  • [dst_noanswer_voicemail]
  • [dst_unreachable_voicemail]


Name profile.CallRoutingdelete
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods ALL
Description Allowed body fields


Name profile.callrouting.Itemcreate
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item
Allowed methods ALL
Description Allowed body fields
  • timeout
  • delay
  • to
  • id
  • priority


Name profile.callrouting.Itembrowse
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item
Allowed methods ALL
Description Allowed body fields


Name profile.callrouting.Itemupdate
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item/{callRoutingItemId}
Allowed methods ALL
Description Allowed body fields
  • [timeout]
  • [delay]
  • [to]
  • [id]
  • [priority]


Name profile.callrouting.Itemdelete
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item/{callRoutingItemId}
Allowed methods ALL
Description Allowed body fields


Name profile.Cidbrowse
Raw url /profile/{profileId}/cid
Allowed methods ALL
Description Allowed body fields


Name profile.Cidcreate
Raw url /profile/{profileId}/cid
Allowed methods ALL
Description Allowed body fields
  • pbx_account_id
  • callerid_pbx_did_id


Name profile.Cidread
Raw url /profile/{profileId}/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name profile.Cidupdate
Raw url /profile/{profileId}/cid/{cidId}
Allowed methods ALL
Description Allowed body fields
  • [pbx_account_id]
  • [callerid_pbx_did_id]


Name profile.Ciddelete
Raw url /profile/{profileId}/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name profile.Queuebrowse
Raw url /profile/{profileId}/queue
Allowed methods ALL
Description Allowed body fields


Name profile.Queuecreate
Raw url /profile/{profileId}/queue
Allowed methods ALL
Description Allowed body fields
  • ast_queue_id


Name profile.Queueread
Raw url /profile/{profileId}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields


Name profile.Queueupdate
Raw url /profile/{profileId}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields
  • [ast_queue_id]


Name profile.Queuedelete
Raw url /profile/{profileId}/queue/{queueId}
Allowed methods ALL
Description Allowed body fields


Name profile.queue.Accountbrowse
Raw url /profile/{profileId}/queue/{queueId}/account
Allowed methods ALL
Description Allowed body fields


Name profile.queue.Accountcreate
Raw url /profile/{profileId}/queue/{queueId}/account
Allowed methods ALL
Description Allowed body fields
  • pbx_account_id


Name profile.queue.Accountread
Raw url /profile/{profileId}/queue/{queueId}/account/{pbx_profile_queues_accounts_id}
Allowed methods ALL
Description Allowed body fields


Name profile.queue.Accountdelete
Raw url /profile/{profileId}/queue/{queueId}/account/{pbx_profile_queues_accounts_id}
Allowed methods ALL
Description Allowed body fields


Name profile.TriggerWordsbrowse
Raw url /profile/{profileId}/trigger_word
Allowed methods ALL
Description Allowed body fields


Name profile.TriggerWordscreate
Raw url /profile/{profileId}/trigger_word
Allowed methods ALL
Description Allowed body fields
  • word


Name profile.TriggerWordsdelete
Raw url /profile/{profileId}/trigger_word/{wordId}
Allowed methods ALL
Description Allowed body fields


Name queue.Cdrsearch
Raw url /queue/cdr
Allowed methods ALL
Description Allowed body fields


Name queue.Cdrdownload
Raw url /queue/cdr/download/{fileType}
Allowed methods ALL
Description Allowed body fields


Name queue.cdr.Handledread
Raw url /queue/cdr/handled/{cdrQueueId}
Allowed methods ALL
Description Allowed body fields


Name queue.cdr.Handledupdate
Raw url /queue/cdr/handled/{cdrQueueId}
Allowed methods ALL
Description Allowed body fields
  • [note]
  • [status]
  • [assigned_pbx_user_id]


Name queue.cdr.Membersearch
Raw url /queue/cdr/member
Allowed methods ALL
Description Allowed body fields


Name queue.cdr.Memberdownload
Raw url /queue/cdr/member/download/{fileType}
Allowed methods ALL
Description Allowed body fields


Name queue.cdr.Statsread
Raw url /queue/cdr/stats
Allowed methods ALL
Description Allowed body fields


Name Queueread
Raw url /queue/{queueId}
Allowed methods ALL
Description Allowed body fields


Name queue.Callerbrowse
Raw url /queue/{queueId}/caller
Allowed methods ALL
Description Allowed body fields


Name queue.Callerpickup
Raw url /queue/{queueId}/caller/{queueCallerId}/pickup
Allowed methods ALL
Description Allowed body fields


Name queue.Cdrbrowse
Raw url /queue/{queueId}/cdr
Allowed methods ALL
Description Allowed body fields


Name queue.Memberbrowse
Raw url /queue/{queueId}/member
Allowed methods ALL
Description Allowed body fields


Name queue.Membercreate
Raw url /queue/{queueId}/member
Allowed methods ALL
Description Allowed body fields
  • [priority]
  • [paused]
  • [penalty]
  • [pbx_user_id]
  • [wrapuptime]


Name queue.Memberorder
Raw url /queue/{queueId}/member/order
Allowed methods ALL
Description Allowed body fields
  • order


Name queue.Memberread
Raw url /queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name queue.Memberupdate
Raw url /queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields
  • [priority]
  • [paused]
  • [penalty]
  • [wrapuptime]


Name queue.Memberdelete
Raw url /queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name recording.LivemuteRecording
Raw url /recording/live/{recordingId}/mute
Allowed methods ALL
Description Allowed body fields


Name recording.LiveunmuteRecording
Raw url /recording/live/{recordingId}/mute
Allowed methods ALL
Description Allowed body fields


Name recording.LivestopRecording
Raw url /recording/live/{recordingId}/stop
Allowed methods ALL
Description Allowed body fields


Name recording.StoredgetStoredRecording
Raw url /recording/stored/{recordingId}{/audioType}
Allowed methods ALL
Description Allowed body fields


Name recording.StoreddeleteStoredRecording
Raw url /recording/stored/{recordingId}{/audioType}
Allowed methods ALL
Description Allowed body fields


Name Recordingread
Raw url /recording/{recordingId}
Allowed methods ALL
Description Allowed body fields


Name Recordingtranscribe
Raw url /recording/{recordingId}/transcribe
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_id]
  • pbx_company_id
  • [firstname]
  • [lastname]
  • [queue_id]
  • [queue_name]
  • [language]
  • [caller_number]
  • [caller_name]


Name SchedulereadWithScheduleIdOnly
Raw url /schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields


Name ScheduleupdateWithScheduleIdOnly
Raw url /schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [start]
  • [end]
  • [repeat]
  • [repeat_every]
  • [repeat_every_end]
  • [pbx_calendar_id]
  • [recurrence]
  • [force_pbx_destination_id]


Name ScheduledeleteWithScheduleIdOnly
Raw url /schedule/{scheduleId}
Allowed methods ALL
Description Allowed body fields


Name ScheduledeleteAtTimestampWithScheduleIdOnly
Raw url /schedule/{scheduleId}/at-timestamp
Allowed methods ALL
Description Allowed body fields


Name simple.Callcall
Raw url /simple/call/{accountId}/call/{number}
Allowed methods ALL
Description Allowed body fields


Name simple.Callhangup
Raw url /simple/call/{call_guid}/hangup
Allowed methods ALL
Description Allowed body fields


Name simple.Callrecord
Raw url /simple/call/{call_guid}/record/{action}
Allowed methods ALL
Description Allowed body fields


Name simple.Callrecordings
Raw url /simple/call/{call_guid}/recordings
Allowed methods ALL
Description Allowed body fields


Name simple.Calltransfer
Raw url /simple/call/{call_guid}/transfer/{number}
Allowed methods ALL
Description Allowed body fields


Name simple.Callmp3
Raw url /simple/call/{call_guid}/{id}/mp3
Allowed methods ALL
Description Allowed body fields


Name simple.Companyreload
Raw url /simple/company/apply
Allowed methods ALL
Description Allowed body fields


Name simple.Companyextensions
Raw url /simple/company/extensions
Allowed methods ALL
Description Allowed body fields


Name simple.Companyhistory
Raw url /simple/company/history
Allowed methods ALL
Description Allowed body fields


Name simple.Companynumbers
Raw url /simple/company/numbers
Allowed methods ALL
Description Allowed body fields


Name simple.CompanyqueueHistory
Raw url /simple/company/queuecdr
Allowed methods ALL
Description Allowed body fields


Name simple.CustomerDataread
Raw url /simple/customerdata
Allowed methods ALL
Description Allowed body fields


Name simple.CustomerDataupdate
Raw url /simple/customerdata
Allowed methods ALL
Description Allowed body fields
  • [domain_name]
  • [office_name]
  • [area]
  • [delivery_address]
  • [visiting_address]
  • [box_address]
  • [billing_address]
  • [directions]
  • [opening_hours]
  • [greeting]
  • [message_type]
  • [transfer_type]
  • [important_info]
  • [sms]
  • [email]


Name simple.customerdata.KeyValuecreate
Raw url /simple/customerdata/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name simple.customerdata.KeyValueupdate
Raw url /simple/customerdata/keyvalue/{keyValueId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name simple.customerdata.KeyValuedelete
Raw url /simple/customerdata/keyvalue/{keyValueId}
Allowed methods ALL
Description Allowed body fields


Name simple.customerdata.Userupdate
Raw url /simple/customerdata/user/{id}
Allowed methods ALL
Description Allowed body fields
  • [title]
  • [place]
  • [manager]
  • [section]
  • [subsection]
  • [floor]
  • [building]
  • [room]
  • [plant]
  • [nickname]
  • [office]
  • [sales]
  • [location]


Name simple.customerdata.user.KeyValuecreate
Raw url /simple/customerdata/user/{id}/keyvalue
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name simple.customerdata.user.KeyValueupdate
Raw url /simple/customerdata/user/{id}/keyvalue/{keyValueId}
Allowed methods ALL
Description Allowed body fields
  • key
  • value


Name simple.customerdata.user.KeyValuedelete
Raw url /simple/customerdata/user/{id}/keyvalue/{keyValueId}
Allowed methods ALL
Description Allowed body fields


Name simple.Docdoc
Raw url /simple/doc
Allowed methods ALL
Description Allowed body fields


Name simple.Eventlist
Raw url /simple/event/list
Allowed methods ALL
Description Allowed body fields


Name simple.Eventremove
Raw url /simple/event/remove/{event}/{format}
Allowed methods ALL
Description Allowed body fields


Name simple.Eventsubscribe
Raw url /simple/event/subscribe/{event}/{format}
Allowed methods ALL
Description Allowed body fields
  • target_url
  • [target_username]
  • [target_password]


Name simple.ExtensionaddCallerid
Raw url /simple/extension/{extension}/addcallerid/{number}
Allowed methods ALL
Description Allowed body fields


Name simple.ExtensionaddVirtNumber
Raw url /simple/extension/{extension}/addvirt/{number}
Allowed methods ALL
Description Allowed body fields


Name simple.Extensioncreate
Raw url /simple/extension/{extension}/create
Allowed methods ALL
Description Allowed body fields
  • name
  • surname
  • alias
  • password
  • callerid
  • [acl]
  • [default_pbx_profile_id]
  • [default_callerid_pbx_did_id]
  • [default_ringtime]
  • [default_hidden_callerid]
  • [status_callwaiting]
  • [voicemail]
  • [busy_all_busy]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [ast_language_id]
  • [description]
  • [hide_user]
  • [busy_message]
  • [vm_password]
  • [vm_email]
  • [vm_pager]
  • [vm_deletevoicemail]
  • [pbx_areacode_id]
  • [record_incomming]
  • [record_outgoing]
  • [record_queue]
  • [tele2_bill_e164]
  • [microsoft_exchange_user]
  • [microsoft_skype_user]
  • [google_alias]
  • [queue]


Name simple.Extensiondelete
Raw url /simple/extension/{extension}/delete
Allowed methods ALL
Description Allowed body fields


Name simple.Extensionhistory
Raw url /simple/extension/{extension}/history
Allowed methods ALL
Description Allowed body fields


Name simple.Extensionstatus
Raw url /simple/extension/{extension}/status
Allowed methods ALL
Description Allowed body fields


Name sms.SMSConfirmationconfirmation
Raw url /sms/confirmation
Allowed methods ALL
Description Allowed body fields
  • MessageId
  • StatusTime
  • Status


Name soundbrowse
Raw url /sound
Allowed methods ALL
Description Allowed body fields


Name soundcreate
Raw url /sound
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]


Name sound.Replaceableupdate
Raw url /sound/replaceable
Allowed methods ALL
Description Allowed body fields


Name sound.Replaceableread
Raw url /sound/replaceable
Allowed methods ALL
Description Allowed body fields


Name sound.ttsgenerate
Raw url /sound/tts/generate{/userId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [id]
  • [sound]
  • [passcode]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name sound.ttslanguage
Raw url /sound/tts/language
Allowed methods ALL
Description Allowed body fields


Name sound.ttsdownload
Raw url /sound/tts/{soundGuid}/download
Allowed methods ALL
Description Allowed body fields


Name sound.ttssave
Raw url /sound/tts/{soundGuid}/save
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [id]
  • [sound]
  • [passcode]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name sounddownloadFile
Raw url /sound/{soundId}/file/{audioType}
Allowed methods ALL
Description Allowed body fields


Name sound.ttsbrowse
Raw url /sound/{soundId}/tts
Allowed methods ALL
Description Allowed body fields


Name sound.ttsread
Raw url /sound/{soundId}/tts/{ttsId}
Allowed methods ALL
Description Allowed body fields


Name StandardCallMethodread
Raw url /standardcallmethod
Allowed methods ALL
Description Allowed body fields


Name StandardCallMethodupdate
Raw url /standardcallmethod
Allowed methods ALL
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name DocumentationswaggerIndex
Raw url /swagger
Allowed methods ALL
Description Allowed body fields


Name system.transcript.Transcriptread
Raw url /system/transcript/{token}
Allowed methods ALL
Description Allowed body fields


Name system.voicemail.Transcriptcreate
Raw url /system/voicemail/transcript
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_id]
  • pbx_company_id
  • [firstname]
  • [lastname]
  • [queue_id]
  • [queue_name]
  • [language]
  • [caller_number]
  • [caller_name]


Name system.worker.transcribe.FilesdownloadFile
Raw url /system/worker/transcribe/file
Allowed methods ALL
Description Allowed body fields


Name TimeZonebrowse
Raw url /timezone
Allowed methods ALL
Description Allowed body fields


Name TimeZoneread
Raw url /timezone/{timezoneId}
Allowed methods ALL
Description Allowed body fields


Name transcript.transcriptread
Raw url /transcript/{transcriptId}
Allowed methods ALL
Description Allowed body fields


Name transcript.transcriptdeleteTranscript
Raw url /transcript/{transcriptId}
Allowed methods ALL
Description Allowed body fields


Name transcript.transcriptstopTranscribing
Raw url /transcript/{transcriptId}/stop
Allowed methods ALL
Description Allowed body fields


Name unreadread
Raw url /unread
Allowed methods ALL
Description Allowed body fields


Name unreadsetRead
Raw url /unread/{unreadType}/{which}
Allowed methods ALL
Description Allowed body fields


Name Userread
Raw url /user
Allowed methods ALL
Description Allowed body fields


Name Userupdate
Raw url /user
Allowed methods ALL
Description Allowed body fields
  • [alias]
  • [name]
  • [surname]
  • [voicemail]
  • [available_pbx_profile_id]
  • [ast_language_id]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [force_pbx_profile_id]
  • [override_default_pbx_profile_id]
  • [note_title]
  • [note_text]
  • [fields]
  • [pbx_avatar_id]
  • [password]
  • [default_hidden_callerid]
  • [status_callwaiting]


Name user.Accountbrowse
Raw url /user/accounts
Allowed methods ALL
Description Allowed body fields


Name user.acl.company.NSpacebrowse
Raw url /user/acl/company/{companyId}/namespace
Allowed methods ALL
Description Allowed body fields


Name user.acl.Groupbrowse
Raw url /user/acl/group
Allowed methods ALL
Description Allowed body fields


Name user.acl.Groupdelete
Raw url /user/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name user.acl.Groupcreate
Raw url /user/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name user.acl.Permissionbrowse
Raw url /user/acl/permission{/companyId}
Allowed methods ALL
Description Allowed body fields


Name user.AppSettingread
Raw url /user/appsetting
Allowed methods ALL
Description Allowed body fields


Name user.AppSettingstore
Raw url /user/appsetting
Allowed methods ALL
Description Allowed body fields
  • [setting]


Name user.AppSettingreadPath
Raw url /user/appsetting/{jsonPath}
Allowed methods ALL
Description Allowed body fields


Name user.AppSettingstorePath
Raw url /user/appsetting/{jsonPath}
Allowed methods ALL
Description Allowed body fields
  • [json]


Name user.Avatarbrowse
Raw url /user/avatar
Allowed methods ALL
Description Allowed body fields


Name user.Avatarcreate
Raw url /user/avatar
Allowed methods ALL
Description Allowed body fields


Name user.AvatardownloadActive
Raw url /user/avatar/image{/type}
Allowed methods ALL
Description Allowed body fields


Name user.Avatarread
Raw url /user/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields


Name user.Avatarupdate
Raw url /user/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields
  • active


Name user.Avatardelete
Raw url /user/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields


Name user.Avatardownload
Raw url /user/avatar/{avatarId}/image{/type}
Allowed methods ALL
Description Allowed body fields


Name user.Bridgebrowse
Raw url /user/bridges
Allowed methods ALL
Description Allowed body fields


Name user.CallHistorybrowse
Raw url /user/call/history
Allowed methods ALL
Description Allowed body fields


Name user.CallHistoryretin
Raw url /user/call/history
Allowed methods ALL
Description Allowed body fields


Name user.CallHistorydownload
Raw url /user/call/history/download
Allowed methods ALL
Description Allowed body fields


Name user.CallextendedInfo
Raw url /user/call/{number}
Allowed methods ALL
Description Allowed body fields


Name user.Callbrowse
Raw url /user/calls
Allowed methods ALL
Description Allowed body fields


Name user.CallThroughcreate
Raw url /user/callthrough
Allowed methods ALL
Description Allowed body fields
  • [exten]


Name user.CallcallTravel
Raw url /user/calltravel/{callGuid}
Allowed methods ALL
Description Allowed body fields


Name user.ChatRoomread
Raw url /user/chat/room/with/{userId2}
Allowed methods ALL
Description Allowed body fields


Name user.ChatRoombrowse
Raw url /user/chat/rooms
Allowed methods ALL
Description Allowed body fields


Name user.Cidbrowse
Raw url /user/cid
Allowed methods ALL
Description Allowed body fields


Name user.Cidread
Raw url /user/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name user.Cidforce
Raw url /user/cid/{cidId}/force
Allowed methods ALL
Description Allowed body fields


Name user.CidnextCall
Raw url /user/cid/{cidId}/nextcall
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Departmentbrowse
Raw url /user/cms/department
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Departmentread
Raw url /user/cms/department/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.TicketbrowseAll
Raw url /user/cms/ticket
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Attachmentread
Raw url /user/cms/ticket/attachment/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Attachmentdownload
Raw url /user/cms/ticket/attachment/{id}/download
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Ticketbrowse
Raw url /user/cms/ticket/department/{departmentId}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Messageread
Raw url /user/cms/ticket/message/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Messageupdate
Raw url /user/cms/ticket/message/{id}
Allowed methods ALL
Description Allowed body fields
  • text


Name user.Cms.Messagedelete
Raw url /user/cms/ticket/message/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.TicketmultiUpdate
Raw url /user/cms/ticket/multi
Allowed methods ALL
Description Allowed body fields
  • [cms_ticket_state]
  • [owner_user_id]
  • cms_ticket_ids


Name user.Cms.Ticketread
Raw url /user/cms/ticket/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Ticketupdate
Raw url /user/cms/ticket/{id}
Allowed methods ALL
Description Allowed body fields
  • [cms_ticket_state]
  • [owner_user_id]


Name user.Cms.Attachmentbrowse
Raw url /user/cms/ticket/{id}/attachment
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Messagebrowse
Raw url /user/cms/ticket/{id}/message
Allowed methods ALL
Description Allowed body fields


Name user.Cms.Messagecreate
Raw url /user/cms/ticket/{id}/message
Allowed methods ALL
Description Allowed body fields
  • [text]
  • [pbx_user_id]
  • [user_name]


Name user.Provisioninggoodbye
Raw url /user/communicator/goodbye
Allowed methods ALL
Description Allowed body fields


Name user.Provisioninghello
Raw url /user/communicator/hello
Allowed methods ALL
Description Allowed body fields


Name user.Contactsbrowse
Raw url /user/contacts
Allowed methods ALL
Description Allowed body fields


Name user.Contactsexport
Raw url /user/contacts/export
Allowed methods ALL
Description Allowed body fields


Name user.ContactsbrowseFavorite
Raw url /user/contacts/favorites
Allowed methods ALL
Description Allowed body fields


Name user.Crmbrowse
Raw url /user/crm
Allowed methods ALL
Description Allowed body fields


Name user.Crmcreate
Raw url /user/crm
Allowed methods ALL
Description Allowed body fields
  • [crm_type]
  • [active]
  • [settings]
  • [accounts]
  • [triggers]


Name user.CrmreadActive
Raw url /user/crm/active
Allowed methods ALL
Description Allowed body fields


Name user.Crm.HubspotCallbackauthCallback
Raw url /user/crm/hubspot/authcallback
Allowed methods ALL
Description Allowed body fields


Name user.Crmread
Raw url /user/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields


Name user.Crmupdate
Raw url /user/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields
  • [active]
  • [settings]
  • [triggers]


Name user.Crmdelete
Raw url /user/crm/{crmEntryId}
Allowed methods ALL
Description Allowed body fields


Name user.Crm.AccountLinkbrowse
Raw url /user/crm/{crmEntryId}/accountlink
Allowed methods ALL
Description Allowed body fields


Name user.Crm.AccountLinkcreate
Raw url /user/crm/{crmEntryId}/accountlink
Allowed methods ALL
Description Allowed body fields


Name user.Crm.AccountLinkdelete
Raw url /user/crm/{crmEntryId}/accountlink/{accountId}
Allowed methods ALL
Description Allowed body fields


Name user.CrmreadCaller
Raw url /user/crm/{crmEntryId}/caller
Allowed methods ALL
Description Allowed body fields


Name user.Crm.Hubspoturl
Raw url /user/crm/{crmEntryId}/hubspot/url
Allowed methods ALL
Description Allowed body fields


Name user.Crm.SalesforcecheckAuth
Raw url /user/crm/{crmEntryId}/salesforce/checkauth
Allowed methods ALL
Description Allowed body fields
  • device_code


Name user.Crm.Salesforcecode
Raw url /user/crm/{crmEntryId}/salesforce/code
Allowed methods ALL
Description Allowed body fields


Name user.Destinationbrowse
Raw url /user/destination
Allowed methods ALL
Description Allowed body fields


Name user.Destinationread
Raw url /user/destination/{destinationId}
Allowed methods ALL
Description Allowed body fields


Name user.Didbrowse
Raw url /user/did
Allowed methods ALL
Description Allowed body fields


Name user.Didread
Raw url /user/did/{didId}
Allowed methods ALL
Description Allowed body fields


Name user.Fieldcreate
Raw url /user/field
Allowed methods ALL
Description Allowed body fields
  • field
  • type
  • [label]


Name user.Fieldread
Raw url /user/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name user.Fieldupdate
Raw url /user/field/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user.Fielddelete
Raw url /user/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name user.Isbusy
Raw url /user/is/{userIs}/{userIsWhat}/busy
Allowed methods ALL
Description Allowed body fields


Name UserisPassword
Raw url /user/ispassword
Allowed methods ALL
Description Allowed body fields
  • password


Name user.Logcreate
Raw url /user/log
Allowed methods ALL
Description Allowed body fields
  • text
  • [data]


Name user.LogcreateStats
Raw url /user/log/stats
Allowed methods ALL
Description Allowed body fields
  • text
  • [data]


Name user.Loggerbrowse
Raw url /user/logger
Allowed methods ALL
Description Allowed body fields


Name user.Mailboxbrowse
Raw url /user/mailbox
Allowed methods ALL
Description Allowed body fields


Name user.MessageTemplatebrowse
Raw url /user/messagetemplate
Allowed methods ALL
Description Allowed body fields


Name user.MessageTemplatecreate
Raw url /user/messagetemplate
Allowed methods ALL
Description Allowed body fields
  • name
  • text
  • [type]


Name user.MessageTemplateread
Raw url /user/messagetemplate/{id}
Allowed methods ALL
Description Allowed body fields


Name user.MessageTemplateupdate
Raw url /user/messagetemplate/{id}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [text]
  • [type]


Name user.MessageTemplatedelete
Raw url /user/messagetemplate/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Mobilebrowse
Raw url /user/mobile
Allowed methods ALL
Description Allowed body fields


Name user.Mobiletopup
Raw url /user/mobile/{simno}/topup/{topup}
Allowed methods ALL
Description Allowed body fields


Name user.MobiletopupHistory
Raw url /user/mobile/{simno}/topuphistory
Allowed methods ALL
Description Allowed body fields


Name user.acl.oauth.access-tokenbrowse
Raw url /user/oauth/access-token
Allowed methods ALL
Description Allowed body fields


Name user.Omnigroupbrowse
Raw url /user/omnigroup
Allowed methods ALL
Description Allowed body fields


Name user.Omnigroupread
Raw url /user/omnigroup/{id}
Allowed methods ALL
Description Allowed body fields


Name user.PbxFlowbrowse
Raw url /user/pbxflow
Allowed methods ALL
Description Allowed body fields


Name user.PbxFlowread
Raw url /user/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name user.pbxflow.Itemupdate
Raw url /user/pbxflow/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • value
  • [type]


Name user.Callpickup
Raw url /user/pickup/{pickupUserId}
Allowed methods ALL
Description Allowed body fields


Name user.Profileactive
Raw url /user/profile
Allowed methods ALL
Description Allowed body fields


Name user.ProfilecopyProfiles
Raw url /user/profile/copyprofiles
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • profileids
  • userids
  • [deletesamename]
  • [switch_default_pbx_profile_id]


Name user.profile.Exceptioncreate
Raw url /user/profile/exception
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_destination_id]
  • [description]
  • [did_type]
  • [pbx_profile_id]


Name user.profile.Exceptionbrowse
Raw url /user/profile/exception
Allowed methods ALL
Description Allowed body fields


Name user.profile.Exceptionread
Raw url /user/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.Exceptionupdate
Raw url /user/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_destination_id]
  • [description]
  • [did_type]
  • [pbx_profile_id]


Name user.profile.Exceptiondelete
Raw url /user/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.exception.Itemcreate
Raw url /user/profile/exception/{exceptionId}/item
Allowed methods ALL
Description Allowed body fields
  • e164


Name user.profile.exception.Itembrowse
Raw url /user/profile/exception/{exceptionId}/item
Allowed methods ALL
Description Allowed body fields


Name user.profile.exception.Itemread
Raw url /user/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.exception.Itemupdate
Raw url /user/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • e164


Name user.profile.exception.Itemdelete
Raw url /user/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user.pbx.Ivrbrowse
Raw url /user/profile/ivr
Allowed methods ALL
Description Allowed body fields


Name user.pbx.Ivrcreate
Raw url /user/profile/ivr
Allowed methods ALL
Description Allowed body fields
  • name
  • description
  • timeout_pbx_destination_id
  • invalid_pbx_destination_id
  • pbx_soundfile_id
  • timeout
  • invalid_loops


Name user.pbx.Ivrread
Raw url /user/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields


Name user.pbx.Ivrupdate
Raw url /user/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [timeout_pbx_destination_id]
  • [invalid_pbx_destination_id]
  • [pbx_soundfile_id]
  • [timeout]
  • [invalid_loops]


Name user.pbx.Ivrdelete
Raw url /user/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields


Name user.pbx.IvrItemcreate
Raw url /user/profile/ivr/{id}/item
Allowed methods ALL
Description Allowed body fields
  • selection
  • pbx_destination_id
  • [description]


Name user.pbx.IvrItemread
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user.pbx.IvrItemupdate
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • [selection]
  • [pbx_destination_id]
  • [description]


Name user.pbx.IvrItemdelete
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.ScheduleBrowse
Raw url /user/profile/schedule
Allowed methods ALL
Description Allowed body fields


Name user.profile.SchedulenextScheduled
Raw url /user/profile/schedule/next
Allowed methods ALL
Description Allowed body fields


Name user.profile.SchedulenextScheduledCompany
Raw url /user/profile/schedule/next/company
Allowed methods ALL
Description Allowed body fields


Name user.profile.Soundfilebrowse
Raw url /user/profile/soundfile
Allowed methods ALL
Description Allowed body fields


Name user.profile.Soundfilecreate
Raw url /user/profile/soundfile
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name user.profile.soundfile.Ttslanguage
Raw url /user/profile/soundfile/tts/language
Allowed methods ALL
Description Allowed body fields


Name user.profile.Soundfileupdate
Raw url /user/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name user.profile.Soundfileread
Raw url /user/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.Soundfiledelete
Raw url /user/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.Soundfileinuse
Raw url /user/profile/soundfile/{soundId}/inuse
Allowed methods ALL
Description Allowed body fields


Name user.profile.SoundfiledownloadMp3
Raw url /user/profile/soundfile/{soundId}/mp3
Allowed methods ALL
Description Allowed body fields


Name user.profile.soundfile.Ttsbrowse
Raw url /user/profile/soundfile/{soundId}/tts
Allowed methods ALL
Description Allowed body fields


Name user.profile.soundfile.Ttsread
Raw url /user/profile/soundfile/{soundId}/tts/{ttsId}
Allowed methods ALL
Description Allowed body fields


Name user.profile.SoundfiledownloadWav
Raw url /user/profile/soundfile/{soundId}/wav
Allowed methods ALL
Description Allowed body fields


Name user.Profileactivate
Raw url /user/profile/{profileId}
Allowed methods ALL
Description Allowed body fields


Name user.Profileicon
Raw url /user/profile/{profileId}/icon
Allowed methods ALL
Description Allowed body fields


Name user.ProfiledownloadIconAs
Raw url /user/profile/{profileId}/icon/{iconType}
Allowed methods ALL
Description Allowed body fields


Name user.ProfileactivateType
Raw url /user/profile/{profileId}/{setProfileType}
Allowed methods ALL
Description Allowed body fields


Name user.Profiles
Raw url /user/profiles
Allowed methods ALL
Description Allowed body fields


Name user.ProvisioninggetProvisioning
Raw url /user/provisioning
Allowed methods ALL
Description Allowed body fields


Name user.PushTokenbrowse
Raw url /user/pushtoken
Allowed methods ALL
Description Allowed body fields


Name user.PushTokencreate
Raw url /user/pushtoken
Allowed methods ALL
Description Allowed body fields
  • token
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user.PushTokenupdate
Raw url /user/pushtoken/{tokenId}
Allowed methods ALL
Description Allowed body fields
  • [token]
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user.PushTokendelete
Raw url /user/pushtoken/{tokenId}
Allowed methods ALL
Description Allowed body fields


Name user.QueueMembersbrowse
Raw url /user/queue/members
Allowed methods ALL
Description Allowed body fields


Name user.QueueStatsbrowse
Raw url /user/queue/stats
Allowed methods ALL
Description Allowed body fields


Name user.QueueMembercreate
Raw url /user/queue/{queueId}/member
Allowed methods ALL
Description Allowed body fields


Name user.QueueMemberupdate
Raw url /user/queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name user.QueueMemberdelete
Raw url /user/queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name user.Queuebrowse
Raw url /user/queues
Allowed methods ALL
Description Allowed body fields


Name user.QueuebrowseAll
Raw url /user/queues/all
Allowed methods ALL
Description Allowed body fields


Name user.Recordingbrowse
Raw url /user/recordings
Allowed methods ALL
Description Allowed body fields


Name user.Recordingretin
Raw url /user/recordings
Allowed methods ALL
Description Allowed body fields


Name sms.SMSbrowse
Raw url /user/sms
Allowed methods ALL
Description Allowed body fields


Name sms.SMScreate
Raw url /user/sms
Allowed methods ALL
Description Allowed body fields
  • numbers
  • sender
  • body


Name sms.SMSread
Raw url /user/sms/{smsId}
Allowed methods ALL
Description Allowed body fields


Name user.StandardCallMethodread
Raw url /user/standardcallmethod
Allowed methods ALL
Description Allowed body fields


Name user.StandardCallMethodupdate
Raw url /user/standardcallmethod
Allowed methods ALL
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name user.tbrbrowse
Raw url /user/tbr
Allowed methods ALL
Description Allowed body fields


Name user.tbrread
Raw url /user/tbr/{id}
Allowed methods ALL
Description Allowed body fields


Name user.Templatebrowse
Raw url /user/template
Allowed methods ALL
Description Allowed body fields


Name user.TemplatebrowsePrefix
Raw url /user/template/{templateType}
Allowed methods ALL
Description Allowed body fields


Name UserisPasswordBad
Raw url /user/testpassword
Allowed methods ALL
Description Allowed body fields
  • password


Name user.TFAread
Raw url /user/tfa
Allowed methods ALL
Description Allowed body fields


Name user.TFAcreate
Raw url /user/tfa
Allowed methods ALL
Description Allowed body fields
  • secret


Name user.TFAdelete
Raw url /user/tfa/delete
Allowed methods ALL
Description Allowed body fields
  • [code]


Name user.TFAforce
Raw url /user/tfa/force
Allowed methods ALL
Description Allowed body fields
  • force


Name user.TFAstatus
Raw url /user/tfa/status
Allowed methods ALL
Description Allowed body fields


Name user.TFAvalidate
Raw url /user/tfa/validate
Allowed methods ALL
Description Allowed body fields
  • code
  • [secret]


Name user.Wallboardbrowse
Raw url /user/wallboard
Allowed methods ALL
Description Allowed body fields


Name user.wallboard.queue.Callerbrowse
Raw url /user/wallboard/queue/caller/{queueId}
Allowed methods ALL
Description Allowed body fields


Name user.wallboard.queue.Cdrsearch
Raw url /user/wallboard/queue/cdr
Allowed methods ALL
Description Allowed body fields


Name user.wallboard.queue.cdr.Statsread
Raw url /user/wallboard/queue/cdr/stats
Allowed methods ALL
Description Allowed body fields


Name user.wallboard.queue.Cdrbrowse
Raw url /user/wallboard/queue/{queueId}/cdr
Allowed methods ALL
Description Allowed body fields


Name user.Wallboardstats
Raw url /user/wallboard/stats
Allowed methods ALL
Description Allowed body fields


Name user.wallboard.Tokenread
Raw url /user/wallboard/token
Allowed methods ALL
Description Allowed body fields


Name user.Wallboardread
Raw url /user/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name user.WallboardOutgoingread
Raw url /user/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Channelbrowse
Raw url /user/webchat/channel
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Channelread
Raw url /user/webchat/channel/{channelId}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Historybrowse
Raw url /user/webchat/history
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Messageread
Raw url /user/webchat/message/{messageId}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Messageupdate
Raw url /user/webchat/message/{messageId}
Allowed methods ALL
Description Allowed body fields
  • text_msg


Name user.webchat.Messagedelete
Raw url /user/webchat/message/{messageId}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Messagesetstatus
Raw url /user/webchat/message/{messageId}/status/{status}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionread
Raw url /user/webchat/session/{sessionId}
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionreserve
Raw url /user/webchat/session/{sessionId}/action/reserve
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionterminate
Raw url /user/webchat/session/{sessionId}/action/terminate
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionunreserve
Raw url /user/webchat/session/{sessionId}/action/unreserve
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionbrowsehistory
Raw url /user/webchat/session/{sessionId}/history
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessionbrowsemessages
Raw url /user/webchat/session/{sessionId}/message
Allowed methods ALL
Description Allowed body fields


Name user.webchat.Sessioncreatemessage
Raw url /user/webchat/session/{sessionId}/message
Allowed methods ALL
Description Allowed body fields
  • text_msg


Name user.webchat.Sessionsetstatus
Raw url /user/webchat/session/{sessionId}/status/{status}
Allowed methods ALL
Description Allowed body fields


Name User_idread
Raw url /user/{userId}
Allowed methods ALL
Description Allowed body fields


Name User_idupdate
Raw url /user/{userId}
Allowed methods ALL
Description Allowed body fields
  • [alias]
  • [name]
  • [surname]
  • [voicemail]
  • [available_pbx_profile_id]
  • [ast_language_id]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [force_pbx_profile_id]
  • [override_default_pbx_profile_id]
  • [note_title]
  • [note_text]
  • [fields]
  • [pbx_avatar_id]
  • [password]
  • [default_hidden_callerid]
  • [status_callwaiting]


Name user_id.Accountbrowse
Raw url /user/{userId}/accounts
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.company.NSpacebrowse
Raw url /user/{userId}/acl/company/{companyId}/namespace
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.Groupbrowse
Raw url /user/{userId}/acl/group
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.Groupdelete
Raw url /user/{userId}/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.Groupcreate
Raw url /user/{userId}/acl/group/{groupId}
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.Permissionbrowse
Raw url /user/{userId}/acl/permission{/companyId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Avatarbrowse
Raw url /user/{userId}/avatar
Allowed methods ALL
Description Allowed body fields


Name user_id.Avatarcreate
Raw url /user/{userId}/avatar
Allowed methods ALL
Description Allowed body fields


Name user_id.AvatardownloadActive
Raw url /user/{userId}/avatar/image{/type}
Allowed methods ALL
Description Allowed body fields


Name user_id.Avatarread
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Avatarupdate
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields
  • active


Name user_id.Avatardelete
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Avatardownload
Raw url /user/{userId}/avatar/{avatarId}/image{/type}
Allowed methods ALL
Description Allowed body fields


Name user_id.Bridgebrowse
Raw url /user/{userId}/bridges
Allowed methods ALL
Description Allowed body fields


Name user_id.CallHistorybrowse
Raw url /user/{userId}/call/history
Allowed methods ALL
Description Allowed body fields


Name user_id.CallHistoryretin
Raw url /user/{userId}/call/history
Allowed methods ALL
Description Allowed body fields


Name user_id.CallHistorydownload
Raw url /user/{userId}/call/history/download
Allowed methods ALL
Description Allowed body fields


Name user_id.CallextendedInfo
Raw url /user/{userId}/call/{number}
Allowed methods ALL
Description Allowed body fields


Name user.callback.Attemptbrowse
Raw url /user/{userId}/callback/attempt
Allowed methods ALL
Description Allowed body fields


Name user_id.Callbrowse
Raw url /user/{userId}/calls
Allowed methods ALL
Description Allowed body fields


Name user_id.CallcallTravel
Raw url /user/{userId}/calltravel/{callGuid}
Allowed methods ALL
Description Allowed body fields


Name user_id.ChatRoomread
Raw url /user/{userId}/chat/room/with/{userId2}
Allowed methods ALL
Description Allowed body fields


Name user_id.ChatRoombrowse
Raw url /user/{userId}/chat/rooms
Allowed methods ALL
Description Allowed body fields


Name user_id.Cidbrowse
Raw url /user/{userId}/cid
Allowed methods ALL
Description Allowed body fields


Name user_id.Cidread
Raw url /user/{userId}/cid/{cidId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Cidforce
Raw url /user/{userId}/cid/{cidId}/force
Allowed methods ALL
Description Allowed body fields


Name user_id.CidnextCall
Raw url /user/{userId}/cid/{cidId}/nextcall
Allowed methods ALL
Description Allowed body fields


Name user_id.Provisioninggoodbye
Raw url /user/{userId}/communicator/goodbye
Allowed methods ALL
Description Allowed body fields


Name user_id.Provisioninghello
Raw url /user/{userId}/communicator/hello
Allowed methods ALL
Description Allowed body fields


Name user.Companiesbrowse
Raw url /user/{userId}/companies
Allowed methods ALL
Description Allowed body fields


Name user.Companiesamount
Raw url /user/{userId}/companies/amount
Allowed methods ALL
Description Allowed body fields


Name user_id.Contactcreate
Raw url /user/{userId}/contact
Allowed methods ALL
Description Allowed body fields
  • name
  • [pbx_user_id]
  • [fields]
  • [origin]


Name user_id.Contactread
Raw url /user/{userId}/contact/{contactId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Contactupdate
Raw url /user/{userId}/contact/{contactId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_user_id]
  • [fields]
  • [origin]
  • [pbx_contact_favorite]


Name user_id.Contactdelete
Raw url /user/{userId}/contact/{contactId}
Allowed methods ALL
Description Allowed body fields


Name user_id.contact.Departmentcreate
Raw url /user/{userId}/contact/{contactId}/department
Allowed methods ALL
Description Allowed body fields
  • department_id


Name user_id.contact.Departmentdelete
Raw url /user/{userId}/contact/{contactId}/department/{departmentId}
Allowed methods ALL
Description Allowed body fields


Name user_id.contact.Favoriteupdate
Raw url /user/{userId}/contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields
  • pbx_contact_favorite


Name user_id.contact.Favoritedelete
Raw url /user/{userId}/contact/{contactId}/favorite
Allowed methods ALL
Description Allowed body fields


Name user_id.contact.Fieldcreate
Raw url /user/{userId}/contact/{contactId}/field
Allowed methods ALL
Description Allowed body fields
  • field
  • type
  • [label]


Name user_id.contact.Fieldupdate
Raw url /user/{userId}/contact/{contactId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user_id.contact.Fielddelete
Raw url /user/{userId}/contact/{contactId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name user_id.contact.ProfileExceptioncreate
Raw url /user/{userId}/contact/{contactId}/profileexception
Allowed methods ALL
Description Allowed body fields


Name user_id.contact.ProfileExceptiondelete
Raw url /user/{userId}/contact/{contactId}/profileexception
Allowed methods ALL
Description Allowed body fields


Name user_id.Contactsbrowse
Raw url /user/{userId}/contacts
Allowed methods ALL
Description Allowed body fields


Name user_id.Contactsexport
Raw url /user/{userId}/contacts/export
Allowed methods ALL
Description Allowed body fields


Name user_id.ContactsbrowseFavorite
Raw url /user/{userId}/contacts/favorites
Allowed methods ALL
Description Allowed body fields


Name user_id.Destinationbrowse
Raw url /user/{userId}/destination
Allowed methods ALL
Description Allowed body fields


Name user_id.Destinationread
Raw url /user/{userId}/destination/{destinationId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Didbrowse
Raw url /user/{userId}/did
Allowed methods ALL
Description Allowed body fields


Name user_id.Didread
Raw url /user/{userId}/did/{didId}
Allowed methods ALL
Description Allowed body fields


Name user.Favoritecreate
Raw url /user/{userId}/favorite
Allowed methods ALL
Description Allowed body fields
  • [pbx_user_favorite]


Name user.Favoriteread
Raw url /user/{userId}/favorite
Allowed methods ALL
Description Allowed body fields


Name user.Favoriteupdate
Raw url /user/{userId}/favorite
Allowed methods ALL
Description Allowed body fields
  • pbx_user_favorite


Name user.Favoritedelete
Raw url /user/{userId}/favorite
Allowed methods ALL
Description Allowed body fields


Name user_id.Fieldcreate
Raw url /user/{userId}/field
Allowed methods ALL
Description Allowed body fields
  • field
  • type
  • [label]


Name user_id.Fieldread
Raw url /user/{userId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Fieldupdate
Raw url /user/{userId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user_id.Fielddelete
Raw url /user/{userId}/field/{fieldId}
Allowed methods ALL
Description Allowed body fields


Name user.GlobalSearchbrowse
Raw url /user/{userId}/globalsearch
Allowed methods ALL
Description Allowed body fields


Name User_idisPassword
Raw url /user/{userId}/ispassword
Allowed methods ALL
Description Allowed body fields
  • password


Name user_id.Logcreate
Raw url /user/{userId}/log
Allowed methods ALL
Description Allowed body fields
  • text
  • [data]


Name user_id.LogcreateStats
Raw url /user/{userId}/log/stats
Allowed methods ALL
Description Allowed body fields
  • text
  • [data]


Name user_id.Loggerbrowse
Raw url /user/{userId}/logger
Allowed methods ALL
Description Allowed body fields


Name user_id.Mailboxbrowse
Raw url /user/{userId}/mailbox
Allowed methods ALL
Description Allowed body fields


Name user_id.Mobilebrowse
Raw url /user/{userId}/mobile
Allowed methods ALL
Description Allowed body fields


Name user_id.Mobiletopup
Raw url /user/{userId}/mobile/{simno}/topup/{topup}
Allowed methods ALL
Description Allowed body fields


Name user_id.MobiletopupHistory
Raw url /user/{userId}/mobile/{simno}/topuphistory
Allowed methods ALL
Description Allowed body fields


Name user_id.acl.company.access-tokenbrowse
Raw url /user/{userId}/oauth/access-token
Allowed methods ALL
Description Allowed body fields


Name user.user_id.Omnigroupbrowse
Raw url /user/{userId}/omnigroup
Allowed methods ALL
Description Allowed body fields


Name user.user_id.Omnigroupread
Raw url /user/{userId}/omnigroup/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.PbxFlowbrowse
Raw url /user/{userId}/pbxflow
Allowed methods ALL
Description Allowed body fields


Name user_id.PbxFlowread
Raw url /user/{userId}/pbxflow/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.pbxflow.Itemupdate
Raw url /user/{userId}/pbxflow/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • value
  • [type]


Name user_id.Callpickup
Raw url /user/{userId}/pickup/{pickupUserId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Profileactive
Raw url /user/{userId}/profile
Allowed methods ALL
Description Allowed body fields


Name user_id.ProfilecopyProfiles
Raw url /user/{userId}/profile/copyprofiles
Allowed methods ALL
Description Allowed body fields
  • pbx_user_id
  • profileids
  • userids
  • [deletesamename]
  • [switch_default_pbx_profile_id]


Name user_id.profile.Exceptioncreate
Raw url /user/{userId}/profile/exception
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_destination_id]
  • [description]
  • [did_type]
  • [pbx_profile_id]


Name user_id.profile.Exceptionbrowse
Raw url /user/{userId}/profile/exception
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Exceptionread
Raw url /user/{userId}/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Exceptionupdate
Raw url /user/{userId}/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [pbx_destination_id]
  • [description]
  • [did_type]
  • [pbx_profile_id]


Name user_id.profile.Exceptiondelete
Raw url /user/{userId}/profile/exception/{exceptionId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.exception.Itemcreate
Raw url /user/{userId}/profile/exception/{exceptionId}/item
Allowed methods ALL
Description Allowed body fields
  • e164


Name user_id.profile.exception.Itembrowse
Raw url /user/{userId}/profile/exception/{exceptionId}/item
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.exception.Itemread
Raw url /user/{userId}/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.exception.Itemupdate
Raw url /user/{userId}/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • e164


Name user_id.profile.exception.Itemdelete
Raw url /user/{userId}/profile/exception/{exceptionId}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user_id.pbx.Ivrbrowse
Raw url /user/{userId}/profile/ivr
Allowed methods ALL
Description Allowed body fields


Name user_id.pbx.Ivrcreate
Raw url /user/{userId}/profile/ivr
Allowed methods ALL
Description Allowed body fields
  • name
  • description
  • timeout_pbx_destination_id
  • invalid_pbx_destination_id
  • pbx_soundfile_id
  • timeout
  • invalid_loops


Name user_id.pbx.Ivrread
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.pbx.Ivrupdate
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [timeout_pbx_destination_id]
  • [invalid_pbx_destination_id]
  • [pbx_soundfile_id]
  • [timeout]
  • [invalid_loops]


Name user_id.pbx.Ivrdelete
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.pbx.IvrItemcreate
Raw url /user/{userId}/profile/ivr/{id}/item
Allowed methods ALL
Description Allowed body fields
  • selection
  • pbx_destination_id
  • [description]


Name user_id.pbx.IvrItemread
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user_id.pbx.IvrItemupdate
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields
  • [selection]
  • [pbx_destination_id]
  • [description]


Name user_id.pbx.IvrItemdelete
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.ScheduleBrowse
Raw url /user/{userId}/profile/schedule
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.SchedulenextScheduled
Raw url /user/{userId}/profile/schedule/next
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.SchedulenextScheduledCompany
Raw url /user/{userId}/profile/schedule/next/company
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Soundfilebrowse
Raw url /user/{userId}/profile/soundfile
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Soundfilecreate
Raw url /user/{userId}/profile/soundfile
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name user_id.profile.soundfile.Ttslanguage
Raw url /user/{userId}/profile/soundfile/tts/language
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Soundfileupdate
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]
  • [tts_supplier]


Name user_id.profile.Soundfileread
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Soundfiledelete
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.Soundfileinuse
Raw url /user/{userId}/profile/soundfile/{soundId}/inuse
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.SoundfiledownloadMp3
Raw url /user/{userId}/profile/soundfile/{soundId}/mp3
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.soundfile.Ttsbrowse
Raw url /user/{userId}/profile/soundfile/{soundId}/tts
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.soundfile.Ttsread
Raw url /user/{userId}/profile/soundfile/{soundId}/tts/{ttsId}
Allowed methods ALL
Description Allowed body fields


Name user_id.profile.SoundfiledownloadWav
Raw url /user/{userId}/profile/soundfile/{soundId}/wav
Allowed methods ALL
Description Allowed body fields


Name user_id.Profileactivate
Raw url /user/{userId}/profile/{profileId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Profileicon
Raw url /user/{userId}/profile/{profileId}/icon
Allowed methods ALL
Description Allowed body fields


Name user_id.ProfiledownloadIconAs
Raw url /user/{userId}/profile/{profileId}/icon/{iconType}
Allowed methods ALL
Description Allowed body fields


Name user_id.ProfileactivateType
Raw url /user/{userId}/profile/{profileId}/{setProfileType}
Allowed methods ALL
Description Allowed body fields


Name user_id.Profiles
Raw url /user/{userId}/profiles
Allowed methods ALL
Description Allowed body fields


Name user_id.ProvisioninggetProvisioning
Raw url /user/{userId}/provisioning
Allowed methods ALL
Description Allowed body fields


Name user_id.PushTokenbrowse
Raw url /user/{userId}/pushtoken
Allowed methods ALL
Description Allowed body fields


Name user_id.PushTokencreate
Raw url /user/{userId}/pushtoken
Allowed methods ALL
Description Allowed body fields
  • token
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user_id.PushTokenupdate
Raw url /user/{userId}/pushtoken/{tokenId}
Allowed methods ALL
Description Allowed body fields
  • [token]
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user_id.PushTokendelete
Raw url /user/{userId}/pushtoken/{tokenId}
Allowed methods ALL
Description Allowed body fields


Name user_id.QueueMembersbrowse
Raw url /user/{userId}/queue/members
Allowed methods ALL
Description Allowed body fields


Name user_id.QueueStatsbrowse
Raw url /user/{userId}/queue/stats
Allowed methods ALL
Description Allowed body fields


Name user_id.QueueMembercreate
Raw url /user/{userId}/queue/{queueId}/member
Allowed methods ALL
Description Allowed body fields


Name user_id.QueueMemberupdate
Raw url /user/{userId}/queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name user_id.QueueMemberdelete
Raw url /user/{userId}/queue/{queueId}/member/{queueMemberId}
Allowed methods ALL
Description Allowed body fields


Name user_id.Queuebrowse
Raw url /user/{userId}/queues
Allowed methods ALL
Description Allowed body fields


Name user_id.QueuebrowseAll
Raw url /user/{userId}/queues/all
Allowed methods ALL
Description Allowed body fields


Name user_id.Recordingbrowse
Raw url /user/{userId}/recordings
Allowed methods ALL
Description Allowed body fields


Name user_id.Recordingretin
Raw url /user/{userId}/recordings
Allowed methods ALL
Description Allowed body fields


Name user_id.RingGroupMemberbrowse
Raw url /user/{userId}/ringgroup/member
Allowed methods ALL
Description Allowed body fields


Name user_id.StandardCallMethodread
Raw url /user/{userId}/standardcallmethod
Allowed methods ALL
Description Allowed body fields


Name user_id.StandardCallMethodupdate
Raw url /user/{userId}/standardcallmethod
Allowed methods ALL
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name user_id.tbrbrowse
Raw url /user/{userId}/tbr
Allowed methods ALL
Description Allowed body fields


Name user_id.tbrread
Raw url /user/{userId}/tbr/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.Templatebrowse
Raw url /user/{userId}/template
Allowed methods ALL
Description Allowed body fields


Name user_id.TemplatebrowsePrefix
Raw url /user/{userId}/template/{templateType}
Allowed methods ALL
Description Allowed body fields


Name User_idisPasswordBad
Raw url /user/{userId}/testpassword
Allowed methods ALL
Description Allowed body fields
  • password


Name user_id.TFAread
Raw url /user/{userId}/tfa
Allowed methods ALL
Description Allowed body fields


Name user_id.TFAcreate
Raw url /user/{userId}/tfa
Allowed methods ALL
Description Allowed body fields
  • secret


Name user_id.TFAdelete
Raw url /user/{userId}/tfa/delete
Allowed methods ALL
Description Allowed body fields
  • [code]


Name user_id.TFAforce
Raw url /user/{userId}/tfa/force
Allowed methods ALL
Description Allowed body fields
  • force


Name user_id.TFAstatus
Raw url /user/{userId}/tfa/status
Allowed methods ALL
Description Allowed body fields


Name user_id.TFAvalidate
Raw url /user/{userId}/tfa/validate
Allowed methods ALL
Description Allowed body fields
  • code
  • [secret]


Name user.Usersbrowse
Raw url /user/{userId}/users
Allowed methods ALL
Description Allowed body fields


Name user.Usersamount
Raw url /user/{userId}/users/amount
Allowed methods ALL
Description Allowed body fields


Name user_id.Wallboardbrowse
Raw url /user/{userId}/wallboard
Allowed methods ALL
Description Allowed body fields


Name user_id.Wallboardstats
Raw url /user/{userId}/wallboard/stats
Allowed methods ALL
Description Allowed body fields


Name user_id.Wallboardread
Raw url /user/{userId}/wallboard/{id}
Allowed methods ALL
Description Allowed body fields


Name user_id.WallboardOutgoingread
Raw url /user/{userId}/wallboardoutgoing/{wallboardId}
Allowed methods ALL
Description Allowed body fields


Name Usersbrowse
Raw url /users
Allowed methods ALL
Description Allowed body fields


Name webchat.Historybrowse
Raw url /webchat/history
Allowed methods ALL
Description Allowed body fields