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
accountId \d+
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+
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 ]+
favoriteId \d+
fieldId \d+
fileType csv|pdf|html|xlsx
hotelId \d+
iconType png|svg
id \d+
instanceId [0-9a-f-]{36}
teamsPresenceId \d+
tenantId [0-9a-f-]{36}
keyValueId \d+
imageType png|jpg
mailboxId \d+
communicatorPlatform stable|beta|alpha
communicatorOs linux|osx|windows
communicatorVersion v1|v2
communicatorArch x86|arm64
brandingName [a-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}

Routes

Name Account.read
Raw url /account/{accountId}
Allowed methods GET
Description Allowed body fields


Name Account.update
Raw url /account/{accountId}
Allowed methods PATCH
Description Allowed body fields
  • [number]
  • [status]


Name Account.originateCall
Raw url /account/{accountId}/call
Allowed methods POST
Description Allowed body fields
  • exten
  • [priority]
  • [timeout]
  • [callerid]
  • [async]


Name acl.Group.create
Raw url /acl/group
Allowed methods POST
Description Allowed body fields
  • title
  • [pbx_company_id]
  • [list_type]
  • [parent_acl_group_id]


Name acl.Group.read
Raw url /acl/group/{groupId}
Allowed methods GET
Description Allowed body fields


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


Name acl.Group.delete
Raw url /acl/group/{groupId}
Allowed methods DELETE
Description Allowed body fields


Name acl.group.Cfc.browse
Raw url /acl/group/{groupId}/cfc
Allowed methods GET
Description Allowed body fields


Name acl.group.Cfc.create
Raw url /acl/group/{groupId}/cfc
Allowed methods POST
Description Allowed body fields
  • pbx_app_cfc_id
  • permission


Name acl.group.Cfc.update
Raw url /acl/group/{groupId}/cfc/{id}
Allowed methods PATCH
Description Allowed body fields
  • permission


Name acl.group.Cfc.delete
Raw url /acl/group/{groupId}/cfc/{id}
Allowed methods DELETE
Description Allowed body fields


Name acl.Group.NSpace.browse
Raw url /acl/group/{groupId}/namespace
Allowed methods GET
Description Allowed body fields


Name acl.Group.NSpace.create
Raw url /acl/group/{groupId}/namespace
Allowed methods POST
Description Allowed body fields
  • namespace


Name acl.Group.NSpace.delete
Raw url /acl/group/{groupId}/namespace/{namespace}
Allowed methods DELETE
Description Allowed body fields


Name acl.Group.Permission.create
Raw url /acl/group/{groupId}/permission
Allowed methods POST
Description Allowed body fields
  • permission
  • permission_template_id


Name acl.Group.Permission.browse
Raw url /acl/group/{groupId}/permission
Allowed methods GET
Description Allowed body fields


Name acl.group.QueueMonitor.create
Raw url /acl/group/{groupId}/queuemonitor
Allowed methods POST
Description Allowed body fields
  • ast_queue_id
  • permission


Name acl.group.QueueMonitor.browse
Raw url /acl/group/{groupId}/queuemonitor
Allowed methods GET
Description Allowed body fields


Name acl.group.QueueMonitor.update
Raw url /acl/group/{groupId}/queuemonitor/{queueId}
Allowed methods PATCH
Description Allowed body fields
  • permission


Name acl.group.QueueMonitor.delete
Raw url /acl/group/{groupId}/queuemonitor/{queueId}
Allowed methods DELETE
Description Allowed body fields


Name acl.group.User.browse
Raw url /acl/group/{groupId}/user
Allowed methods GET
Description Allowed body fields


Name acl.group.User.create
Raw url /acl/group/{groupId}/user
Allowed methods POST
Description Allowed body fields
  • pbx_user_id
  • permission


Name acl.group.User.update
Raw url /acl/group/{groupId}/user/{userId}
Allowed methods PATCH
Description Allowed body fields
  • permission


Name acl.group.User.delete
Raw url /acl/group/{groupId}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name acl.permission.Template.browse
Raw url /acl/permission/template
Allowed methods GET
Description Allowed body fields


Name acl.Permission.update
Raw url /acl/permission/{permissionId}
Allowed methods PATCH
Description Allowed body fields
  • [permission]


Name acl.Permission.delete
Raw url /acl/permission/{permissionId}
Allowed methods DELETE
Description Allowed body fields


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


Name Calendar.create
Raw url /calendar
Allowed methods POST
Description Allowed body fields
  • name
  • type


Name Calendar.readSchedule
Raw url /calendar/schedule/{scheduleId}
Allowed methods GET
Description Allowed body fields


Name Calendar.browseSchedules
Raw url /calendar/schedules
Allowed methods GET
Description Allowed body fields


Name Calendar.read
Raw url /calendar/{calendarId}
Allowed methods GET
Description Allowed body fields


Name Calendar.update
Raw url /calendar/{calendarId}
Allowed methods PATCH
Description Allowed body fields
  • name


Name Calendar.delete
Raw url /calendar/{calendarId}
Allowed methods DELETE
Description Allowed body fields


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


Name Schedule.read
Raw url /calendar/{calendarId}/schedule/{scheduleId}
Allowed methods GET
Description Allowed body fields


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


Name Schedule.delete
Raw url /calendar/{calendarId}/schedule/{scheduleId}
Allowed methods DELETE
Description Allowed body fields


Name Schedule.deleteAtTimestamp
Raw url /calendar/{calendarId}/schedule/{scheduleId}/at-timestamp
Allowed methods DELETE
Description Allowed body fields


Name Schedule.browse
Raw url /calendar/{calendarId}/schedules
Allowed methods GET
Description Allowed body fields


Name CallHistory.delete
Raw url /call/history/{callHistoryId}
Allowed methods DELETE
Description Allowed body fields


Name callback.Action.delete
Raw url /callback/action/{callbackActionId}
Allowed methods DELETE
Description Allowed body fields


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


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


Name callback.Agent.delete
Raw url /callback/agent/{callbackAgentId}
Allowed methods DELETE
Description Allowed body fields


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


Name callback.Attempt.create
Raw url /callback/attempt
Allowed methods POST
Description Allowed body fields
  • agentId
  • entryId


Name callback.attempt.Log.browse
Raw url /callback/attempt/{attemptId}/log
Allowed methods GET
Description Allowed body fields


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


Name callback.attempt.Trigger.runTrigger
Raw url /callback/attempt/{attemptId}/trigger/{callbackTriggerId}
Allowed methods POST
Description Allowed body fields


Name callback.Attempt.read
Raw url /callback/attempt/{callbackAttemptId}
Allowed methods GET
Description Allowed body fields


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


Name callback.Category.delete
Raw url /callback/category/{callbackCategoryId}
Allowed methods DELETE
Description Allowed body fields


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


Name callback.Column.delete
Raw url /callback/column/{destinationColumnId}
Allowed methods DELETE
Description Allowed body fields


Name callback.data.Template.browse
Raw url /callback/data/template
Allowed methods GET
Description Allowed body fields


Name callback.data.Transform.browse
Raw url /callback/data/transform
Allowed methods GET
Description Allowed body fields


Name callback.Destination.read
Raw url /callback/destination/{destinationId}
Allowed methods GET
Description Allowed body fields


Name callback.Destination.update
Raw url /callback/destination/{destinationId}
Allowed methods PATCH
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.Destination.delete
Raw url /callback/destination/{destinationId}
Allowed methods DELETE
Description Allowed body fields


Name callback.destination.Agent.browse
Raw url /callback/destination/{destinationId}/agent
Allowed methods GET
Description Allowed body fields


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


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


Name callback.destination.Category.browse
Raw url /callback/destination/{destinationId}/category
Allowed methods GET
Description Allowed body fields


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


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


Name callback.destination.data.Template.browse
Raw url /callback/destination/{destinationId}/data/template
Allowed methods GET
Description Allowed body fields


Name callback.destination.Entry.browse
Raw url /callback/destination/{destinationId}/entry
Allowed methods GET
Description Allowed body fields


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


Name callback.destination.entry.History.browse
Raw url /callback/destination/{destinationId}/entry/history
Allowed methods GET
Description Allowed body fields


Name callback.destination.entry.Log.browse
Raw url /callback/destination/{destinationId}/entry/{destinationEntryId}/log
Allowed methods GET
Description Allowed body fields


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


Name callback.Destination.getBookableTimes
Raw url /callback/destination/{destinationId}/getbookabletimes
Allowed methods GET
Description Allowed body fields


Name callback.destination.Schedule.browse
Raw url /callback/destination/{destinationId}/schedule
Allowed methods GET
Description Allowed body fields


Name callback.destination.slot.Calendar.browse
Raw url /callback/destination/{destinationId}/slot/calendar
Allowed methods GET
Description Allowed body fields


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


Name callback.destination.Trigger.browse
Raw url /callback/destination/{destinationId}/trigger
Allowed methods GET
Description Allowed body fields


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


Name callback.destination.user.Agent.browse
Raw url /callback/destination/{destinationId}/user/{userId}/agent
Allowed methods GET
Description Allowed body fields


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


Name callback.Entry.read
Raw url /callback/entry/{callbackEntryId}
Allowed methods GET
Description Allowed body fields


Name callback.entry.Event.browse
Raw url /callback/entry/{callbackEntryId}/event
Allowed methods GET
Description Allowed body fields


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


Name callback.entry.SMS.create
Raw url /callback/entry/{callbackEntryId}/sms
Allowed methods POST
Description Allowed body fields
  • number
  • sender
  • body


Name callback.entry.Attempt.browse
Raw url /callback/entry/{destinationEntryId}/attempt
Allowed methods GET
Description Allowed body fields


Name callback.entry.Log.browse
Raw url /callback/entry/{destinationEntryId}/log
Allowed methods GET
Description Allowed body fields


Name callback.slot.Calendar.read
Raw url /callback/slot/calendar/{callbackCalendarId}
Allowed methods GET
Description Allowed body fields


Name callback.slot.Calendar.delete
Raw url /callback/slot/calendar/{callbackCalendarId}
Allowed methods DELETE
Description Allowed body fields


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


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


Name callback.Trigger.delete
Raw url /callback/trigger/{callbackTriggerId}
Allowed methods DELETE
Description Allowed body fields


Name callback.trigger.Action.create
Raw url /callback/trigger/{callbackTriggerId}/action
Allowed methods POST
Description Allowed body fields
  • action
  • value
  • pbx_callback_entry_data_key


Name callback.trigger.Action.browse
Raw url /callback/trigger/{callbackTriggerId}/action
Allowed methods GET
Description Allowed body fields


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


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


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


Name callback.WebBooking.getTimes
Raw url /callback/webbooking/{id}/times
Allowed methods GET
Description Allowed body fields


Name Cfc.read
Raw url /cfc/{id}
Allowed methods GET
Description Allowed body fields


Name Cfc.update
Raw url /cfc/{id}
Allowed methods PATCH
Description Allowed body fields
  • [state]
  • [pbx_soundfile_id_on]
  • [pbx_soundfile_id_off]


Name CfcSound.browse
Raw url /cfc/{id}/sound
Allowed methods GET
Description Allowed body fields


Name CfcSound.create
Raw url /cfc/{id}/sound
Allowed methods POST
Description Allowed body fields
  • name


Name CfcSound.downloadFile
Raw url /cfc/{id}/sound/{soundId}/file/{audioType}
Allowed methods GET
Description Allowed body fields


Name Channel.bridge
Raw url /channel/{channelId1}/bridge/{channelId2}
Allowed methods POST
Description Allowed body fields


Name Channel.merge
Raw url /channel/{channelId1}/merge/{channelId2}
Allowed methods POST
Description Allowed body fields


Name Channel.getChannel
Raw url /channel/{channelId}
Allowed methods GET
Description Allowed body fields


Name Channel.deleteChannel
Raw url /channel/{channelId}
Allowed methods DELETE
Description Allowed body fields


Name Channel.answerChannel
Raw url /channel/{channelId}/answer
Allowed methods POST
Description Allowed body fields


Name Channel.atxfer
Raw url /channel/{channelId}/atxfer
Allowed methods POST
Description Allowed body fields
  • exten


Name Channel.atxferCancel
Raw url /channel/{channelId}/atxfer
Allowed methods DELETE
Description Allowed body fields


Name Channel.atxferTransfer
Raw url /channel/{channelId}/atxfer/transfer
Allowed methods POST
Description Allowed body fields


Name Channel.playDTMF
Raw url /channel/{channelId}/dtmf
Allowed methods POST
Description Allowed body fields
  • digit


Name Channel.holdChannel
Raw url /channel/{channelId}/hold
Allowed methods POST
Description Allowed body fields


Name Channel.deleteHold
Raw url /channel/{channelId}/hold
Allowed methods DELETE
Description Allowed body fields


Name Channel.moveToAccount
Raw url /channel/{channelId}/move-to/account
Allowed methods POST
Description Allowed body fields
  • pbx_account_id


Name Channel.muteChannel
Raw url /channel/{channelId}/mute
Allowed methods POST
Description Allowed body fields


Name Channel.deleteMute
Raw url /channel/{channelId}/mute
Allowed methods DELETE
Description Allowed body fields


Name Channel.recordChannel
Raw url /channel/{channelId}/record
Allowed methods POST
Description Allowed body fields


Name Channel.transfer
Raw url /channel/{channelId}/transfer
Allowed methods POST
Description Allowed body fields
  • exten


Name Channel.waitOn
Raw url /channel/{channelId}/waiton/{userId}
Allowed methods POST
Description Allowed body fields


Name Channel.deleteChannelsByGuid
Raw url /channels/by/guid/{call_guid}
Allowed methods DELETE
Description Allowed body fields


Name ChatMessage.update
Raw url /chat/message/{chatMessageId}
Allowed methods PATCH
Description Allowed body fields
  • message


Name ChatMessage.read
Raw url /chat/message/{chatMessageId}
Allowed methods GET
Description Allowed body fields


Name ChatMessage.delete
Raw url /chat/message/{chatMessageId}
Allowed methods DELETE
Description Allowed body fields


Name ChatRoom.create
Raw url /chat/room
Allowed methods POST
Description Allowed body fields
  • [name]
  • [users]


Name ChatRoom.update
Raw url /chat/room/{chatRoomId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_user_id]


Name ChatRoom.read
Raw url /chat/room/{chatRoomId}
Allowed methods GET
Description Allowed body fields


Name ChatRoom.delete
Raw url /chat/room/{chatRoomId}
Allowed methods DELETE
Description Allowed body fields


Name ChatRoom.createMessage
Raw url /chat/room/{chatRoomId}/message
Allowed methods POST
Description Allowed body fields
  • message


Name ChatRoom.browseMessages
Raw url /chat/room/{chatRoomId}/messages
Allowed methods GET
Description Allowed body fields


Name chatroom.User.create
Raw url /chat/room/{chatRoomId}/user/{userId}
Allowed methods POST
Description Allowed body fields


Name chatroom.User.delete
Raw url /chat/room/{chatRoomId}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name chatroom.Webhook.browse
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods GET
Description Allowed body fields


Name chatroom.Webhook.create
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods POST
Description Allowed body fields


Name chatroom.Webhook.delete
Raw url /chat/room/{chatRoomId}/webhook
Allowed methods DELETE
Description Allowed body fields


Name chatroom.Webhook.read
Raw url /chat/room/{chatRoomId}/webhook/{webhookId}
Allowed methods GET
Description Allowed body fields


Name chatroom.webhook.Message.create
Raw url /chat/room/{chatRoomId}/webhook/{webhookToken}/message
Allowed methods POST
Description Allowed body fields


Name ChatRoom.writeStatus
Raw url /chat/room/{chatRoomId}/write-status
Allowed methods POST
Description Allowed body fields
  • status


Name Color.browse
Raw url /color
Allowed methods GET
Description Allowed body fields


Name Communicator.download
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}
Allowed methods GET
Description Allowed body fields


Name Communicator.changelog
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}/changelog
Allowed methods GET
Description Allowed body fields


Name Communicator.versions
Raw url /communicator/{brandingName}/{communicatorVersion}/{communicatorArch}/{communicatorPlatform}/{communicatorOs}/versions
Allowed methods GET
Description Allowed body fields


Name Companies.browse
Raw url /companies
Allowed methods GET
Description Allowed body fields


Name Company.update
Raw url /company
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [pbx_areacode_id]
  • [ast_language_id]
  • [description]


Name Company.read
Raw url /company
Allowed methods GET
Description Allowed body fields


Name company.AclUser.browse
Raw url /company/acl/group/{groupId}/users
Allowed methods GET
Description Allowed body fields


Name company.AclUser.browseDepartment
Raw url /company/acl/group/{groupId}/usersdepartment
Allowed methods GET
Description Allowed body fields


Name company.Acl.browse
Raw url /company/acl/groups
Allowed methods GET
Description Allowed body fields


Name Company.activate
Raw url /company/activate
Allowed methods POST
Description Allowed body fields


Name company.Areacode.browse
Raw url /company/areacode
Allowed methods GET
Description Allowed body fields


Name company.auth.Azure.getToken
Raw url /company/auth/azure/codeswap
Allowed methods GET
Description Allowed body fields


Name company.auth.Azure.renewAccessToken
Raw url /company/auth/azure/renew
Allowed methods POST
Description Allowed body fields
  • tenant
  • id


Name company.Blog.browse
Raw url /company/blog
Allowed methods GET
Description Allowed body fields


Name company.Blog.create
Raw url /company/blog
Allowed methods POST
Description Allowed body fields
  • title
  • message


Name company.Blog.read
Raw url /company/blog/{id}
Allowed methods GET
Description Allowed body fields


Name company.callback.Agent.browse
Raw url /company/callback/agent
Allowed methods GET
Description Allowed body fields


Name company.callback.Destination.browse
Raw url /company/callback/destination
Allowed methods GET
Description Allowed body fields


Name company.callback.Destination.create
Raw url /company/callback/destination
Allowed methods POST
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.callback.Destination.browseTemplate
Raw url /company/callback/destination/from-template
Allowed methods GET
Description Allowed body fields


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


Name company.CallBlock.browse
Raw url /company/callblock
Allowed methods GET
Description Allowed body fields


Name company.CallBlock.read
Raw url /company/callblock/{id}
Allowed methods GET
Description Allowed body fields


Name company.Cfc.browse
Raw url /company/cfc
Allowed methods GET
Description Allowed body fields


Name company.Cfc.read
Raw url /company/cfc/{smsId}
Allowed methods GET
Description Allowed body fields


Name Company.checkAlias
Raw url /company/checkAlias/{userId}/{alias}
Allowed methods GET
Description Allowed body fields


Name company.Cid.browse
Raw url /company/cid
Allowed methods GET
Description Allowed body fields


Name company.Cid.read
Raw url /company/cid/{cidId}
Allowed methods GET
Description Allowed body fields


Name company.Crm.create
Raw url /company/crm
Allowed methods POST
Description Allowed body fields
  • [crm_type]
  • [active]
  • [settings]
  • [triggers]


Name company.Crm.browse
Raw url /company/crm
Allowed methods GET
Description Allowed body fields


Name company.Crm.readActive
Raw url /company/crm/active
Allowed methods GET
Description Allowed body fields


Name company.Crm.allowed
Raw url /company/crm/allowed
Allowed methods GET
Description Allowed body fields


Name company.Crm.delete
Raw url /company/crm/{crmEntryId}
Allowed methods DELETE
Description Allowed body fields


Name company.Crm.read
Raw url /company/crm/{crmEntryId}
Allowed methods GET
Description Allowed body fields


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


Name company.Crm.readCaller
Raw url /company/crm/{crmEntryId}/caller
Allowed methods GET
Description Allowed body fields


Name company.CustomerData.update
Raw url /company/customerdata
Allowed methods PATCH
Description Allowed body fields
  • customer-data


Name company.CustomerData.read
Raw url /company/customerdata
Allowed methods GET
Description Allowed body fields


Name company.CompanyData.update
Raw url /company/customerdata/companydata
Allowed methods PATCH
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.CompanyData.read
Raw url /company/customerdata/companydata
Allowed methods GET
Description Allowed body fields


Name company.customerdata.KeyValue.create
Raw url /company/customerdata/keyvalue
Allowed methods POST
Description Allowed body fields
  • key
  • value


Name company.customerdata.KeyValue.read
Raw url /company/customerdata/keyvalue/{id}
Allowed methods GET
Description Allowed body fields


Name company.customerdata.KeyValue.delete
Raw url /company/customerdata/keyvalue/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.customerdata.KeyValue.update
Raw url /company/customerdata/keyvalue/{id}
Allowed methods PATCH
Description Allowed body fields
  • key
  • value


Name company.customerdata.UserData.read
Raw url /company/customerdata/userdata/{userId}
Allowed methods GET
Description Allowed body fields


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


Name company.customerdata.userdata.KeyValue.browse
Raw url /company/customerdata/userdata/{userId}/keyvalue
Allowed methods GET
Description Allowed body fields


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


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


Name company.customerdata.userdata.KeyValue.read
Raw url /company/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods GET
Description Allowed body fields


Name company.customerdata.userdata.KeyValue.delete
Raw url /company/customerdata/userdata/{userId}/keyvalue/{itemId}
Allowed methods DELETE
Description Allowed body fields


Name Company.deactivate
Raw url /company/deactivate
Allowed methods POST
Description Allowed body fields


Name Company.deletable
Raw url /company/deletable
Allowed methods GET
Description Allowed body fields


Name Company.delete
Raw url /company/delete/{answer}
Allowed methods DELETE
Description Allowed body fields


Name company.Department.create
Raw url /company/department
Allowed methods POST
Description Allowed body fields
  • name
  • description


Name company.Department.browse
Raw url /company/department
Allowed methods GET
Description Allowed body fields


Name company.Department.read
Raw url /company/department/{id}
Allowed methods GET
Description Allowed body fields


Name company.Department.delete
Raw url /company/department/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.Department.update
Raw url /company/department/{id}
Allowed methods PATCH
Description Allowed body fields
  • name
  • description


Name company.department.acl.Group.create
Raw url /company/department/{id}/acl/group
Allowed methods POST
Description Allowed body fields
  • group_id


Name company.department.acl.Group.browse
Raw url /company/department/{id}/acl/group
Allowed methods GET
Description Allowed body fields


Name company.department.acl.Group.delete
Raw url /company/department/{id}/acl/group/{groupId}
Allowed methods DELETE
Description Allowed body fields


Name company.department.User.update
Raw url /company/department/{id}/user/{userId}
Allowed methods PATCH
Description Allowed body fields


Name company.department.User.delete
Raw url /company/department/{id}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company.Did.browse
Raw url /company/did
Allowed methods GET
Description Allowed body fields


Name company.Did.readAvailable
Raw url /company/did/available
Allowed methods GET
Description Allowed body fields


Name company.Did.read
Raw url /company/did/{didId}
Allowed methods GET
Description Allowed body fields


Name company.FieldTypes.browse
Raw url /company/fieldtypes
Allowed methods GET
Description Allowed body fields


Name company.Pbx.GenericRecording.read
Raw url /company/generic-recordings/{id}
Allowed methods GET
Description Allowed body fields


Name company.Pbx.GenericRecording.delete
Raw url /company/generic-recordings/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name Company.getDeleteQuestion
Raw url /company/getdeletequestion
Allowed methods GET
Description Allowed body fields


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


Name company.hotel.Hotel.browse
Raw url /company/hotel
Allowed methods GET
Description Allowed body fields


Name company.hotel.Hotel.getAvailableUsers
Raw url /company/hotel/getavailableusers
Allowed methods GET
Description Allowed body fields


Name company.hotel.Room.browse
Raw url /company/hotel/{hotelId}/room
Allowed methods GET
Description Allowed body fields


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


Name company.hotel.Room.read
Raw url /company/hotel/{hotelId}/room/{id}
Allowed methods GET
Description Allowed body fields


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


Name company.hotel.Room.delete
Raw url /company/hotel/{hotelId}/room/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.hotel.Room.ackCleaned
Raw url /company/hotel/{hotelId}/room/{id}/cleaned
Allowed methods POST
Description Allowed body fields


Name company.hotel.Room.closePhone
Raw url /company/hotel/{hotelId}/room/{id}/closephone
Allowed methods POST
Description Allowed body fields


Name company.hotel.Room.doInvoice
Raw url /company/hotel/{hotelId}/room/{id}/invoice
Allowed methods POST
Description Allowed body fields


Name company.hotel.Room.showInvoice
Raw url /company/hotel/{hotelId}/room/{id}/invoice/{invoiceId}
Allowed methods GET
Description Allowed body fields


Name company.hotel.Room.listInvoices
Raw url /company/hotel/{hotelId}/room/{id}/invoices
Allowed methods GET
Description Allowed body fields


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


Name company.hotel.Room.openPhone
Raw url /company/hotel/{hotelId}/room/{id}/openphone
Allowed methods POST
Description Allowed body fields


Name company.hotel.Room.cleaned
Raw url /company/hotel/{hotelId}/room/{id}/setcleaned
Allowed methods POST
Description Allowed body fields


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


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


Name company.hotel.Hotel.delete
Raw url /company/hotel/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.hotel.Hotel.read
Raw url /company/hotel/{id}
Allowed methods GET
Description Allowed body fields


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


Name company.hotel.Hotel.isUserAvailable
Raw url /company/hotel/{userId}/isuseravailable
Allowed methods GET
Description Allowed body fields


Name company.Invoice.browse
Raw url /company/invoice
Allowed methods GET
Description Allowed body fields


Name company.Invoice.details
Raw url /company/invoice/details
Allowed methods GET
Description Allowed body fields


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


Name company.License.browse
Raw url /company/license
Allowed methods GET
Description Allowed body fields


Name company.license.Services.getWebullServices
Raw url /company/license/services
Allowed methods GET
Description Allowed body fields


Name company.License.delete
Raw url /company/license/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company.License.deleteWebullService
Raw url /company/license/{id}/service/delete
Allowed methods DELETE
Description Allowed body fields


Name company.HasLicense.hasLicense
Raw url /company/license/{licenseType}/has
Allowed methods GET
Description Allowed body fields


Name company.Logger.browse
Raw url /company/logger
Allowed methods GET
Description Allowed body fields


Name company.Logger.read
Raw url /company/logger/{userId}
Allowed methods GET
Description Allowed body fields


Name company.Message.browse
Raw url /company/messages
Allowed methods GET
Description Allowed body fields


Name company.Mobile.browse
Raw url /company/mobile
Allowed methods GET
Description Allowed body fields


Name company.Mobile.read
Raw url /company/mobile/{simno}
Allowed methods GET
Description Allowed body fields


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


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


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


Name company.Mobile.topupHistory
Raw url /company/mobile/{simno}/topuphistory
Allowed methods GET
Description Allowed body fields


Name company.Overview.read
Raw url /company/overview
Allowed methods GET
Description Allowed body fields


Name company.Partner.read
Raw url /company/partner
Allowed methods GET
Description Allowed body fields


Name company.PbxFlow.browse
Raw url /company/pbxflow
Allowed methods GET
Description Allowed body fields


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


Name company.PbxFlow.read
Raw url /company/pbxflow/{id}
Allowed methods GET
Description Allowed body fields


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


Name company.PbxFlow.delete
Raw url /company/pbxflow/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.PingPong.ping
Raw url /company/pingpong
Allowed methods GET
Description Allowed body fields


Name company.profile.Standard.browse
Raw url /company/profile/standard
Allowed methods GET
Description Allowed body fields


Name Company.Profile.browse
Raw url /company/profiles
Allowed methods GET
Description Allowed body fields


Name company.PstnNumber.browse
Raw url /company/pstnnumber
Allowed methods GET
Description Allowed body fields


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


Name company.PstnNumber.setFixedSms
Raw url /company/pstnnumber/{e164}/setsms/{cellE164}
Allowed methods PATCH
Description Allowed body fields


Name company.Pbx.PstnRecording.browse
Raw url /company/pstnrecordings
Allowed methods GET
Description Allowed body fields


Name company.Pbx.PstnRecording.delete
Raw url /company/pstnrecordings/{id}
Allowed methods DELETE
Description Allowed body fields


Name company.Queue.browse
Raw url /company/queues
Allowed methods GET
Description Allowed body fields


Name company.Queue.browseAll
Raw url /company/queues/all
Allowed methods GET
Description Allowed body fields


Name company.QueueStat.browse
Raw url /company/queuestat
Allowed methods GET
Description Allowed body fields


Name company.queuestat.Calls.browse
Raw url /company/queuestat/calls
Allowed methods GET
Description Allowed body fields


Name company.queuestat.Calls.read
Raw url /company/queuestat/calls/{qsCallUniqueId}
Allowed methods GET
Description Allowed body fields


Name company.Pbx.Recording.retin
Raw url /company/recordings
Allowed methods DELETE
Description Allowed body fields


Name company.Pbx.Recording.browse
Raw url /company/recordings
Allowed methods GET
Description Allowed body fields


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


Name company.report.argument.Fields.browse
Raw url /company/report/argument/fields
Allowed methods GET
Description Allowed body fields


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


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


Name company.report.Type.browse
Raw url /company/report/type
Allowed methods GET
Description Allowed body fields


Name company.Report.delete
Raw url /company/report/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company.report.Argument.create
Raw url /company/report/{id}/argument
Allowed methods POST
Description Allowed body fields
  • key
  • value


Name company.report.Argument.delete
Raw url /company/report/{id}/argument/{argumentId}
Allowed methods DELETE
Description Allowed body fields


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


Name company.Report.getReportHTML
Raw url /company/report/{id}/html
Allowed methods GET
Description Allowed body fields


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


Name company.Report.browse
Raw url /company/report{/reportTypeId}
Allowed methods GET
Description Allowed body fields


Name company.Retainment.browse
Raw url /company/retainment
Allowed methods GET
Description Allowed body fields


Name company.Retainment.create
Raw url /company/retainment
Allowed methods POST
Description Allowed body fields
  • retainment_type_id
  • value


Name company.RetainmentTypes.browse
Raw url /company/retainment/types
Allowed methods GET
Description Allowed body fields


Name company.Retainment.update
Raw url /company/retainment/{id}
Allowed methods PATCH
Description Allowed body fields
  • value


Name company.selfservice.Number.browse
Raw url /company/selfservice/number
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Number.available
Raw url /company/selfservice/number/available
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Sim.browse
Raw url /company/selfservice/sim
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Sim.available
Raw url /company/selfservice/sim/available
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Subscription.browse
Raw url /company/selfservice/subscription
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Subscription.create
Raw url /company/selfservice/subscription
Allowed methods POST
Description Allowed body fields
  • name
  • sim_id
  • [selfservice_pricelist_program_id]
  • [date]
  • [allowed_to_topup]
  • [pbx_user_id]


Name company.selfservice.subscription.Port.create
Raw url /company/selfservice/subscription/port
Allowed methods POST
Description Allowed body fields
  • contact_email
  • contact_number
  • items


Name company.selfservice.PriceList.browse
Raw url /company/selfservice/subscription/pricelist
Allowed methods GET
Description Allowed body fields


Name company.selfservice.Subscription.update
Raw url /company/selfservice/subscription/{subscriptionId}
Allowed methods PATCH
Description Allowed body fields
  • name
  • sim_id
  • [selfservice_pricelist_program_id]
  • [date]
  • [allowed_to_topup]
  • [pbx_user_id]


Name company.selfservice.subscription.SIM.update
Raw url /company/selfservice/subscription/{subscriptionId}/sim
Allowed methods PATCH
Description Allowed body fields
  • sim_id


Name company.skype.Event.event
Raw url /company/skype/event
Allowed methods POST
Description Allowed body fields
  • pbx_user_id
  • event


Name company.skype.Users.users
Raw url /company/skype/users
Allowed methods GET
Description Allowed body fields


Name company.sms.browse
Raw url /company/sms
Allowed methods GET
Description Allowed body fields


Name company.sms.read
Raw url /company/sms/{smsId}
Allowed methods GET
Description Allowed body fields


Name company.Soundfile.browse
Raw url /company/soundfile
Allowed methods GET
Description Allowed body fields


Name company.Template.create
Raw url /company/template
Allowed methods POST
Description Allowed body fields
  • name
  • [description]
  • type


Name company.Template.browse
Raw url /company/template
Allowed methods GET
Description Allowed body fields


Name company.template.Field.browseAll
Raw url /company/template/field
Allowed methods GET
Description Allowed body fields


Name company.template.Field.browse
Raw url /company/template/field/{templateType}
Allowed methods GET
Description Allowed body fields


Name company.Template.delete
Raw url /company/template/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company.Template.read
Raw url /company/template/{id}
Allowed methods GET
Description Allowed body fields


Name company.template.User.browse
Raw url /company/template/{id}/user
Allowed methods GET
Description Allowed body fields


Name company.template.User.create
Raw url /company/template/{id}/user
Allowed methods POST
Description Allowed body fields
  • pbx_user_id


Name company.template.User.browseAvailable
Raw url /company/template/{id}/user/available
Allowed methods GET
Description Allowed body fields


Name company.template.User.delete
Raw url /company/template/{id}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company.template.Value.browse
Raw url /company/template/{id}/value
Allowed methods GET
Description Allowed body fields


Name company.template.Value.update
Raw url /company/template/{id}/value/{fieldId}
Allowed methods PATCH
Description Allowed body fields
  • value


Name company.UserReports.browse
Raw url /company/userreports
Allowed methods GET
Description Allowed body fields


Name Company.User.browse
Raw url /company/users
Allowed methods GET
Description Allowed body fields


Name company.pbx.Wallboard.browse
Raw url /company/wallboard
Allowed methods GET
Description Allowed body fields


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


Name company.pbx.Wallboard.browseCommon
Raw url /company/wallboard/common
Allowed methods GET
Description Allowed body fields


Name company.pbx.Wallboard.readCommon
Raw url /company/wallboard/common/{id}
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardThemes.browse
Raw url /company/wallboard/theme
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardThemeColors.browse
Raw url /company/wallboard/theme/color
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardThemeColors.read
Raw url /company/wallboard/theme/color/{id}
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardThemes.read
Raw url /company/wallboard/theme/{id}
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardToken.browse
Raw url /company/wallboard/token
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardToken.create
Raw url /company/wallboard/token
Allowed methods POST
Description Allowed body fields
  • pbx_user_id


Name company.pbx.WallboardToken.read
Raw url /company/wallboard/token/{id}
Allowed methods GET
Description Allowed body fields


Name company.pbx.WallboardToken.delete
Raw url /company/wallboard/token/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company.pbx.Wallboard.read
Raw url /company/wallboard/{id}
Allowed methods GET
Description Allowed body fields


Name company.pbx.Wallboard.delete
Raw url /company/wallboard/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company.pbx.WallboardQueue.delete
Raw url /company/wallboard/{id}/queue/{queueId}
Allowed methods DELETE
Description Allowed body fields


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


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


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


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


Name company.wallboardoutgoing.Wallboard.browse
Raw url /company/wallboardoutgoing
Allowed methods GET
Description Allowed body fields


Name company.wallboardoutgoing.Wallboard.create
Raw url /company/wallboardoutgoing
Allowed methods POST
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.Wallboard.data
Raw url /company/wallboardoutgoing/data/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name company.wallboardoutgoing.Wallboard.read
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name company.wallboardoutgoing.Wallboard.update
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods POST
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.Wallboard.delete
Raw url /company/wallboardoutgoing/{wallboardId}
Allowed methods DELETE
Description Allowed body fields


Name company.wallboardoutgoing.Wallboard.deleteColumn
Raw url /company/wallboardoutgoing/{wallboardId}/column/{columnId}
Allowed methods DELETE
Description Allowed body fields


Name company.wallboardoutgoing.Wallboard.deleteUser
Raw url /company/wallboardoutgoing/{wallboardId}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company.webchat.Channel.create
Raw url /company/webchat/channel
Allowed methods POST
Description Allowed body fields
  • pbx_omnigroup_id


Name company.webchat.Channel.browse
Raw url /company/webchat/channel
Allowed methods GET
Description Allowed body fields


Name company.webchat.Channel.deleteChannel
Raw url /company/webchat/channel/{channelId}
Allowed methods DELETE
Description Allowed body fields


Name company.webchat.Channel.update
Raw url /company/webchat/channel/{channelId}
Allowed methods POST
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]
  • [default_brand]
  • [deleted]


Name company.webchat.Channel.read
Raw url /company/webchat/channel/{channelId}
Allowed methods GET
Description Allowed body fields


Name company.webchat.Channel.deleteChannelInput
Raw url /company/webchat/channel/{channelId}/{inputId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.read
Raw url /company/{companyId}
Allowed methods GET
Description Allowed body fields


Name company_id.update
Raw url /company/{companyId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_tz_id]
  • [pbx_country_id]
  • [pbx_areacode_id]
  • [ast_language_id]
  • [description]


Name company_id.AclUser.browse
Raw url /company/{companyId}/acl/group/{groupId}/users
Allowed methods GET
Description Allowed body fields


Name company_id.AclUser.browseDepartment
Raw url /company/{companyId}/acl/group/{groupId}/usersdepartment
Allowed methods GET
Description Allowed body fields


Name company_id.Acl.browse
Raw url /company/{companyId}/acl/groups
Allowed methods GET
Description Allowed body fields


Name company_id.activate
Raw url /company/{companyId}/activate
Allowed methods POST
Description Allowed body fields


Name company_id.Areacode.browse
Raw url /company/{companyId}/areacode
Allowed methods GET
Description Allowed body fields


Name company_id.auth.Azure.getToken
Raw url /company/{companyId}/auth/azure/codeswap
Allowed methods GET
Description Allowed body fields


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


Name company_id.Blog.create
Raw url /company/{companyId}/blog
Allowed methods POST
Description Allowed body fields
  • title
  • message


Name company_id.Blog.browse
Raw url /company/{companyId}/blog
Allowed methods GET
Description Allowed body fields


Name company_id.Blog.read
Raw url /company/{companyId}/blog/{id}
Allowed methods GET
Description Allowed body fields


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


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


Name company_id.callback.Destination.create
Raw url /company/{companyId}/callback/destination
Allowed methods POST
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.callback.Destination.browseTemplate
Raw url /company/{companyId}/callback/destination/from-template
Allowed methods GET
Description Allowed body fields


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


Name company_id.CallBlock.browse
Raw url /company/{companyId}/callblock
Allowed methods GET
Description Allowed body fields


Name company_id.CallBlock.read
Raw url /company/{companyId}/callblock/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.Cfc.browse
Raw url /company/{companyId}/cfc
Allowed methods GET
Description Allowed body fields


Name company_id.Cfc.read
Raw url /company/{companyId}/cfc/{smsId}
Allowed methods GET
Description Allowed body fields


Name company_id.checkAlias
Raw url /company/{companyId}/checkAlias/{userId}/{alias}
Allowed methods GET
Description Allowed body fields


Name company_id.Cid.browse
Raw url /company/{companyId}/cid
Allowed methods GET
Description Allowed body fields


Name company_id.Cid.read
Raw url /company/{companyId}/cid/{cidId}
Allowed methods GET
Description Allowed body fields


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


Name company_id.CustomerData.read
Raw url /company/{companyId}/customerdata
Allowed methods GET
Description Allowed body fields


Name company_id.CompanyData.read
Raw url /company/{companyId}/customerdata/companydata
Allowed methods GET
Description Allowed body fields


Name company_id.CompanyData.update
Raw url /company/{companyId}/customerdata/companydata
Allowed methods PATCH
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.KeyValue.create
Raw url /company/{companyId}/customerdata/keyvalue
Allowed methods POST
Description Allowed body fields
  • key
  • value


Name company_id.customerdata.KeyValue.delete
Raw url /company/{companyId}/customerdata/keyvalue/{id}
Allowed methods DELETE
Description Allowed body fields


Name company_id.customerdata.KeyValue.read
Raw url /company/{companyId}/customerdata/keyvalue/{id}
Allowed methods GET
Description Allowed body fields


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


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


Name company_id.customerdataUserData.read
Raw url /company/{companyId}/customerdata/userdata/{userId}
Allowed methods GET
Description Allowed body fields


Name company_id.customerdata.userdata.KeyValue.browse
Raw url /company/{companyId}/customerdata/userdata/{userId}/keyvalue
Allowed methods GET
Description Allowed body fields


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


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


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


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


Name company_id.deactivate
Raw url /company/{companyId}/deactivate
Allowed methods POST
Description Allowed body fields


Name company_id.deletable
Raw url /company/{companyId}/deletable
Allowed methods GET
Description Allowed body fields


Name company_id.delete
Raw url /company/{companyId}/delete/{answer}
Allowed methods DELETE
Description Allowed body fields


Name company_id.Department.browse
Raw url /company/{companyId}/department
Allowed methods GET
Description Allowed body fields


Name company_id.Department.create
Raw url /company/{companyId}/department
Allowed methods POST
Description Allowed body fields
  • name
  • description


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


Name company_id.Department.read
Raw url /company/{companyId}/department/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.Department.delete
Raw url /company/{companyId}/department/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.department.acl.Group.browse
Raw url /company/{companyId}/department/{id}/acl/group
Allowed methods GET
Description Allowed body fields


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


Name company_id.department.User.delete
Raw url /company/{companyId}/department/{id}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.department.User.update
Raw url /company/{companyId}/department/{id}/user/{userId}
Allowed methods PATCH
Description Allowed body fields


Name company_id.Did.browse
Raw url /company/{companyId}/did
Allowed methods GET
Description Allowed body fields


Name company_id.Did.readAvailable
Raw url /company/{companyId}/did/available
Allowed methods GET
Description Allowed body fields


Name company_id.Did.read
Raw url /company/{companyId}/did/{didId}
Allowed methods GET
Description Allowed body fields


Name company_id.FieldTypes.browse
Raw url /company/{companyId}/fieldtypes
Allowed methods GET
Description Allowed body fields


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


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


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


Name company_id.getDeleteQuestion
Raw url /company/{companyId}/getdeletequestion
Allowed methods GET
Description Allowed body fields


Name company_id.hotel.Hotel.create
Raw url /company/{companyId}/hotel
Allowed methods POST
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.Hotel.browse
Raw url /company/{companyId}/hotel
Allowed methods GET
Description Allowed body fields


Name company_id.hotel.Hotel.getAvailableUsers
Raw url /company/{companyId}/hotel/getavailableusers
Allowed methods GET
Description Allowed body fields


Name company_id.hotel.Room.browse
Raw url /company/{companyId}/hotel/{hotelId}/room
Allowed methods GET
Description Allowed body fields


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


Name company_id.hotel.Room.read
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}
Allowed methods GET
Description Allowed body fields


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


Name company_id.hotel.Room.delete
Raw url /company/{companyId}/hotel/{hotelId}/room/{id}
Allowed methods DELETE
Description Allowed body fields


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


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


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


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


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


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


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


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


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


Name company_id.hotel.Hotel.read
Raw url /company/{companyId}/hotel/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.hotel.Hotel.update
Raw url /company/{companyId}/hotel/{id}
Allowed methods PATCH
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.Hotel.delete
Raw url /company/{companyId}/hotel/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.hotel.Hotel.isUserAvailable
Raw url /company/{companyId}/hotel/{userId}/isuseravailable
Allowed methods GET
Description Allowed body fields


Name company_id.Invoice.browse
Raw url /company/{companyId}/invoice
Allowed methods GET
Description Allowed body fields


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


Name company_id.License.browse
Raw url /company/{companyId}/license
Allowed methods GET
Description Allowed body fields


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


Name company_id.License.delete
Raw url /company/{companyId}/license/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.License.deleteWebullService
Raw url /company/{companyId}/license/{id}/service/delete
Allowed methods DELETE
Description Allowed body fields


Name company_id.HasLicense.hasLicense
Raw url /company/{companyId}/license/{licenseType}/has
Allowed methods GET
Description Allowed body fields


Name company_id.Logger.browse
Raw url /company/{companyId}/logger
Allowed methods GET
Description Allowed body fields


Name company_id.Logger.read
Raw url /company/{companyId}/logger/{userId}
Allowed methods GET
Description Allowed body fields


Name company_id.Message.browse
Raw url /company/{companyId}/messages
Allowed methods GET
Description Allowed body fields


Name company_id.Mobile.browse
Raw url /company/{companyId}/mobile
Allowed methods GET
Description Allowed body fields


Name company_id.Mobile.read
Raw url /company/{companyId}/mobile/{simno}
Allowed methods GET
Description Allowed body fields


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


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


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


Name company_id.Mobile.topupHistory
Raw url /company/{companyId}/mobile/{simno}/topuphistory
Allowed methods GET
Description Allowed body fields


Name company.webchat.Omnigroup.browse
Raw url /company/{companyId}/omnigroup
Allowed methods GET
Description Allowed body fields


Name company_id.Overview.read
Raw url /company/{companyId}/overview
Allowed methods GET
Description Allowed body fields


Name company_id.Partner.read
Raw url /company/{companyId}/partner
Allowed methods GET
Description Allowed body fields


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


Name company_id.PbxFlow.browse
Raw url /company/{companyId}/pbxflow
Allowed methods GET
Description Allowed body fields


Name company_id.PbxFlow.read
Raw url /company/{companyId}/pbxflow/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.PbxFlow.delete
Raw url /company/{companyId}/pbxflow/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.PingPong.ping
Raw url /company/{companyId}/pingpong
Allowed methods GET
Description Allowed body fields


Name company_id.profile.Standard.browse
Raw url /company/{companyId}/profile/standard
Allowed methods GET
Description Allowed body fields


Name company_id.Profile.browse
Raw url /company/{companyId}/profiles
Allowed methods GET
Description Allowed body fields


Name company_id.PstnNumber.browse
Raw url /company/{companyId}/pstnnumber
Allowed methods GET
Description Allowed body fields


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


Name company_id.PstnNumber.setFixedSms
Raw url /company/{companyId}/pstnnumber/{e164}/setsms/{cellE164}
Allowed methods PATCH
Description Allowed body fields


Name company_id.Pbx.PstnRecording.browse
Raw url /company/{companyId}/pstnrecordings
Allowed methods GET
Description Allowed body fields


Name company_id.Pbx.PstnRecording.delete
Raw url /company/{companyId}/pstnrecordings/{id}
Allowed methods DELETE
Description Allowed body fields


Name company_id.Queue.browse
Raw url /company/{companyId}/queues
Allowed methods GET
Description Allowed body fields


Name company_id.Queue.browseAll
Raw url /company/{companyId}/queues/all
Allowed methods GET
Description Allowed body fields


Name company_id.QueueStat.browse
Raw url /company/{companyId}/queuestat
Allowed methods GET
Description Allowed body fields


Name company_id.queuestat.Calls.browse
Raw url /company/{companyId}/queuestat/calls
Allowed methods GET
Description Allowed body fields


Name company_id.queuestat.Calls.read
Raw url /company/{companyId}/queuestat/calls/{qsCallUniqueId}
Allowed methods GET
Description Allowed body fields


Name company_id.Pbx.Recording.retin
Raw url /company/{companyId}/recordings
Allowed methods DELETE
Description Allowed body fields


Name company_id.Pbx.Recording.browse
Raw url /company/{companyId}/recordings
Allowed methods GET
Description Allowed body fields


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


Name company_id.report.argument.Fields.browse
Raw url /company/{companyId}/report/argument/fields
Allowed methods GET
Description Allowed body fields


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


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


Name company_id.report.Type.browse
Raw url /company/{companyId}/report/type
Allowed methods GET
Description Allowed body fields


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


Name company_id.Report.delete
Raw url /company/{companyId}/report/{id}
Allowed methods DELETE
Description Allowed body fields


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


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


Name company_id.report.Argument.delete
Raw url /company/{companyId}/report/{id}/argument/{argumentId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.Report.getReportHTML
Raw url /company/{companyId}/report/{id}/html
Allowed methods GET
Description Allowed body fields


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


Name company_id.Report.browse
Raw url /company/{companyId}/report{/reportTypeId}
Allowed methods GET
Description Allowed body fields


Name company_id.Retainment.create
Raw url /company/{companyId}/retainment
Allowed methods POST
Description Allowed body fields
  • retainment_type_id
  • value


Name company_id.Retainment.browse
Raw url /company/{companyId}/retainment
Allowed methods GET
Description Allowed body fields


Name company_id.RetainmentTypes.browse
Raw url /company/{companyId}/retainment/types
Allowed methods GET
Description Allowed body fields


Name company_id.Retainment.update
Raw url /company/{companyId}/retainment/{id}
Allowed methods PATCH
Description Allowed body fields
  • value


Name company_id.selfservice.Number.browse
Raw url /company/{companyId}/selfservice/number
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.Number.available
Raw url /company/{companyId}/selfservice/number/available
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.Sim.browse
Raw url /company/{companyId}/selfservice/sim
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.Sim.available
Raw url /company/{companyId}/selfservice/sim/available
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.Subscription.create
Raw url /company/{companyId}/selfservice/subscription
Allowed methods POST
Description Allowed body fields
  • name
  • sim_id
  • [selfservice_pricelist_program_id]
  • [date]
  • [allowed_to_topup]
  • [pbx_user_id]


Name company_id.selfservice.Subscription.browse
Raw url /company/{companyId}/selfservice/subscription
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.subscription.Port.create
Raw url /company/{companyId}/selfservice/subscription/port
Allowed methods POST
Description Allowed body fields
  • contact_email
  • contact_number
  • items


Name company_id.selfservice.PriceList.browse
Raw url /company/{companyId}/selfservice/subscription/pricelist
Allowed methods GET
Description Allowed body fields


Name company_id.selfservice.Subscription.update
Raw url /company/{companyId}/selfservice/subscription/{subscriptionId}
Allowed methods PATCH
Description Allowed body fields
  • name
  • sim_id
  • [selfservice_pricelist_program_id]
  • [date]
  • [allowed_to_topup]
  • [pbx_user_id]


Name company_id.selfservice.subscription.SIM.update
Raw url /company/{companyId}/selfservice/subscription/{subscriptionId}/sim
Allowed methods PATCH
Description Allowed body fields
  • sim_id


Name company_id.Soundfile.browse
Raw url /company/{companyId}/soundfile
Allowed methods GET
Description Allowed body fields


Name company_id.Template.browse
Raw url /company/{companyId}/template
Allowed methods GET
Description Allowed body fields


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


Name company_id.template.Field.browseAll
Raw url /company/{companyId}/template/field
Allowed methods GET
Description Allowed body fields


Name company_id.template.Field.browse
Raw url /company/{companyId}/template/field/{templateType}
Allowed methods GET
Description Allowed body fields


Name company_id.Template.read
Raw url /company/{companyId}/template/{id}
Allowed methods GET
Description Allowed body fields


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


Name company_id.Template.delete
Raw url /company/{companyId}/template/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.template.User.browse
Raw url /company/{companyId}/template/{id}/user
Allowed methods GET
Description Allowed body fields


Name company_id.template.User.browseAvailable
Raw url /company/{companyId}/template/{id}/user/available
Allowed methods GET
Description Allowed body fields


Name company_id.template.User.delete
Raw url /company/{companyId}/template/{id}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.template.Value.browse
Raw url /company/{companyId}/template/{id}/value
Allowed methods GET
Description Allowed body fields


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


Name company_id.UserReports.browse
Raw url /company/{companyId}/userreports
Allowed methods GET
Description Allowed body fields


Name company_id.User.browse
Raw url /company/{companyId}/users
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.Wallboard.browse
Raw url /company/{companyId}/wallboard
Allowed methods GET
Description Allowed body fields


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


Name company_id.pbx.Wallboard.browseCommon
Raw url /company/{companyId}/wallboard/common
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.Wallboard.readCommon
Raw url /company/{companyId}/wallboard/common/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.WallboardThemes.browse
Raw url /company/{companyId}/wallboard/theme
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.WallboardThemeColors.browse
Raw url /company/{companyId}/wallboard/theme/color
Allowed methods GET
Description Allowed body fields


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


Name company_id.pbx.WallboardThemes.read
Raw url /company/{companyId}/wallboard/theme/{id}
Allowed methods GET
Description Allowed body fields


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


Name company_id.pbx.WallboardToken.browse
Raw url /company/{companyId}/wallboard/token
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.WallboardToken.read
Raw url /company/{companyId}/wallboard/token/{id}
Allowed methods GET
Description Allowed body fields


Name company_id.pbx.WallboardToken.delete
Raw url /company/{companyId}/wallboard/token/{id}
Allowed methods DELETE
Description Allowed body fields


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


Name company_id.pbx.Wallboard.delete
Raw url /company/{companyId}/wallboard/{id}
Allowed methods DELETE
Description Allowed body fields


Name company_id.pbx.Wallboard.read
Raw url /company/{companyId}/wallboard/{id}
Allowed methods GET
Description Allowed body fields


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


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


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


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


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


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


Name company_id.wallboardoutgoing.Wallboard.browse
Raw url /company/{companyId}/wallboardoutgoing
Allowed methods GET
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboard.create
Raw url /company/{companyId}/wallboardoutgoing
Allowed methods POST
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.Wallboard.data
Raw url /company/{companyId}/wallboardoutgoing/data/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboard.delete
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboard.read
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboard.update
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}
Allowed methods POST
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.Wallboard.deleteColumn
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}/column/{columnId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.wallboardoutgoing.Wallboard.deleteUser
Raw url /company/{companyId}/wallboardoutgoing/{wallboardId}/user/{userId}
Allowed methods DELETE
Description Allowed body fields


Name company.webchat.Branding.create
Raw url /company/{companyId}/webchat/branding
Allowed methods POST
Description Allowed body fields
  • title
  • data


Name company.webchat.Branding.browse
Raw url /company/{companyId}/webchat/branding
Allowed methods GET
Description Allowed body fields


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


Name company.webchat.Branding.read
Raw url /company/{companyId}/webchat/branding/{brandingId}
Allowed methods GET
Description Allowed body fields


Name company_id.webchat.Channel.browse
Raw url /company/{companyId}/webchat/channel
Allowed methods GET
Description Allowed body fields


Name company_id.webchat.Channel.create
Raw url /company/{companyId}/webchat/channel
Allowed methods POST
Description Allowed body fields
  • pbx_omnigroup_id


Name company_id.webchat.Channel.read
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods GET
Description Allowed body fields


Name company_id.webchat.Channel.update
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods POST
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]
  • [default_brand]
  • [deleted]


Name company_id.webchat.Channel.deleteChannel
Raw url /company/{companyId}/webchat/channel/{channelId}
Allowed methods DELETE
Description Allowed body fields


Name company_id.webchat.Channel.deleteChannelInput
Raw url /company/{companyId}/webchat/channel/{channelId}/{inputId}
Allowed methods DELETE
Description Allowed body fields


Name Contact.create
Raw url /contact
Allowed methods POST
Description Allowed body fields
  • name
  • [pbx_user_id]
  • [fields]
  • [origin]


Name Contact.browse
Raw url /contact
Allowed methods GET
Description Allowed body fields


Name Contact.read
Raw url /contact/{contactId}
Allowed methods GET
Description Allowed body fields


Name Contact.update
Raw url /contact/{contactId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_user_id]
  • [fields]
  • [origin]
  • [pbx_contact_favorite]


Name Contact.delete
Raw url /contact/{contactId}
Allowed methods DELETE
Description Allowed body fields


Name contact.Department.create
Raw url /contact/{contactId}/department
Allowed methods POST
Description Allowed body fields
  • department_id


Name contact.Department.delete
Raw url /contact/{contactId}/department/{departmentId}
Allowed methods DELETE
Description Allowed body fields


Name contact.Favorite.create
Raw url /contact/{contactId}/favorite
Allowed methods POST
Description Allowed body fields
  • [pbx_contact_favorite]


Name contact.Favorite.delete
Raw url /contact/{contactId}/favorite
Allowed methods DELETE
Description Allowed body fields


Name contact.Favorite.read
Raw url /contact/{contactId}/favorite
Allowed methods GET
Description Allowed body fields


Name contact.Favorite.update
Raw url /contact/{contactId}/favorite
Allowed methods PATCH
Description Allowed body fields
  • pbx_contact_favorite


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


Name contact.Field.delete
Raw url /contact/{contactId}/field/{fieldId}
Allowed methods DELETE
Description Allowed body fields


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


Name contact.Field.read
Raw url /contact/{contactId}/field/{fieldId}
Allowed methods GET
Description Allowed body fields


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


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


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


Name contactimport.deletejob.deleteJob
Raw url /contactimport/job/{jobId}/delete
Allowed methods GET
Description Allowed body fields


Name contactimport.readjob.readJob
Raw url /contactimport/job/{jobId}/read
Allowed methods GET
Description Allowed body fields


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


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


Name contactimport.browserows.browseRows
Raw url /contactimport/job/{jobId}/rows/browse
Allowed methods GET
Description Allowed body fields


Name contactimport.updatejob.updateJob
Raw url /contactimport/job/{jobId}/update
Allowed methods POST
Description Allowed body fields
  • locked


Name contactimport.browsejobs.browseJobs
Raw url /contactimport/jobs/browse
Allowed methods GET
Description Allowed body fields


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


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


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


Name contactimport_id.deletejob.deleteJob
Raw url /contactimport/{userId}/job/{jobId}/delete
Allowed methods GET
Description Allowed body fields


Name contactimport_id.readjob.readJob
Raw url /contactimport/{userId}/job/{jobId}/read
Allowed methods GET
Description Allowed body fields


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


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


Name contactimport_id.browserows.browseRows
Raw url /contactimport/{userId}/job/{jobId}/rows/browse
Allowed methods GET
Description Allowed body fields


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


Name contactimport_id.browsejobs.browseJobs
Raw url /contactimport/{userId}/jobs/browse
Allowed methods GET
Description Allowed body fields


Name Country.browse
Raw url /country
Allowed methods GET
Description Allowed body fields


Name Country.read
Raw url /country/{countryId}
Allowed methods GET
Description Allowed body fields


Name Documentation.index
Raw url /documentation
Allowed methods GET
Description Allowed body fields


Name Documentation.indexAuthentication
Raw url /documentation/authentication
Allowed methods GET
Description Allowed body fields


Name Documentation.docplain
Raw url /documentation/doc-plain
Allowed methods GET
Description Allowed body fields


Name Documentation.indexEvents
Raw url /documentation/events
Allowed methods GET
Description Allowed body fields


Name Documentation.indexHowTo
Raw url /documentation/howto
Allowed methods GET
Description Allowed body fields


Name Documentation.swagger
Raw url /documentation/swagger.json
Allowed methods GET
Description Allowed body fields


Name Documentation.indexUsecase
Raw url /documentation/usecases
Allowed methods GET
Description Allowed body fields


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


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


Name mailbox.voicemail.browse
Raw url /mailbox/{mailboxId}/voicemail
Allowed methods GET
Description Allowed body fields


Name mailbox.voicemail.retin
Raw url /mailbox/{mailboxId}/voicemail
Allowed methods DELETE
Description Allowed body fields


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


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


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


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


Name OAuth2.deleteAccessToken
Raw url /oauth2/access-token
Allowed methods DELETE
Description Allowed body fields


Name OAuth2.refreshToken
Raw url /oauth2/refresh-token
Allowed methods POST
Description Allowed body fields
  • grant_type
  • client_id
  • [client_secret]
  • [refresh_token]


Name OAuth2.userCredentials
Raw url /oauth2/user-credentials
Allowed methods POST
Description Allowed body fields
  • grant_type
  • client_id
  • [client_secret]
  • username
  • password
  • [tfa]


Name operatorContact.addNote
Raw url /operator/contact/{contactId}/note
Allowed methods POST
Description Allowed body fields
  • note


Name operatorContact.getNote
Raw url /operator/contact/{contactId}/note
Allowed methods GET
Description Allowed body fields


Name operatorUser.addNote
Raw url /operator/user/{userId}/note
Allowed methods POST
Description Allowed body fields
  • note


Name operatorUser.getNote
Raw url /operator/user/{userId}/note
Allowed methods GET
Description Allowed body fields


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


Name Profile.create
Raw url /profile
Allowed methods POST
Description Allowed body fields
  • name
  • priority
  • [pbx_user_id]
  • [pbx_color_id]
  • [profile_number]
  • [pbx_icon_id]
  • [default_callerid_pbx_did_id]


Name Profile.delete
Raw url /profile/{profileId}
Allowed methods DELETE
Description Allowed body fields


Name Profile.update
Raw url /profile/{profileId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [priority]
  • [profile_number]
  • [pbx_user_id]
  • [default_callerid_pbx_did_id]
  • [pbx_color_id]
  • [pbx_icon_id]


Name Profile.read
Raw url /profile/{profileId}
Allowed methods GET
Description Allowed body fields


Name profile.Calendar.create
Raw url /profile/{profileId}/calendar
Allowed methods POST
Description Allowed body fields
  • name
  • origin


Name profile.CallRouting.create
Raw url /profile/{profileId}/callrouting
Allowed methods POST
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.CallRouting.browse
Raw url /profile/{profileId}/callrouting
Allowed methods GET
Description Allowed body fields


Name profile.CallRouting.read
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods GET
Description Allowed body fields


Name profile.CallRouting.update
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods PATCH
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.CallRouting.delete
Raw url /profile/{profileId}/callrouting/{callRoutingId}
Allowed methods DELETE
Description Allowed body fields


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


Name profile.callrouting.Item.browse
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item
Allowed methods GET
Description Allowed body fields


Name profile.callrouting.Item.read
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item/{callRoutingItemId}
Allowed methods GET
Description Allowed body fields


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


Name profile.callrouting.Item.delete
Raw url /profile/{profileId}/callrouting/{callRoutingId}/item/{callRoutingItemId}
Allowed methods DELETE
Description Allowed body fields


Name profile.Cid.create
Raw url /profile/{profileId}/cid
Allowed methods POST
Description Allowed body fields
  • pbx_account_id
  • callerid_pbx_did_id


Name profile.Cid.browse
Raw url /profile/{profileId}/cid
Allowed methods GET
Description Allowed body fields


Name profile.Cid.delete
Raw url /profile/{profileId}/cid/{cidId}
Allowed methods DELETE
Description Allowed body fields


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


Name profile.Cid.read
Raw url /profile/{profileId}/cid/{cidId}
Allowed methods GET
Description Allowed body fields


Name profile.Queue.create
Raw url /profile/{profileId}/queue
Allowed methods POST
Description Allowed body fields
  • ast_queue_id


Name profile.Queue.browse
Raw url /profile/{profileId}/queue
Allowed methods GET
Description Allowed body fields


Name profile.Queue.delete
Raw url /profile/{profileId}/queue/{queueId}
Allowed methods DELETE
Description Allowed body fields


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


Name profile.Queue.read
Raw url /profile/{profileId}/queue/{queueId}
Allowed methods GET
Description Allowed body fields


Name profile.queue.Account.create
Raw url /profile/{profileId}/queue/{queueId}/account
Allowed methods POST
Description Allowed body fields
  • pbx_account_id


Name profile.queue.Account.browse
Raw url /profile/{profileId}/queue/{queueId}/account
Allowed methods GET
Description Allowed body fields


Name profile.queue.Account.delete
Raw url /profile/{profileId}/queue/{queueId}/account/{pbx_profile_queues_accounts_id}
Allowed methods DELETE
Description Allowed body fields


Name profile.queue.Account.read
Raw url /profile/{profileId}/queue/{queueId}/account/{pbx_profile_queues_accounts_id}
Allowed methods GET
Description Allowed body fields


Name profile.TriggerWords.create
Raw url /profile/{profileId}/trigger_word
Allowed methods POST
Description Allowed body fields
  • word


Name profile.TriggerWords.browse
Raw url /profile/{profileId}/trigger_word
Allowed methods GET
Description Allowed body fields


Name profile.TriggerWords.delete
Raw url /profile/{profileId}/trigger_word/{wordId}
Allowed methods DELETE
Description Allowed body fields


Name queue.Cdr.search
Raw url /queue/cdr
Allowed methods GET
Description Allowed body fields


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


Name queue.cdr.Handled.read
Raw url /queue/cdr/handled/{cdrQueueId}
Allowed methods GET
Description Allowed body fields


Name queue.cdr.Member.search
Raw url /queue/cdr/member
Allowed methods GET
Description Allowed body fields


Name queue.cdr.Stats.read
Raw url /queue/cdr/stats
Allowed methods GET
Description Allowed body fields


Name Queue.read
Raw url /queue/{queueId}
Allowed methods GET
Description Allowed body fields


Name queue.Caller.browse
Raw url /queue/{queueId}/caller
Allowed methods GET
Description Allowed body fields


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


Name queue.Cdr.browse
Raw url /queue/{queueId}/cdr
Allowed methods GET
Description Allowed body fields


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


Name queue.Member.browse
Raw url /queue/{queueId}/member
Allowed methods GET
Description Allowed body fields


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


Name queue.Member.delete
Raw url /queue/{queueId}/member/{queueMemberId}
Allowed methods DELETE
Description Allowed body fields


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


Name queue.Member.read
Raw url /queue/{queueId}/member/{queueMemberId}
Allowed methods GET
Description Allowed body fields


Name recording.Live.unmuteRecording
Raw url /recording/live/{recordingId}/mute
Allowed methods DELETE
Description Allowed body fields


Name recording.Live.muteRecording
Raw url /recording/live/{recordingId}/mute
Allowed methods POST
Description Allowed body fields


Name recording.Live.stopRecording
Raw url /recording/live/{recordingId}/stop
Allowed methods POST
Description Allowed body fields


Name recording.Stored.deleteStoredRecording
Raw url /recording/stored/{recordingId}{/audioType}
Allowed methods DELETE
Description Allowed body fields


Name recording.Stored.getStoredRecording
Raw url /recording/stored/{recordingId}{/audioType}
Allowed methods GET
Description Allowed body fields


Name Recording.read
Raw url /recording/{recordingId}
Allowed methods GET
Description Allowed body fields


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


Name Schedule.deleteWithScheduleIdOnly
Raw url /schedule/{scheduleId}
Allowed methods DELETE
Description Allowed body fields


Name Schedule.readWithScheduleIdOnly
Raw url /schedule/{scheduleId}
Allowed methods GET
Description Allowed body fields


Name Schedule.deleteAtTimestampWithScheduleIdOnly
Raw url /schedule/{scheduleId}/at-timestamp
Allowed methods DELETE
Description Allowed body fields


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


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


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


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


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


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


Name simple.Company.reload
Raw url /simple/company/apply
Allowed methods POST
Description Allowed body fields


Name simple.Company.extensions
Raw url /simple/company/extensions
Allowed methods GET
Description Allowed body fields


Name simple.Company.history
Raw url /simple/company/history
Allowed methods GET
Description Allowed body fields


Name simple.Company.numbers
Raw url /simple/company/numbers
Allowed methods GET
Description Allowed body fields


Name simple.Company.queueHistory
Raw url /simple/company/queuecdr
Allowed methods GET
Description Allowed body fields


Name simple.CustomerData.read
Raw url /simple/customerdata
Allowed methods GET
Description Allowed body fields


Name simple.CustomerData.update
Raw url /simple/customerdata
Allowed methods PATCH
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.KeyValue.create
Raw url /simple/customerdata/keyvalue
Allowed methods POST
Description Allowed body fields
  • key
  • value


Name simple.customerdata.KeyValue.delete
Raw url /simple/customerdata/keyvalue/{keyValueId}
Allowed methods DELETE
Description Allowed body fields


Name simple.customerdata.KeyValue.update
Raw url /simple/customerdata/keyvalue/{keyValueId}
Allowed methods PATCH
Description Allowed body fields
  • key
  • value


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


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


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


Name simple.customerdata.user.KeyValue.delete
Raw url /simple/customerdata/user/{id}/keyvalue/{keyValueId}
Allowed methods DELETE
Description Allowed body fields


Name simple.Doc.doc
Raw url /simple/doc
Allowed methods GET
Description Allowed body fields


Name simple.Event.list
Raw url /simple/event/list
Allowed methods GET
Description Allowed body fields


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


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


Name simple.Extension.addCallerid
Raw url /simple/extension/{extension}/addcallerid/{number}
Allowed methods POST
Description Allowed body fields


Name simple.Extension.addVirtNumber
Raw url /simple/extension/{extension}/addvirt/{number}
Allowed methods POST
Description Allowed body fields


Name simple.Extension.create
Raw url /simple/extension/{extension}/create
Allowed methods POST
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.Extension.delete
Raw url /simple/extension/{extension}/delete
Allowed methods DELETE
Description Allowed body fields


Name simple.Extension.history
Raw url /simple/extension/{extension}/history
Allowed methods GET
Description Allowed body fields


Name simple.Extension.status
Raw url /simple/extension/{extension}/status
Allowed methods GET
Description Allowed body fields


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


Name sound.browse
Raw url /sound
Allowed methods GET
Description Allowed body fields


Name sound.create
Raw url /sound
Allowed methods POST
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]


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


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


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


Name sound.downloadFile
Raw url /sound/{soundId}/file/{audioType}
Allowed methods GET
Description Allowed body fields


Name sound.tts.browse
Raw url /sound/{soundId}/tts
Allowed methods GET
Description Allowed body fields


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


Name StandardCallMethod.update
Raw url /standardcallmethod
Allowed methods PATCH
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name StandardCallMethod.read
Raw url /standardcallmethod
Allowed methods GET
Description Allowed body fields


Name Documentation.swaggerIndex
Raw url /swagger
Allowed methods GET
Description Allowed body fields


Name TimeZone.browse
Raw url /timezone
Allowed methods GET
Description Allowed body fields


Name TimeZone.read
Raw url /timezone/{timezoneId}
Allowed methods GET
Description Allowed body fields


Name unread.read
Raw url /unread
Allowed methods GET
Description Allowed body fields


Name unread.setRead
Raw url /unread/{unreadType}/{which}
Allowed methods POST
Description Allowed body fields


Name User.read
Raw url /user
Allowed methods GET
Description Allowed body fields


Name User.update
Raw url /user
Allowed methods PATCH
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.Account.browse
Raw url /user/accounts
Allowed methods GET
Description Allowed body fields


Name user.acl.company.NSpace.browse
Raw url /user/acl/company/{companyId}/namespace
Allowed methods GET
Description Allowed body fields


Name user.acl.Group.browse
Raw url /user/acl/group
Allowed methods GET
Description Allowed body fields


Name user.acl.Group.create
Raw url /user/acl/group/{groupId}
Allowed methods POST
Description Allowed body fields


Name user.acl.Group.delete
Raw url /user/acl/group/{groupId}
Allowed methods DELETE
Description Allowed body fields


Name user.acl.Permission.browse
Raw url /user/acl/permission{/companyId}
Allowed methods GET
Description Allowed body fields


Name user.AppSetting.store
Raw url /user/appsetting
Allowed methods POST
Description Allowed body fields
  • [setting]


Name user.AppSetting.read
Raw url /user/appsetting
Allowed methods GET
Description Allowed body fields


Name user.AppSetting.storePath
Raw url /user/appsetting/{jsonPath}
Allowed methods POST
Description Allowed body fields
  • [json]


Name user.AppSetting.readPath
Raw url /user/appsetting/{jsonPath}
Allowed methods GET
Description Allowed body fields


Name user.Avatar.create
Raw url /user/avatar
Allowed methods POST
Description

Upload

Upload "unlimited" files (you can use whatever name you like). Must be encoded in multipart/form-data.


Name user.Avatar.browse
Raw url /user/avatar
Allowed methods GET
Description Allowed body fields


Name user.Avatar.downloadActive
Raw url /user/avatar/image{/type}
Allowed methods GET
Description Allowed body fields


Name user.Avatar.read
Raw url /user/avatar/{avatarId}
Allowed methods GET
Description Allowed body fields


Name user.Avatar.update
Raw url /user/avatar/{avatarId}
Allowed methods PATCH
Description Allowed body fields
  • active


Name user.Avatar.delete
Raw url /user/avatar/{avatarId}
Allowed methods DELETE
Description Allowed body fields


Name user.Avatar.download
Raw url /user/avatar/{avatarId}/image{/type}
Allowed methods GET
Description Allowed body fields


Name user.Bridge.browse
Raw url /user/bridges
Allowed methods GET
Description Allowed body fields


Name user.CallHistory.retin
Raw url /user/call/history
Allowed methods DELETE
Description Allowed body fields


Name user.CallHistory.browse
Raw url /user/call/history
Allowed methods GET
Description Allowed body fields


Name user.Call.extendedInfo
Raw url /user/call/{number}
Allowed methods GET
Description Allowed body fields


Name user.Call.browse
Raw url /user/calls
Allowed methods GET
Description Allowed body fields


Name user.CallThrough.create
Raw url /user/callthrough
Allowed methods POST
Description Allowed body fields
  • [exten]


Name user.Call.callTravel
Raw url /user/calltravel/{callGuid}
Allowed methods GET
Description Allowed body fields


Name user.ChatRoom.read
Raw url /user/chat/room/with/{userId2}
Allowed methods GET
Description Allowed body fields


Name user.ChatRoom.browse
Raw url /user/chat/rooms
Allowed methods GET
Description Allowed body fields


Name user.Cid.browse
Raw url /user/cid
Allowed methods GET
Description Allowed body fields


Name user.Cid.read
Raw url /user/cid/{cidId}
Allowed methods GET
Description Allowed body fields


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


Name user.CommonContacts.browse
Raw url /user/commoncontacts
Allowed methods GET
Description Allowed body fields


Name user.CommonContacts.delete
Raw url /user/commoncontacts/{contactId}
Allowed methods DELETE
Description Allowed body fields


Name user.CommonContacts.read
Raw url /user/commoncontacts/{contactId}
Allowed methods GET
Description Allowed body fields


Name user.CommonContacts.update
Raw url /user/commoncontacts/{contactId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_user_id]
  • [fields]
  • [origin]


Name user.CommonContact.Field.create
Raw url /user/commoncontacts/{contactId}/field
Allowed methods POST
Description Allowed body fields
  • field
  • type
  • [label]


Name user.CommonContact.Field.delete
Raw url /user/commoncontacts/{contactId}/field/{fieldId}
Allowed methods DELETE
Description Allowed body fields


Name user.CommonContact.Field.update
Raw url /user/commoncontacts/{contactId}/field/{fieldId}
Allowed methods PATCH
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user.CommonContact.Field.read
Raw url /user/commoncontacts/{contactId}/field/{fieldId}
Allowed methods GET
Description Allowed body fields


Name user.Provisioning.goodbye
Raw url /user/communicator/goodbye
Allowed methods POST
Description Allowed body fields


Name user.Provisioning.hello
Raw url /user/communicator/hello
Allowed methods POST
Description Allowed body fields


Name user.Contacts.browse
Raw url /user/contacts
Allowed methods GET
Description Allowed body fields


Name user.Contacts.export
Raw url /user/contacts/export
Allowed methods GET
Description Allowed body fields


Name user.Contacts.browseFavorite
Raw url /user/contacts/favorites
Allowed methods GET
Description Allowed body fields


Name user.Crm.browse
Raw url /user/crm
Allowed methods GET
Description Allowed body fields


Name user.Crm.create
Raw url /user/crm
Allowed methods POST
Description Allowed body fields
  • [crm_type]
  • [active]
  • [settings]
  • [accounts]
  • [triggers]


Name user.Crm.readActive
Raw url /user/crm/active
Allowed methods GET
Description Allowed body fields


Name user.Crm.HubspotCallback.authCallback
Raw url /user/crm/hubspot/authcallback
Allowed methods GET
Description Allowed body fields


Name user.Crm.delete
Raw url /user/crm/{crmEntryId}
Allowed methods DELETE
Description Allowed body fields


Name user.Crm.update
Raw url /user/crm/{crmEntryId}
Allowed methods POST
Description Allowed body fields
  • [active]
  • [settings]
  • [triggers]


Name user.Crm.read
Raw url /user/crm/{crmEntryId}
Allowed methods GET
Description Allowed body fields


Name user.Crm.AccountLink.browse
Raw url /user/crm/{crmEntryId}/accountlink
Allowed methods GET
Description Allowed body fields


Name user.Crm.AccountLink.create
Raw url /user/crm/{crmEntryId}/accountlink
Allowed methods POST
Description Allowed body fields


Name user.Crm.AccountLink.delete
Raw url /user/crm/{crmEntryId}/accountlink/{accountId}
Allowed methods DELETE
Description Allowed body fields


Name user.Crm.readCaller
Raw url /user/crm/{crmEntryId}/caller
Allowed methods GET
Description Allowed body fields


Name user.Crm.Hubspot.url
Raw url /user/crm/{crmEntryId}/hubspot/url
Allowed methods GET
Description Allowed body fields


Name user.Crm.Salesforce.checkAuth
Raw url /user/crm/{crmEntryId}/salesforce/checkauth
Allowed methods POST
Description Allowed body fields
  • device_code


Name user.Crm.Salesforce.code
Raw url /user/crm/{crmEntryId}/salesforce/code
Allowed methods GET
Description Allowed body fields


Name user.Destination.browse
Raw url /user/destination
Allowed methods GET
Description Allowed body fields


Name user.Destination.read
Raw url /user/destination/{destinationId}
Allowed methods GET
Description Allowed body fields


Name user.Did.browse
Raw url /user/did
Allowed methods GET
Description Allowed body fields


Name user.Did.read
Raw url /user/did/{didId}
Allowed methods GET
Description Allowed body fields


Name user.Field.create
Raw url /user/field
Allowed methods POST
Description Allowed body fields
  • field
  • type
  • [label]


Name user.Field.update
Raw url /user/field/{fieldId}
Allowed methods PATCH
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user.Field.read
Raw url /user/field/{fieldId}
Allowed methods GET
Description Allowed body fields


Name user.Field.delete
Raw url /user/field/{fieldId}
Allowed methods DELETE
Description Allowed body fields


Name user.Is.busy
Raw url /user/is/{userIs}/{userIsWhat}/busy
Allowed methods GET
Description Allowed body fields


Name User.isPassword
Raw url /user/ispassword
Allowed methods POST
Description Allowed body fields
  • password


Name user.Log.create
Raw url /user/log
Allowed methods POST
Description Allowed body fields
  • text
  • [data]


Name user.Log.createStats
Raw url /user/log/stats
Allowed methods POST
Description Allowed body fields
  • text
  • [data]


Name user.Logger.browse
Raw url /user/logger
Allowed methods GET
Description Allowed body fields


Name user.Mailbox.browse
Raw url /user/mailbox
Allowed methods GET
Description Allowed body fields


Name user.Mobile.browse
Raw url /user/mobile
Allowed methods GET
Description Allowed body fields


Name user.Mobile.topup
Raw url /user/mobile/{simno}/topup/{topup}
Allowed methods GET
Description Allowed body fields


Name user.Mobile.topupHistory
Raw url /user/mobile/{simno}/topuphistory
Allowed methods GET
Description Allowed body fields


Name user.acl.oauth.access-token.browse
Raw url /user/oauth/access-token
Allowed methods GET
Description Allowed body fields


Name user.Omnigroup.browse
Raw url /user/omnigroup/
Allowed methods GET
Description Allowed body fields


Name user.Omnigroup.read
Raw url /user/omnigroup/{id}
Allowed methods GET
Description Allowed body fields


Name user.PbxFlow.browse
Raw url /user/pbxflow
Allowed methods GET
Description Allowed body fields


Name user.PbxFlow.read
Raw url /user/pbxflow/{id}
Allowed methods GET
Description Allowed body fields


Name user.pbxflow.Item.update
Raw url /user/pbxflow/{id}/item/{itemId}
Allowed methods PATCH
Description Allowed body fields
  • value
  • [type]


Name user.Call.pickup
Raw url /user/pickup/{pickupUserId}
Allowed methods POST
Description Allowed body fields


Name user.Profile.active
Raw url /user/profile
Allowed methods GET
Description Allowed body fields


Name user.Profile.copyProfiles
Raw url /user/profile/copyprofiles
Allowed methods POST
Description Allowed body fields
  • pbx_user_id
  • profileids
  • userids
  • [deletesamename]
  • [switch_default_pbx_profile_id]


Name user.pbx.Ivr.create
Raw url /user/profile/ivr
Allowed methods POST
Description Allowed body fields
  • name
  • description
  • timeout_pbx_destination_id
  • invalid_pbx_destination_id
  • pbx_soundfile_id
  • timeout
  • invalid_loops


Name user.pbx.Ivr.browse
Raw url /user/profile/ivr
Allowed methods GET
Description Allowed body fields


Name user.pbx.Ivr.read
Raw url /user/profile/ivr/{id}
Allowed methods GET
Description Allowed body fields


Name user.pbx.Ivr.update
Raw url /user/profile/ivr/{id}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [description]
  • [timeout_pbx_destination_id]
  • [invalid_pbx_destination_id]
  • [pbx_soundfile_id]
  • [timeout]
  • [invalid_loops]


Name user.pbx.Ivr.delete
Raw url /user/profile/ivr/{id}
Allowed methods DELETE
Description Allowed body fields


Name user.pbx.IvrItem.create
Raw url /user/profile/ivr/{id}/item
Allowed methods POST
Description Allowed body fields
  • selection
  • pbx_destination_id
  • [description]


Name user.pbx.IvrItem.delete
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods DELETE
Description Allowed body fields


Name user.pbx.IvrItem.read
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods GET
Description Allowed body fields


Name user.pbx.IvrItem.update
Raw url /user/profile/ivr/{id}/item/{itemId}
Allowed methods PATCH
Description Allowed body fields
  • [selection]
  • [pbx_destination_id]
  • [description]


Name user.profile.Schedule.Browse
Raw url /user/profile/schedule
Allowed methods GET
Description Allowed body fields


Name user.profile.Schedule.nextScheduled
Raw url /user/profile/schedule/next
Allowed methods GET
Description Allowed body fields


Name user.profile.Schedule.nextScheduledCompany
Raw url /user/profile/schedule/next/company
Allowed methods GET
Description Allowed body fields


Name user.profile.Soundfile.create
Raw url /user/profile/soundfile
Allowed methods POST
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]


Name user.profile.Soundfile.browse
Raw url /user/profile/soundfile
Allowed methods GET
Description Allowed body fields


Name user.profile.soundfile.Tts.language
Raw url /user/profile/soundfile/tts/language
Allowed methods GET
Description Allowed body fields


Name user.profile.Soundfile.update
Raw url /user/profile/soundfile/{soundId}
Allowed methods POST
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]


Name user.profile.Soundfile.read
Raw url /user/profile/soundfile/{soundId}
Allowed methods GET
Description Allowed body fields


Name user.profile.Soundfile.delete
Raw url /user/profile/soundfile/{soundId}
Allowed methods DELETE
Description Allowed body fields


Name user.profile.Soundfile.inuse
Raw url /user/profile/soundfile/{soundId}/inuse
Allowed methods GET
Description Allowed body fields


Name user.profile.Soundfile.downloadMp3
Raw url /user/profile/soundfile/{soundId}/mp3
Allowed methods GET
Description Allowed body fields


Name user.profile.soundfile.Tts.browse
Raw url /user/profile/soundfile/{soundId}/tts
Allowed methods GET
Description Allowed body fields


Name user.profile.soundfile.Tts.read
Raw url /user/profile/soundfile/{soundId}/tts/{ttsId}
Allowed methods GET
Description Allowed body fields


Name user.profile.Soundfile.downloadWav
Raw url /user/profile/soundfile/{soundId}/wav
Allowed methods GET
Description Allowed body fields


Name user.Profile.activate
Raw url /user/profile/{profileId}
Allowed methods POST
Description Allowed body fields


Name user.Profile.icon
Raw url /user/profile/{profileId}/icon
Allowed methods GET
Description Allowed body fields


Name user.Profile.downloadIconAs
Raw url /user/profile/{profileId}/icon/{iconType}
Allowed methods GET
Description Allowed body fields


Name user.Profile.activateType
Raw url /user/profile/{profileId}/{setProfileType}
Allowed methods POST
Description Allowed body fields


Name user.Profile.s
Raw url /user/profiles
Allowed methods GET
Description Allowed body fields


Name user.Provisioning.getProvisioning
Raw url /user/provisioning
Allowed methods GET
Description Allowed body fields


Name user.PushToken.create
Raw url /user/pushtoken
Allowed methods POST
Description Allowed body fields
  • token
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user.PushToken.browse
Raw url /user/pushtoken
Allowed methods GET
Description Allowed body fields


Name user.PushToken.delete
Raw url /user/pushtoken/{tokenId}
Allowed methods DELETE
Description Allowed body fields


Name user.PushToken.update
Raw url /user/pushtoken/{tokenId}
Allowed methods PATCH
Description Allowed body fields
  • [token]
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user.QueueMembers.browse
Raw url /user/queue/members
Allowed methods GET
Description Allowed body fields


Name user.QueueStats.browse
Raw url /user/queue/stats
Allowed methods GET
Description Allowed body fields


Name user.QueueMember.create
Raw url /user/queue/{queueId}/member
Allowed methods POST
Description Allowed body fields


Name user.QueueMember.update
Raw url /user/queue/{queueId}/member/{queueMemberId}
Allowed methods PATCH
Description Allowed body fields


Name user.QueueMember.delete
Raw url /user/queue/{queueId}/member/{queueMemberId}
Allowed methods DELETE
Description Allowed body fields


Name user.Queue.browse
Raw url /user/queues
Allowed methods GET
Description Allowed body fields


Name user.Queue.browseAll
Raw url /user/queues/all
Allowed methods GET
Description Allowed body fields


Name user.Recording.browse
Raw url /user/recordings
Allowed methods GET
Description Allowed body fields


Name user.Recording.retin
Raw url /user/recordings
Allowed methods DELETE
Description Allowed body fields


Name sms.SMS.create
Raw url /user/sms
Allowed methods POST
Description Allowed body fields
  • numbers
  • sender
  • body


Name sms.SMS.browse
Raw url /user/sms
Allowed methods GET
Description Allowed body fields


Name sms.SMS.read
Raw url /user/sms/{smsId}
Allowed methods GET
Description Allowed body fields


Name user.StandardCallMethod.update
Raw url /user/standardcallmethod
Allowed methods PATCH
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name user.StandardCallMethod.read
Raw url /user/standardcallmethod
Allowed methods GET
Description Allowed body fields


Name user.Template.browse
Raw url /user/template
Allowed methods GET
Description Allowed body fields


Name user.Template.browsePrefix
Raw url /user/template/{templateType}
Allowed methods GET
Description Allowed body fields


Name User.isPasswordBad
Raw url /user/testpassword
Allowed methods POST
Description Allowed body fields
  • password


Name user.TFA.create
Raw url /user/tfa
Allowed methods POST
Description Allowed body fields
  • secret


Name user.TFA.read
Raw url /user/tfa
Allowed methods GET
Description Allowed body fields


Name user.TFA.delete
Raw url /user/tfa/delete
Allowed methods POST
Description Allowed body fields
  • [code]


Name user.TFA.force
Raw url /user/tfa/force
Allowed methods POST
Description Allowed body fields
  • force


Name user.TFA.status
Raw url /user/tfa/status
Allowed methods GET
Description Allowed body fields


Name user.TFA.validate
Raw url /user/tfa/validate
Allowed methods POST
Description Allowed body fields
  • code
  • [secret]


Name user.Wallboard.browse
Raw url /user/wallboard
Allowed methods GET
Description Allowed body fields


Name user.wallboard.queue.Caller.browse
Raw url /user/wallboard/queue/caller/{queueId}
Allowed methods GET
Description Allowed body fields


Name user.wallboard.queue.Cdr.search
Raw url /user/wallboard/queue/cdr
Allowed methods GET
Description Allowed body fields


Name user.wallboard.queue.cdr.Stats.read
Raw url /user/wallboard/queue/cdr/stats
Allowed methods GET
Description Allowed body fields


Name user.wallboard.queue.Cdr.browse
Raw url /user/wallboard/queue/{queueId}/cdr
Allowed methods GET
Description Allowed body fields


Name user.Wallboard.stats
Raw url /user/wallboard/stats
Allowed methods GET
Description Allowed body fields


Name user.wallboard.Token.read
Raw url /user/wallboard/token
Allowed methods GET
Description Allowed body fields


Name user.Wallboard.read
Raw url /user/wallboard/{id}
Allowed methods GET
Description Allowed body fields


Name user.WallboardOutgoing.read
Raw url /user/wallboardoutgoing/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name user.webchat.Channel.browse
Raw url /user/webchat/channel
Allowed methods GET
Description Allowed body fields


Name user.webchat.Channel.create
Raw url /user/webchat/channel
Allowed methods POST
Description Allowed body fields


Name user.webchat.Channel.read
Raw url /user/webchat/channel/{channelId}
Allowed methods GET
Description Allowed body fields


Name user.webchat.History.browse
Raw url /user/webchat/history
Allowed methods GET
Description Allowed body fields


Name user.webchat.Message.read
Raw url /user/webchat/message/{messageId}
Allowed methods GET
Description Allowed body fields


Name user.webchat.Message.delete
Raw url /user/webchat/message/{messageId}
Allowed methods DELETE
Description Allowed body fields


Name user.webchat.Message.update
Raw url /user/webchat/message/{messageId}
Allowed methods POST
Description Allowed body fields
  • text_msg


Name user.webchat.Message.setstatus
Raw url /user/webchat/message/{messageId}/status/{status}
Allowed methods POST
Description Allowed body fields


Name user.webchat.Session.read
Raw url /user/webchat/session/{sessionId}
Allowed methods GET
Description Allowed body fields


Name user.webchat.Session.reserve
Raw url /user/webchat/session/{sessionId}/action/reserve
Allowed methods POST
Description Allowed body fields


Name user.webchat.Session.terminate
Raw url /user/webchat/session/{sessionId}/action/terminate
Allowed methods POST
Description Allowed body fields


Name user.webchat.Session.unreserve
Raw url /user/webchat/session/{sessionId}/action/unreserve
Allowed methods POST
Description Allowed body fields


Name user.webchat.Session.browsehistory
Raw url /user/webchat/session/{sessionId}/history
Allowed methods GET
Description Allowed body fields


Name user.webchat.Session.createmessage
Raw url /user/webchat/session/{sessionId}/message
Allowed methods POST
Description Allowed body fields
  • text_msg


Name user.webchat.Session.browsemessages
Raw url /user/webchat/session/{sessionId}/message
Allowed methods GET
Description Allowed body fields


Name user.webchat.Session.setstatus
Raw url /user/webchat/session/{sessionId}/status/{status}
Allowed methods POST
Description Allowed body fields


Name User_id.update
Raw url /user/{userId}
Allowed methods PATCH
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.read
Raw url /user/{userId}
Allowed methods GET
Description Allowed body fields


Name user_id.Account.browse
Raw url /user/{userId}/accounts
Allowed methods GET
Description Allowed body fields


Name user_id.acl.company.NSpace.browse
Raw url /user/{userId}/acl/company/{companyId}/namespace
Allowed methods GET
Description Allowed body fields


Name user_id.acl.Group.browse
Raw url /user/{userId}/acl/group
Allowed methods GET
Description Allowed body fields


Name user_id.acl.Group.create
Raw url /user/{userId}/acl/group/{groupId}
Allowed methods POST
Description Allowed body fields


Name user_id.acl.Group.delete
Raw url /user/{userId}/acl/group/{groupId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.acl.Permission.browse
Raw url /user/{userId}/acl/permission{/companyId}
Allowed methods GET
Description Allowed body fields


Name user_id.Avatar.create
Raw url /user/{userId}/avatar
Allowed methods POST
Description Allowed body fields


Name user_id.Avatar.browse
Raw url /user/{userId}/avatar
Allowed methods GET
Description Allowed body fields


Name user_id.Avatar.downloadActive
Raw url /user/{userId}/avatar/image{/type}
Allowed methods GET
Description Allowed body fields


Name user_id.Avatar.update
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods PATCH
Description Allowed body fields
  • active


Name user_id.Avatar.delete
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.Avatar.read
Raw url /user/{userId}/avatar/{avatarId}
Allowed methods GET
Description Allowed body fields


Name user_id.Avatar.download
Raw url /user/{userId}/avatar/{avatarId}/image{/type}
Allowed methods GET
Description Allowed body fields


Name user_id.Bridge.browse
Raw url /user/{userId}/bridges
Allowed methods GET
Description Allowed body fields


Name user_id.CallHistory.browse
Raw url /user/{userId}/call/history
Allowed methods GET
Description Allowed body fields


Name user_id.CallHistory.retin
Raw url /user/{userId}/call/history
Allowed methods DELETE
Description Allowed body fields


Name user_id.Call.extendedInfo
Raw url /user/{userId}/call/{number}
Allowed methods GET
Description Allowed body fields


Name user.callback.Attempt.browse
Raw url /user/{userId}/callback/attempt
Allowed methods GET
Description Allowed body fields


Name user_id.Call.browse
Raw url /user/{userId}/calls
Allowed methods GET
Description Allowed body fields


Name user_id.Call.callTravel
Raw url /user/{userId}/calltravel/{callGuid}
Allowed methods GET
Description Allowed body fields


Name user_id.ChatRoom.read
Raw url /user/{userId}/chat/room/with/{userId2}
Allowed methods GET
Description Allowed body fields


Name user_id.ChatRoom.browse
Raw url /user/{userId}/chat/rooms
Allowed methods GET
Description Allowed body fields


Name user_id.Cid.browse
Raw url /user/{userId}/cid
Allowed methods GET
Description Allowed body fields


Name user_id.Cid.read
Raw url /user/{userId}/cid/{cidId}
Allowed methods GET
Description Allowed body fields


Name user_id.Cid.force
Raw url /user/{userId}/cid/{cidId}/force
Allowed methods POST
Description Allowed body fields


Name user_id.CommonContacts.browse
Raw url /user/{userId}/commoncontacts
Allowed methods GET
Description Allowed body fields


Name user_id.CommonContacts.delete
Raw url /user/{userId}/commoncontacts/{contactId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.CommonContacts.update
Raw url /user/{userId}/commoncontacts/{contactId}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [pbx_user_id]
  • [fields]
  • [origin]


Name user_id.CommonContacts.read
Raw url /user/{userId}/commoncontacts/{contactId}
Allowed methods GET
Description Allowed body fields


Name user_id.commoncontact.Field.create
Raw url /user/{userId}/commoncontacts/{contactId}/field
Allowed methods POST
Description Allowed body fields
  • field
  • type
  • [label]


Name user_id.commoncontact.Field.update
Raw url /user/{userId}/commoncontacts/{contactId}/field/{fieldId}
Allowed methods PATCH
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user_id.commoncontact.Field.read
Raw url /user/{userId}/commoncontacts/{contactId}/field/{fieldId}
Allowed methods GET
Description Allowed body fields


Name user_id.commoncontact.Field.delete
Raw url /user/{userId}/commoncontacts/{contactId}/field/{fieldId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.Provisioning.goodbye
Raw url /user/{userId}/communicator/goodbye
Allowed methods POST
Description Allowed body fields


Name user_id.Provisioning.hello
Raw url /user/{userId}/communicator/hello
Allowed methods POST
Description Allowed body fields


Name user.Companies.browse
Raw url /user/{userId}/companies
Allowed methods GET
Description Allowed body fields


Name user.Companies.amount
Raw url /user/{userId}/companies/amount
Allowed methods GET
Description Allowed body fields


Name user_id.Contacts.browse
Raw url /user/{userId}/contacts
Allowed methods GET
Description Allowed body fields


Name user_id.Contacts.export
Raw url /user/{userId}/contacts/export
Allowed methods GET
Description Allowed body fields


Name user_id.Contacts.browseFavorite
Raw url /user/{userId}/contacts/favorites
Allowed methods GET
Description Allowed body fields


Name user_id.Destination.browse
Raw url /user/{userId}/destination
Allowed methods GET
Description Allowed body fields


Name user_id.Destination.read
Raw url /user/{userId}/destination/{destinationId}
Allowed methods GET
Description Allowed body fields


Name user_id.Did.browse
Raw url /user/{userId}/did
Allowed methods GET
Description Allowed body fields


Name user_id.Did.read
Raw url /user/{userId}/did/{didId}
Allowed methods GET
Description Allowed body fields


Name user.Favorite.create
Raw url /user/{userId}/favorite
Allowed methods POST
Description Allowed body fields
  • [pbx_user_favorite]


Name user.Favorite.read
Raw url /user/{userId}/favorite
Allowed methods GET
Description Allowed body fields


Name user.Favorite.delete
Raw url /user/{userId}/favorite
Allowed methods DELETE
Description Allowed body fields


Name user.Favorite.update
Raw url /user/{userId}/favorite
Allowed methods PATCH
Description Allowed body fields
  • pbx_user_favorite


Name user_id.Field.create
Raw url /user/{userId}/field
Allowed methods POST
Description Allowed body fields
  • field
  • type
  • [label]


Name user_id.Field.read
Raw url /user/{userId}/field/{fieldId}
Allowed methods GET
Description Allowed body fields


Name user_id.Field.update
Raw url /user/{userId}/field/{fieldId}
Allowed methods PATCH
Description Allowed body fields
  • [field]
  • [type]
  • [label]


Name user_id.Field.delete
Raw url /user/{userId}/field/{fieldId}
Allowed methods DELETE
Description Allowed body fields


Name user.GlobalSearch.browse
Raw url /user/{userId}/globalsearch
Allowed methods GET
Description Allowed body fields


Name User_id.isPassword
Raw url /user/{userId}/ispassword
Allowed methods POST
Description Allowed body fields
  • password


Name user_id.Log.create
Raw url /user/{userId}/log
Allowed methods POST
Description Allowed body fields
  • text
  • [data]


Name user_id.Log.createStats
Raw url /user/{userId}/log/stats
Allowed methods POST
Description Allowed body fields
  • text
  • [data]


Name user_id.Logger.browse
Raw url /user/{userId}/logger
Allowed methods GET
Description Allowed body fields


Name user_id.Mailbox.browse
Raw url /user/{userId}/mailbox
Allowed methods GET
Description Allowed body fields


Name user_id.Mobile.browse
Raw url /user/{userId}/mobile
Allowed methods GET
Description Allowed body fields


Name user_id.Mobile.topup
Raw url /user/{userId}/mobile/{simno}/topup/{topup}
Allowed methods GET
Description Allowed body fields


Name user_id.Mobile.topupHistory
Raw url /user/{userId}/mobile/{simno}/topuphistory
Allowed methods GET
Description Allowed body fields


Name user_id.acl.company.access-token.browse
Raw url /user/{userId}/oauth/access-token
Allowed methods GET
Description Allowed body fields


Name user_id.Omnigroup.browse
Raw url /user/{userId}/omnigroup/
Allowed methods GET
Description Allowed body fields


Name user_id.Omnigroup.read
Raw url /user/{userId}/omnigroup/{id}
Allowed methods GET
Description Allowed body fields


Name user_id.PbxFlow.browse
Raw url /user/{userId}/pbxflow
Allowed methods GET
Description Allowed body fields


Name user_id.PbxFlow.read
Raw url /user/{userId}/pbxflow/{id}
Allowed methods GET
Description Allowed body fields


Name user_id.pbxflow.Item.update
Raw url /user/{userId}/pbxflow/{id}/item/{itemId}
Allowed methods PATCH
Description Allowed body fields
  • value
  • [type]


Name user_id.Call.pickup
Raw url /user/{userId}/pickup/{pickupUserId}
Allowed methods POST
Description Allowed body fields


Name user_id.Profile.active
Raw url /user/{userId}/profile
Allowed methods GET
Description Allowed body fields


Name user_id.Profile.copyProfiles
Raw url /user/{userId}/profile/copyprofiles
Allowed methods POST
Description Allowed body fields
  • pbx_user_id
  • profileids
  • userids
  • [deletesamename]
  • [switch_default_pbx_profile_id]


Name user_id.pbx.Ivr.create
Raw url /user/{userId}/profile/ivr
Allowed methods POST
Description Allowed body fields
  • name
  • description
  • timeout_pbx_destination_id
  • invalid_pbx_destination_id
  • pbx_soundfile_id
  • timeout
  • invalid_loops


Name user_id.pbx.Ivr.browse
Raw url /user/{userId}/profile/ivr
Allowed methods GET
Description Allowed body fields


Name user_id.pbx.Ivr.read
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods GET
Description Allowed body fields


Name user_id.pbx.Ivr.update
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods PATCH
Description Allowed body fields
  • [name]
  • [description]
  • [timeout_pbx_destination_id]
  • [invalid_pbx_destination_id]
  • [pbx_soundfile_id]
  • [timeout]
  • [invalid_loops]


Name user_id.pbx.Ivr.delete
Raw url /user/{userId}/profile/ivr/{id}
Allowed methods DELETE
Description Allowed body fields


Name user_id.pbx.IvrItem.create
Raw url /user/{userId}/profile/ivr/{id}/item
Allowed methods POST
Description Allowed body fields
  • selection
  • pbx_destination_id
  • [description]


Name user_id.pbx.IvrItem.delete
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.pbx.IvrItem.update
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods PATCH
Description Allowed body fields
  • [selection]
  • [pbx_destination_id]
  • [description]


Name user_id.pbx.IvrItem.read
Raw url /user/{userId}/profile/ivr/{id}/item/{itemId}
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Schedule.Browse
Raw url /user/{userId}/profile/schedule
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Schedule.nextScheduled
Raw url /user/{userId}/profile/schedule/next
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Schedule.nextScheduledCompany
Raw url /user/{userId}/profile/schedule/next/company
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.browse
Raw url /user/{userId}/profile/soundfile
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.create
Raw url /user/{userId}/profile/soundfile
Allowed methods POST
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]


Name user_id.profile.soundfile.Tts.language
Raw url /user/{userId}/profile/soundfile/tts/language
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.delete
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.profile.Soundfile.read
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.update
Raw url /user/{userId}/profile/soundfile/{soundId}
Allowed methods POST
Description Allowed body fields
  • [name]
  • [description]
  • [passcode]
  • [sound]
  • [tts]
  • [tts_voice]
  • [tts_rate]
  • [tts_pitch]


Name user_id.profile.Soundfile.inuse
Raw url /user/{userId}/profile/soundfile/{soundId}/inuse
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.downloadMp3
Raw url /user/{userId}/profile/soundfile/{soundId}/mp3
Allowed methods GET
Description Allowed body fields


Name user_id.profile.soundfile.Tts.browse
Raw url /user/{userId}/profile/soundfile/{soundId}/tts
Allowed methods GET
Description Allowed body fields


Name user_id.profile.soundfile.Tts.read
Raw url /user/{userId}/profile/soundfile/{soundId}/tts/{ttsId}
Allowed methods GET
Description Allowed body fields


Name user_id.profile.Soundfile.downloadWav
Raw url /user/{userId}/profile/soundfile/{soundId}/wav
Allowed methods GET
Description Allowed body fields


Name user_id.Profile.activate
Raw url /user/{userId}/profile/{profileId}
Allowed methods POST
Description Allowed body fields


Name user_id.Profile.icon
Raw url /user/{userId}/profile/{profileId}/icon
Allowed methods GET
Description Allowed body fields


Name user_id.Profile.downloadIconAs
Raw url /user/{userId}/profile/{profileId}/icon/{iconType}
Allowed methods GET
Description Allowed body fields


Name user_id.Profile.activateType
Raw url /user/{userId}/profile/{profileId}/{setProfileType}
Allowed methods POST
Description Allowed body fields


Name user_id.Profile.s
Raw url /user/{userId}/profiles
Allowed methods GET
Description Allowed body fields


Name user_id.Provisioning.getProvisioning
Raw url /user/{userId}/provisioning
Allowed methods GET
Description Allowed body fields


Name user_id.PushToken.browse
Raw url /user/{userId}/pushtoken
Allowed methods GET
Description Allowed body fields


Name user_id.PushToken.create
Raw url /user/{userId}/pushtoken
Allowed methods POST
Description Allowed body fields
  • token
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user_id.PushToken.update
Raw url /user/{userId}/pushtoken/{tokenId}
Allowed methods PATCH
Description Allowed body fields
  • [token]
  • [destination]
  • [subscription]
  • [method]
  • [bundle]
  • [project]


Name user_id.PushToken.delete
Raw url /user/{userId}/pushtoken/{tokenId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.QueueMembers.browse
Raw url /user/{userId}/queue/members
Allowed methods GET
Description Allowed body fields


Name user_id.QueueStats.browse
Raw url /user/{userId}/queue/stats
Allowed methods GET
Description Allowed body fields


Name user_id.QueueMember.create
Raw url /user/{userId}/queue/{queueId}/member
Allowed methods POST
Description Allowed body fields


Name user_id.QueueMember.update
Raw url /user/{userId}/queue/{queueId}/member/{queueMemberId}
Allowed methods PATCH
Description Allowed body fields


Name user_id.QueueMember.delete
Raw url /user/{userId}/queue/{queueId}/member/{queueMemberId}
Allowed methods DELETE
Description Allowed body fields


Name user_id.Queue.browse
Raw url /user/{userId}/queues
Allowed methods GET
Description Allowed body fields


Name user_id.Queue.browseAll
Raw url /user/{userId}/queues/all
Allowed methods GET
Description Allowed body fields


Name user_id.Recording.retin
Raw url /user/{userId}/recordings
Allowed methods DELETE
Description Allowed body fields


Name user_id.Recording.browse
Raw url /user/{userId}/recordings
Allowed methods GET
Description Allowed body fields


Name user_id.RingGroupMember.browse
Raw url /user/{userId}/ringgroup/member
Allowed methods GET
Description Allowed body fields


Name user_id.StandardCallMethod.update
Raw url /user/{userId}/standardcallmethod
Allowed methods PATCH
Description Allowed body fields
  • [mobile_account_id]
  • [desktop_account_id]


Name user_id.StandardCallMethod.read
Raw url /user/{userId}/standardcallmethod
Allowed methods GET
Description Allowed body fields


Name user_id.Template.browse
Raw url /user/{userId}/template
Allowed methods GET
Description Allowed body fields


Name user_id.Template.browsePrefix
Raw url /user/{userId}/template/{templateType}
Allowed methods GET
Description Allowed body fields


Name User_id.isPasswordBad
Raw url /user/{userId}/testpassword
Allowed methods POST
Description Allowed body fields
  • password


Name user_id.TFA.create
Raw url /user/{userId}/tfa
Allowed methods POST
Description Allowed body fields
  • secret


Name user_id.TFA.read
Raw url /user/{userId}/tfa
Allowed methods GET
Description Allowed body fields


Name user_id.TFA.delete
Raw url /user/{userId}/tfa/delete
Allowed methods POST
Description Allowed body fields
  • [code]


Name user_id.TFA.force
Raw url /user/{userId}/tfa/force
Allowed methods POST
Description Allowed body fields
  • force


Name user_id.TFA.status
Raw url /user/{userId}/tfa/status
Allowed methods GET
Description Allowed body fields


Name user_id.TFA.validate
Raw url /user/{userId}/tfa/validate
Allowed methods POST
Description Allowed body fields
  • code
  • [secret]


Name user.Users.browse
Raw url /user/{userId}/users
Allowed methods GET
Description Allowed body fields


Name user.Users.amount
Raw url /user/{userId}/users/amount
Allowed methods GET
Description Allowed body fields


Name user_id.Wallboard.browse
Raw url /user/{userId}/wallboard
Allowed methods GET
Description Allowed body fields


Name user_id.Wallboard.stats
Raw url /user/{userId}/wallboard/stats
Allowed methods GET
Description Allowed body fields


Name user_id.Wallboard.read
Raw url /user/{userId}/wallboard/{id}
Allowed methods GET
Description Allowed body fields


Name user_id.WallboardOutgoing.read
Raw url /user/{userId}/wallboardoutgoing/{wallboardId}
Allowed methods GET
Description Allowed body fields


Name Users.browse
Raw url /users
Allowed methods GET
Description Allowed body fields