Jump to Content

Home Documentation API Reference ChangeLog Discussion

v4.0.4

API Reference

v4.0.4

All

Pages

Start typing to search…

CPaaS API

Authentication
- Request a Tokenpost
Accounts
- Create Userpost
- Create Sub-Accountpost
Assets
Billing
- Get Usageget
Call
Campaigns
Carrier
- Get Carrierget
Contacts
DNC
Inbound Routing > RouteTag
Inbound Routing > RouteDest
Inbox
Logs
Numbers
Number Sets
Statistics
Saved Queries
Shortcodes
- Edit Shortcodeput
- Edit Shared Shortcodeput
SMS
- Send SMSpost
- Send OTPpost
SMS Templates
Webhooks
Workflows
Workflow Runner
Timezones
- Get Timezonesget
- Get Timezoneget

CCaaS API

Agent API
- pause_codeget
Non-Agent API
- add_fpg_phoneget

UCaaS API

Presence and Chat
- Show the current configurationget
- Print info about internal status of ytel-chatdget
Call Detail Records > config
- Update the current configuration.patch
Authentication > emails/{email uuid}/confirm
- Confirm an email addressget
- Confirm an email addressput
Authentication > external/{auth type}/config
Authentication > groups > {group uuid} > policies > {policy uuid}
- Dissociate a policy from a groupdel
- Associate a group to a policyput
Authentication > groups > {group uuid} > policies
- Retrieves the list of policies associated to a groupget
Authentication > groups > {group uuid} > users > {user uuid}
- Dissociate a user from a groupdel
- Associate a group to a userput
Authentication > groups > {group uuid} > users
- Retrieves the list of users associated to a groupget
Configuration > groups > {group uuid}
Configuration > groups
- List groupsget
- Create grouppost
Authentication > policies > {policy uuid} > acl/{access}
- Dissociate an access from a policydel
- Associate an access to a policyput
Authentication > policies > {policy uuid}
Authentication > policies
- List ACL policiesget
- Create a new ACL policypost
Authentication > sessions
- List sessionsget
- Delete a sessiondel
Authentication > token > {token}
Authentication > token
- Creates a tokenpost
Authentication > users > password/reset
- Reset the user passwordget
- Set the user passwordpost
Authentication > users > {user uuid or me}/tokens
- Retrieve a user's refresh token listget
- Delete a user's refresh tokendel
Authentication > users > {user uuid} > emails
- Update email addressesput
- Ask a new confirmation emailget
Authentication > users > {user uuid} > external > google
Authentication > users > {user uuid} > external > microsoft
Authentication > users > {user uuid} > external > mobile
Authentication > users > {user uuid} > external
- Retrieves the list of the users external auth dataget
Authentication > users > {user uuid} > policies > {policy uuid}
- Dissociate a policy from a userdel
- Associate a policy to a userput
Authentication > users > {user uuid} > policies
- Retrieves the list of policies associated to a userget
Authentication > users > {user uuid} > sessions
- Retrieves the list of sessions associated to a userget
- Delete a sessiondel
Authentication > users > {user uuid}
Configuration > users
Authentication > users
- Create a userpost
Authentication
Contacts > backends
- List all loaded backendsget
Application > calls > {call id} > hold
- Hold a callput
- Unhold a callput
Application > calls > {call id} > mute
- Mute a callput
- Unmute a callput
Application > calls > {call id} > record
- Start recording a callput
- Stop recording a callput
Application > calls > {call id}
Application > calls
- List callsget
- Make a new callpost
Application > applications/{application uuid} > calls > {call id} > hold
- Place a call on holdput
- Resume a call that has been placed on holdput
Application > applications/{application uuid} > calls > {call id} > moh
- Stops playing a music on holdput
- Starts playing a music on holdput
Application > applications/{application uuid} > calls > {call id} > mute
- Mute a callput
- Unmute a callput
Application > applications/{application uuid} > calls > {call id} > progress
- Play the progress ringing toneput
- Stop playing the progress ringing tone.put
Application > applications/{application uuid} > calls > {call id}
Application > applications/{application uuid} > calls
- List calls from the applicationget
- Make a new call to the applicationpost
Application > applications/{application uuid} > nodes > {node uuid} > calls > {call id}
- Remove call from the nodedel
- Insert call to the nodeput
Application > applications/{application uuid} > nodes > {node uuid} > calls
- Make a new call to the nodepost
- Initiate a call to a user and insert it in the nodepost
Application > applications/{application uuid} > nodes > {node uuid}
- Delete node and hangup all callsdel
- Show a nodeget
Application > applications/{application uuid} > nodes
- List nodes from the applicationget
- Make a new node and add callspost
Application > applications/{application uuid} > snoops > {snoop uuid}
Application > applications/{application uuid} > snoops
- List active snoopsget
Configuration > applications > {application uuid}
Application > applications/{application uuid}
- Stop and remove playbackdel
Application > conferences/{conference id} > participants > {participant id}
Application > conferences/{conference id} > participants
- List participants of a conferenceget
Application > conferences/{conference id} > record
- Stop recording a conferencedel
- Record a conferencepost
Application > switchboards/{switchboard uuid}/calls > held > {call id}
- Put the specified call on hold in the switchboardput
- Answer the specified held callput
Application > switchboards/{switchboard uuid}/calls > held
- List calls held in the switchboardget
Application > switchboards/{switchboard uuid}/calls > queued
- List calls queued in the switchboardget
- Answer the specified queued callput
Application > transfers > {transfer id}
Application > transfers
- Initiate a transferpost
Application > users/me > calls > {call id} > hold
- Hold a call from userput
- Unhold a call from userput
Application > users/me > calls > {call id} > mute
- Mute a call from userput
- Unmute a call from userput
Application > users/me > calls > {call id} > record
- Start recording a callput
- Stop recording a callput
Application > users/me > calls > {call id}
Application > users/me > calls
- List calls of a userget
- Make a new call from a userpost
Application > users/me > conferences > adhoc > {conference id} > participants/{call id}
- Remove a participant from an adhoc conferencedel
- Add a participant into an adhoc conferenceput
Application > users/me > conferences > adhoc > {conference id}
- Delete an adhoc conferencedel
Application > users/me > conferences > adhoc
- Create an adhoc conferencepost
Application > users/me > conferences
- List participants of a conference as a userget
Application > users/me > relocates > {relocate uuid}
Application > users/me > relocates
- Get the relocates of the authenticated userget
- Initiate a relocate from the authenticated userpost
Application > users/me > transfers > {transfer id}
- Cancel a transferdel
- Complete a transferput
Application > users/me > transfers
- Get the transfers of the authenticated userget
- Initiate a transfer from the authenticated userpost
Application > users/me > voicemails > greetings/{greeting}
Application > users/me > voicemails > messages/{message id}
Application > users/me > voicemails
- Get details of the voicemail of the authenticated userget
- Get details of a folderget
Application > users/me
- Send a fax as the user detected from the tokenpost
- List participants of a meeting as a userget
Application > voicemails/{voicemail id} > greetings/{greeting}
Application > voicemails/{voicemail id} > messages/{message id}
Configuration > voicemails > {voicemail id}
Application > voicemails/{voicemail id}
- Get details of a folderget
Application
- Send a faxpost
- List participants of a meetingget
Configuration > lines
- List linesget
- Create linepost
Configuration > trunks
- List trunksget
- Create trunkpost
Configuration > wizard
Configuration > voicemails
- List voicemailsget
- Create voicemailpost
Configuration > users > import
- Mass import users and associated resourcespost
- **Disabled!** Mass import users and associated resourcesput
Configuration > users > me/meetings > {meeting uuid}
Configuration > users > me/meetings
- List user meetingsget
- Create user meetingpost
Configuration > users > {user id} > agents
- Dissociate user and agentdel
- Associate user and agentput
Configuration > users > {user id} > callpermissions/{callpermission id}
- Dissociate user and call permissiondel
- Associate user and call permissionput
Configuration > users > {user id} > fallbacks
- List all fallbacks for userget
- Update user's fallbacksput
Configuration > users > {user id} > forwards > {forward name}
- Get forward for a userget
- Update a forward for a userput
Configuration > users > {user id} > forwards
- List forwards for a userget
- Update all forwards for a userput
Configuration > users > {user id} > funckeys > templates > {template id}
- Dissociate a func key template to a userdel
- Associate a func key template to a userput
Configuration > users > {user id} > funckeys > templates
- List funckey templates associated to userget
Configuration > users > {user id} > funckeys > {position}
Configuration > users > {user id} > funckeys
- List func keys for a userget
- Update func keys for a userput
Configuration > users > {user id} > lines > {line id}
- Dissociate user and linedel
- Associate user and lineput
Configuration > users > {user id} > lines
- Associate user and linesput
Configuration > users > {user id} > schedules/{schedule id}
- Dissociate user and scheduledel
- Associate user and scheduleput
Configuration > users > {user id} > services > {service name}
- Get status of serviceget
- Enable/Disable service for a userput
Configuration > users > {user id} > services
- Get status of all user's servicesget
- Update all services for a userput
Configuration > users > {user id} > voicemails
Configuration > users > {user id}
Configuration > users > {user uuid} > external/apps > {app name}
Configuration > users > {user uuid} > external/apps
- List user external appsget
Configuration > users > {user uuid} > lines
- Get SIP endpoint of main line for a userget
- Get SIP endpoint of a line for a userget
Configuration > trunks > {trunk id} > endpoints > custom/{custom id}
- Dissociate trunk and Custom endpointdel
- Associate trunk and Custom endpointput
Configuration > trunks > {trunk id} > endpoints > iax/{iax id}
- Dissociate trunk and IAX endpointdel
- Associate trunk and IAX endpointput
Configuration > trunks > {trunk id} > endpoints > sip/{sip uuid}
- Dissociate trunk and SIP endpointdel
- Associate trunk and SIP endpointput
Configuration > trunks > {trunk id} > registers/iax/{iax id}
- Dissociate trunk and IAX registerdel
- Associate trunk and IAX registerput
Configuration > trunks > {trunk id}
Configuration > tenants
- List tenantsget
- Get tenantget
Configuration > switchboards > {switchboard uuid} > fallbacks
- List all fallbacks for switchboardget
- Update switchboard's fallbacksput
Configuration > switchboards > {switchboard uuid}
Configuration > switchboards
- List switchboardsget
- Create a switchboardpost
Configuration > sounds > {sound category} > files/{sound filename}
Configuration > sounds > {sound category}
- Delete sound categorydel
- Get sound categoryget
Configuration > sounds
Configuration > sip/transports > {transport uuid}
Configuration > sip/transports
- List all configured SIP transportsget
- Create SIP transportpost
Configuration > registrars > {registrar id}
Configuration > registrars
- Get registrarsget
- Create registrarpost
Configuration > queues > skillrules > {skillrule id}
Configuration > queues > skillrules
- List skill ruleget
- Create skill rulepost
Configuration > queues > {queue id} > extensions/{extension id}
- Dissociate queue and extensiondel
- Associate queue and extensionput
Configuration > queues > {queue id} > fallbacks
- List all fallbacks for queueget
- Update queue's fallbacksput
Configuration > queues > {queue id} > members > agents/{agent id}
- Dissociate agent and queuedel
- Update Agent-Queue associationput
Configuration > queues > {queue id} > members > users/{user id}
- Dissociate user and queuedel
- Update User-Queue associationput
Configuration > queues > {queue id} > schedules/{schedule id}
- Dissociate queue and scheduledel
- Associate queue and scheduleput
Configuration > queues > {queue id}
Configuration > queues
- List queuesget
- Create queuepost
Configuration > registers/iax > {register iax id}
Configuration > registers/iax
- List registers iaxget
- Create register_iaxpost
Configuration > schedules > {schedule id}
Configuration > schedules
- List scheduleget
- Create schedulepost
Configuration > provisioning/networking
- Get Provisioning Networking configurationget
- Update Provisioning Networking configurationput
Configuration > parkinglots > {parking lot id} > extensions/{extension id}
- Dissociate parking lot and extensiondel
- Associate parking_lot and extensionput
Configuration > parkinglots > {parking lot id}
Configuration > parkinglots
- List parking lotsget
- Create parking lotpost
Configuration > pagings > {paging id}
Configuration > pagings
- List pagingget
- Create pagingpost
Configuration > outcalls > {outcall id} > callpermissions/{callpermission id}
- Dissociate outcall and call permissiondel
- Associate outcall and call permissionput
Configuration > outcalls > {outcall id} > extensions/{extension id}
- Dissociate outcall and extensiondel
- Associate outcall and extensionput
Configuration > outcalls > {outcall id} > schedules/{schedule id}
- Dissociate outcall and scheduledel
- Associate outcall and scheduleput
Configuration > outcalls > {outcall id}
Configuration > outcalls
- List outgoing callsget
- Create outgoing callpost
Configuration > moh > {moh uuid} > files/{moh filename}
Configuration > moh > {moh uuid}
Configuration > moh
- List MOH classesget
- Create MOH classpost
Configuration > meetings > {meeting uuid}
Configuration > meetings
- List meetingsget
- Create meetingpost
Configuration > lines > {line id} > applications/{application uuid}
- Dissociate line and applicationdel
- Associate line and applicationput
Configuration > lines > {line id} > devices > {device id}
- Dissociate line and devicedel
- Associate line and deviceput
Configuration > lines > {line id} > devices
- Get Device associated to Lineget
Configuration > lines > {line id} > endpoints > custom/{custom id}
- Dissociate line and Custom endpointdel
- Associate line and Custom endpointput
Configuration > lines > {line id} > endpoints > sccp/{sccp id}
- Dissociate line and SCCP endpointdel
- Associate line and SCCP endpointput
Configuration > lines > {line id} > endpoints > sip/{sip uuid}
- Dissociate line and SIP endpointdel
- Associate line and SIP endpointput
Configuration > lines > {line id} > extensions/{extension id}
- Dissociate line and extensiondel
- Associate line and extensionput
Configuration > lines > {line id}
Configuration > ivr > {ivr id}
Configuration > ivr
- List IVRget
- Create IVRpost
Configuration > incalls > {incall id} > extensions/{extension id}
- Dissociate incall and extensiondel
- Associate incall and extensionput
Configuration > incalls > {incall id} > schedules/{schedule id}
- Dissociate incall and scheduledel
- Associate incall and scheduleput
Configuration > incalls > {incall id}
Configuration > incalls
- List incoming callsget
- Create incoming callpost
Configuration > ha
- Get High Availability configurationget
- Update High Availability configurationput
Configuration > groups > {group uuid} > callpermissions/{callpermission id}
- Dissociate group and call permissiondel
- Associate group and call permissionput
Configuration > groups > {group uuid} > extensions/{extension id}
- Dissociate group and extensiondel
- Associate group and extensionput
Configuration > groups > {group uuid} > fallbacks
- List all fallbacks for groupget
- Update group's fallbacksput
Configuration > groups > {group uuid} > members
- Update group and extensionsput
- Update group and usersput
Configuration > groups > {group uuid} > schedules/{schedule id}
- Dissociate group and scheduledel
- Associate group and scheduleput
Configuration > funckeys > templates > {template id} > {position}
Configuration > funckeys > templates > {template id}
Configuration > funckeys > templates
- List a func key templateget
- Create a template of func keyspost
Configuration > funckeys
- List of possible func key destinations and their parametersget
Configuration > external/apps > {app name}
Configuration > external/apps
- List external appsget
Configuration > extensions > features > {extension id}
- Get extension featureget
- Update extensionput
Configuration > extensions > features
- List extensions featuresget
Configuration > extensions > {extension id}
Configuration > extensions
- List extensionsget
- Create extensionpost
Configuration > endpoints > custom > {custom id}
Configuration > endpoints > custom
- List Custom endpointsget
- Create Custom endpointpost
Configuration > endpoints > iax > {iax id}
Configuration > endpoints > iax
- List IAX endpointsget
- Create IAX endpointpost
Configuration > endpoints > sccp > {sccp id}
Configuration > endpoints > sccp
- List SCCP endpointsget
- Create SCCP endpointpost
Configuration > endpoints > sip > templates > {template uuid}
Configuration > endpoints > sip > templates
- List SIP endpoints templatesget
- Create a SIP endpoint templatepost
Configuration > endpoints > sip > {sip uuid}
Configuration > endpoints > sip
- List SIP endpointsget
- Create a SIP endpointpost
Configuration > emails
- Get e-mail configurationget
- Update e-mail configurationput
Configuration > dhcp
- Get DHCP configurationget
- Update DHCP configurationput
Configuration > devices > unallocated
- List unallocated devicesget
- Assign unallocated device tenantput
Configuration > devices > {device id}
Configuration > devices
- List devicesget
- Create devicepost
Configuration > contexts > {context id}
Configuration > contexts
- List contextsget
- Create contextpost
Configuration > configuration/live reload
- Get live reload statusget
- Update live reload statusput
Configuration > conferences > {conference id} > extensions/{extension id}
- Dissociate conference and extensiondel
- Associate conference and extensionput
Configuration > conferences > {conference id}
Configuration > conferences
- List conferenceget
- Create conferencepost
Configuration > callpickups > {callpickup id} > interceptors
- Update call pickup and interceptorsput
- Update call pickup and interceptorsput
Configuration > callpickups > {callpickup id} > targets
- Update call pickup and targetsput
- Update call pickup and targetsput
Configuration > callpickups > {callpickup id}
Configuration > callpickups
- List call pickupsget
- Create call pickuppost
Configuration > callpermissions > {callpermission id}
Configuration > callpermissions
- List call permissionsget
- Create call permissionpost
Configuration > callfilters > {callfilter id} > fallbacks
- List all fallbacks for call filterget
- Update call filter's fallbacksput
Configuration > callfilters > {callfilter id}
Configuration > callfilters
- List call filtersget
- Create call filterpost
Configuration > asterisk > confbridge > ytel default bridge
- List ConfBridge wazo_default_bridge optionsget
- Update ConfBridge wazo_default_bridge optionput
Configuration > asterisk > confbridge > ytel default user
- List ConfBridge wazo_default_user optionsget
- Update ConfBridge wazo_default_user optionput
Configuration > asterisk > features > applicationmap
- List Features applicationmap optionsget
- Update Features applicationmap optionput
Configuration > asterisk > features > featuremap
- List Features featuremap optionsget
- Update Features featuremap optionput
Configuration > asterisk > features > general
- List Features general optionsget
- Update Features general optionput
Configuration > asterisk > hep/general
- List HEP general optionsget
- Update HEP general optionput
Configuration > asterisk > iax > callnumberlimits
- List IAX callnumberlimits optionsget
- Update IAX callnumberlimits optionput
Configuration > asterisk > iax > general
- List IAX general optionsget
- Update IAX general optionput
Configuration > asterisk > pjsip > global
- List of PJSIP options for the `global` sectionget
- Update PJSIP section optionsput
Configuration > asterisk > pjsip > system
- List of PJSIP options for the `system` sectionget
- Update PJSIP section optionsput
Configuration > asterisk > pjsip
- List all PJSIP configuration optionsget
Configuration > asterisk > queues/general
- List Queue general optionsget
- Update Queue general optionput
Configuration > asterisk > rtp > general
- List RTP general optionsget
- Update RTP general optionput
Configuration > asterisk > rtp > ice host candidates
- List RTP ice_host_candidates optionsget
- Update RTP ice_host_candidates optionput
Configuration > asterisk > sccp/general
- List SCCP general optionsget
- Update SCCP general optionput
Configuration > asterisk > voicemail > general
- List Voicemail general optionsget
- Update Voicemail general optionput
Configuration > asterisk > voicemail > zonemessages
- List Voicemail zonemessages optionsget
- Update Voicemail zonemessages optionput
Configuration > applications
- List applicationget
- Create applicationpost
Configuration > agents > skills > {skill id}
Configuration > agents > skills
- List skillget
- Create skillpost
Configuration > agents > {agent id} > skills/{skill id}
- Dissociate agent and skilldel
- Associate agent and skillput
Configuration > agents > {agent id}
Call Center Agent > agents
Configuration > agents
- Create agentpost
Configuration > access features > {access feature id}
Configuration > access features
- List access featuresget
- Create access_featurepost
Configuration > tenants/{tenant}/phonebooks > {phonebook id} > contacts > {contact id}
Configuration > tenants/{tenant}/phonebooks > {phonebook id} > contacts
Configuration > tenants/{tenant}/phonebooks > {phonebook id}
Configuration > tenants/{tenant}/phonebooks
- List all phonebooks for a given tenantget
- Create a new phonebookpost
Configuration
Contacts > backends > conference/sources > {source uuid}
Contacts > backends > conference/sources
- Get all `conference` source configurationsget
- Configure a source for the `conference` backendpost
Contacts > backends > csv/sources > {source uuid}
Contacts > backends > csv/sources
- Get all `csv` source configurationsget
- Configure a source for the `csv` backendpost
Contacts > backends > csv ws/sources > {source uuid}
Contacts > backends > csv ws/sources
- Get all `csv_ws` source configurationsget
- Configure a source for the `csv_ws` backendpost
Contacts > backends > google/sources > {source uuid}
Contacts > backends > google/sources
- Get google configurationget
- Configure a source for the google backendpost
Contacts > backends > ldap/sources > {source uuid}
Contacts > backends > ldap/sources
- Get all `ldap` source configurationsget
- Configure a source for the `ldap` backendpost
Contacts > backends > office365/sources > {source uuid}
Contacts > backends > office365/sources
- Get microsoft configurationget
- Configure a source for the microsoft backendpost
Contacts > backends > personal/sources > {source uuid}
Contacts > backends > personal/sources
- Get all `personal` source configurationsget
- Configure a source for the `personal` backendpost
Contacts > backends > phonebook/sources > {source uuid}
Contacts > backends > phonebook/sources
- Get all `phonebook` source configurationsget
- Configure a source for the `phonebook` backendpost
Contacts > backends > wazo/sources > {source uuid}
Contacts > backends > wazo/sources
- Get all `wazo` source configurationsget
- Configure a source for the `wazo` backendpost
Contacts > directories > favorites > {directory}/{contact}
- Unmark a contact as favoritedel
- Mark a contact as favoriteput
Contacts > directories > favorites
- List favorite contactsget
Contacts > directories > lookup/{profile}
Contacts > directories
Contacts > displays > {display uuid}
Contacts > displays
- List displaysget
- Create a new display configurationpost
Contacts > graphql
- Show GraphiQL test interface for GraphQL in a browser. This is not a REST endpoint.get
- Execute a GraphQL query. This is a GraphQL endpoint, not a REST endpoint.post
Contacts > personal > {contact id}
Contacts > personal
Contacts > profiles > {profile uuid}
Contacts > profiles
- List all configured profilesget
- Create a new configuration profilepost
Contacts
- List all loaded servicesget
- List all configured sourcesget
Phone Provisioning > configure > {param id}
- Get the configuration parameter valueget
- Set the value of a parameterput
Phone Provisioning > configure
Phone Provisioning > dev mgr > devices > {device id}
Phone Provisioning > dev mgr > devices
- List and find devicesget
- Create a devicepost
Phone Provisioning > dev mgr > synchronize > {operation id}
- Get the status of a synchronize Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > dev mgr > synchronize
- Synchronize a devicepost
Phone Provisioning > dev mgr
Phone Provisioning > cfg mgr > configs > {config id}
Phone Provisioning > cfg mgr > configs
- List and find configurationsget
- Create a configurationpost
Phone Provisioning > cfg mgr
- Get the Config Manager resourceget
- Create an autocreate configurationpost
Phone Provisioning > pg mgr > plugins > {plugin id} > install > install > {operation id}
- Get the status of a package installation Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > pg mgr > plugins > {plugin id} > install > install
- Install a packagepost
Phone Provisioning > pg mgr > plugins > {plugin id} > install > upgrade/{operation id}
- Get the status of a package upgrade Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > pg mgr > plugins > {plugin id} > install
Phone Provisioning > pg mgr > plugins > {plugin id}
- Get the resources of a specific pluginget
- Get the information of a pluginget
Phone Provisioning > pg mgr > plugins
- List the installed pluginsget
Phone Provisioning > pg mgr > install > install > {operation id}
- Get the status of a plugin installation Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > pg mgr > install > install
- Install a pluginpost
Phone Provisioning > pg mgr > install > upgrade > {operation id}
- Get the status of a plugin upgrade Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > pg mgr > install > upgrade
- Upgrade a pluginpost
Phone Provisioning > pg mgr > install > update > {operation id}
- Get the status of a plugin database update Operation In Progressget
- Delete the Operation In Progressdel
Phone Provisioning > pg mgr > install > update
- Update the List of installable pluginspost
Phone Provisioning > pg mgr > install
Phone Provisioning > pg mgr
- Get the Plugin Manager resourceget
- Reload a pluginpost
Phone Provisioning
- Get the Provd Manager resourceget
Webhooks > subscriptions > {subscription uuid}
Webhooks > subscriptions
Webhooks > users/me/subscriptions > {subscription uuid}
- Delete a user subscriptiondel
- Get a user subscriptionget
Webhooks > users/me/subscriptions
- List subscriptions of a user to HTTP callbacksget
- Subscribe to a HTTP callback (webhook) as a userpost
Call Detail Records > agents
- Statistics for all agentsget
- Statistics for a specific agentget
Call Detail Records > cdr > recordings/media
- Delete multiple CDRs recording mediadel
- Create an export for the recording media of multiple CDRspost
Call Detail Records > cdr > {cdr id} > recordings/{recording uuid}/media
- Delete a recording mediadel
- Get a recording mediaget
Call Detail Records > cdr > {cdr id}
- Get a CDR by IDget
Call Detail Records > cdr
- List CDRget
Call Detail Records > exports/{export uuid}
- Get an export by the given UUIDget
- Download an export as a ZIP archive by the given UUIDget
Call Detail Records > queues > {queue id}/statistics
- Statistics for a specific queueget
- QoS statistics for a specific queueget
Call Detail Records > queues
- Statistics for all queuesget
Call Detail Records > retention
- Retention configurationget
- Update retention configurationput
Call Detail Records > users
- List CDR of the authenticated userget
- List CDR of the given userget
Plugins > market
- List plugins available on the configured marketget
- Fetch the information about a plugin from the marketget
Plugins > plugins > {namespace}/{name}
- Uninstall a plugindel
- Fetch the information about a plugin that has been installedget
Plugins > plugins
- List installed pluginsget
- Install a pluginpost
Call Center Agent > agents > by-id/{agent id}
Call Center Agent > agents > by-number/{agent number}
Call Center Agent > users/me/agents
Presence and Chat > users > me/rooms > {room uuid}/messages
- List room messagesget
- Create room messagespost
Presence and Chat > users > me/rooms
Presence and Chat > users > {user uuid}/presences
- Get user presenceget
- Update user presenceput
Presence and Chat > users
- List presencesget

Subscribe to a HTTP callback (webhook)

post

http://{{baseurl}}/subscriptions

Required ACL: webhookd.subscriptions.create

Language

URL

Click Try It! to start a request and see the response here!