Jump to Content
Home
Documentation
API Reference
ChangeLog
Discussion
v4.0.4
Home
API Reference
Home
v4.0.4
API Reference
List and find devices
Search
All
Pages
Start typing to search…
JUMP TO
CPaaS API
Authentication
Request a Token
post
Accounts
Create User
post
Create Sub-Account
post
Assets
Get Assets
get
Upload Asset
post
Delete Asset
del
Billing
Get Usage
get
Call
Make Call
post
Make Group Call
post
Send digit
post
Record Call
post
Play Audio
post
Interupt Call
post
Campaigns
Get Campaigns
get
Add Campaign
post
Get Report
get
Edit Campaign
put
Get Campaign
get
Send Campaign
post
Archive Campaign
del
Unarchive Campaign
put
Carrier
Get Carrier
get
Contacts
Get Contacts
get
Add Contact
post
Search Contacts
post
Upload Contacts
post
Upload Contacts Async
post
Edit Contact
put
Archive Contact
del
Get Contact
get
Unarchive Contact
put
DNC
Add Dnc
post
Upload DNC Async
post
Check DNC
get
Inbound Routing > RouteTag
Get all RouteTags
get
Update RouteTag
put
Get RouteTag
get
Delete RouteTag
del
Add RouteTag
post
Assign RouteTag to number(s)
post
Delete RouteTag from number(s)
del
Inbound Routing > RouteDest
Get RouteDest for routeTag
get
Delete RouteDest
del
Add RouteDest
post
Update RouteDest
put
Get all RouteDest for account
get
Get RouteDest Single Entry
get
Inbox
Get inbox
get
Update Inbox status
put
Get Conversation
get
Send Message
post
Add conversation notes
post
Add conversation external event
post
Logs
Get Call Logs
get
Get Call Detail Log
get
Get SMS Logs
get
Get SMS Detail Log
get
Call Recordings
get
Get Debug logs
get
Numbers
Get Numbers
get
Get Available Numbers
get
Purchase Number
post
Release Number
post
Move Numbers
post
Get Number
get
Edit Number
put
Assign WebRTC Number
post
Number Sets
Get Number Sets
get
Add Number Set
post
Add Number to Set
post
Get Number Set
get
Edit Number Set
put
Delete Number Set
del
Delete Numbers from Set
del
Statistics
Aggregate Statistics
get
Hourly statistics
get
Communication aggregate statistics
get
Saved Queries
Get Saved Contact Queries
get
Add Saved Query
post
Update Saved Query
put
Shortcodes
Edit Shortcode
put
Edit Shared Shortcode
put
SMS
Send SMS
post
Send OTP
post
SMS Templates
Get Templates
get
Add Template
post
Edit Template
put
Archive Template
del
Get Template
get
Unarchive Template
put
Webhooks
Get All Webhook Common Configurations
get
Add Webook Common Configuration
post
Edit Webhook Common Configuration
put
Get Webhook Common Configuration by Id
get
Delete Webhook Common Configuration by Id
del
Get All Webhook Configurations
get
Add Webhook Configuration
post
Edit Webhook Configuration
put
Get Webhook Configuration by Id
get
Delete Webhook Configuration
del
Workflows
Get Workflow
get
Add workflow
post
Edit Workflow
put
Workflow Runner
Add Runner
post
Get Campaign Runners for Campaign
get
Edit Runner
put
Get Campaign Runner
get
Get Campaign Runners
get
Start a Campaign Runner
post
Stop a Campaign Runner
post
Get next Campaign Runner (Manual)
get
Send next Campaign Runner (Manual)
post
Timezones
Get Timezones
get
Get Timezone
get
CCaaS API
Agent API
pause_code
get
Non-Agent API
add_fpg_phone
get
UCaaS API
Presence and Chat
Show the current configuration
get
Print info about internal status of ytel-chatd
get
Call Detail Records > config
Update the current configuration.
patch
Authentication > emails/{email uuid}/confirm
Confirm an email address
get
Confirm an email address
put
Authentication > external/{auth type}/config
Delete the client id and client secret
del
Retrieve the client id and client secret
get
Add configuration for the given auth_type
post
Update configuration for the given auth_type
put
Authentication > groups > {group uuid} > policies > {policy uuid}
Dissociate a policy from a group
del
Associate a group to a policy
put
Authentication > groups > {group uuid} > policies
Retrieves the list of policies associated to a group
get
Authentication > groups > {group uuid} > users > {user uuid}
Dissociate a user from a group
del
Associate a group to a user
put
Authentication > groups > {group uuid} > users
Retrieves the list of users associated to a group
get
Configuration > groups > {group uuid}
Delete group
del
Get group
get
Update group
put
Configuration > groups
List groups
get
Create group
post
Authentication > policies > {policy uuid} > acl/{access}
Dissociate an access from a policy
del
Associate an access to a policy
put
Authentication > policies > {policy uuid}
Delete a policy
del
Retrieves the details of a policy
get
Modify an ACL policy
put
Authentication > policies
List ACL policies
get
Create a new ACL policy
post
Authentication > sessions
List sessions
get
Delete a session
del
Authentication > token > {token}
Revoke a token
del
Retrieves token data
get
Checks if a token is valid
head
Check a token against scopes
post
Authentication > token
Creates a token
post
Authentication > users > password/reset
Reset the user password
get
Set the user password
post
Authentication > users > {user uuid or me}/tokens
Retrieve a user's refresh token list
get
Delete a user's refresh token
del
Authentication > users > {user uuid} > emails
Update email addresses
put
Ask a new confirmation email
get
Authentication > users > {user uuid} > external > google
Delete a Google token
del
Get a Google token
get
Ask for a verification URL and store code to get token
post
Authentication > users > {user uuid} > external > microsoft
Delete a Microsoft token
del
Get a Microsoft token
get
Ask for a verification URL and store code to get token
post
Authentication > users > {user uuid} > external > mobile
Delete device tokens for push notifications
del
Get device tokens for push notifications
get
Configure device tokens for push notifications
post
Get your Mobile sender_id
get
Authentication > users > {user uuid} > external
Retrieves the list of the users external auth data
get
Authentication > users > {user uuid} > policies > {policy uuid}
Dissociate a policy from a user
del
Associate a policy to a user
put
Authentication > users > {user uuid} > policies
Retrieves the list of policies associated to a user
get
Authentication > users > {user uuid} > sessions
Retrieves the list of sessions associated to a user
get
Delete a session
del
Authentication > users > {user uuid}
Delete a user
del
Retrieves the details of a user
get
Update an existing user
put
Retrieves the list of groups associated to a user
get
Change the user's password
put
Retrieves the details of a user
get
Configuration > users
List users
get
Create user
post
Mass export users and associated resources
get
Authentication > users
Create a user
post
Authentication
Update email addresses
put
Check if ytel-auth is OK
head
Retrieve a list of refresh tokens that have been created on the system
get
Contacts > backends
List all loaded backends
get
Application > calls > {call id} > hold
Hold a call
put
Unhold a call
put
Application > calls > {call id} > mute
Mute a call
put
Unmute a call
put
Application > calls > {call id} > record
Start recording a call
put
Stop recording a call
put
Application > calls > {call id}
Hangup a call
del
Show a call
get
Answer a call
put
Simulate a user pressing DTMF keys
put
Connect a call to a user
put
Application > calls
List calls
get
Make a new call
post
Application > applications/{application uuid} > calls > {call id} > hold
Place a call on hold
put
Resume a call that has been placed on hold
put
Application > applications/{application uuid} > calls > {call id} > moh
Stops playing a music on hold
put
Starts playing a music on hold
put
Application > applications/{application uuid} > calls > {call id} > mute
Mute a call
put
Unmute a call
put
Application > applications/{application uuid} > calls > {call id} > progress
Play the progress ringing tone
put
Stop playing the progress ringing tone.
put
Application > applications/{application uuid} > calls > {call id}
Hangup a call from the application
del
Answer a call
put
Simulate a user pressing DTMF keys
put
Play file to the call
post
Start snooping on a call
post
Application > applications/{application uuid} > calls
List calls from the application
get
Make a new call to the application
post
Application > applications/{application uuid} > nodes > {node uuid} > calls > {call id}
Remove call from the node
del
Insert call to the node
put
Application > applications/{application uuid} > nodes > {node uuid} > calls
Make a new call to the node
post
Initiate a call to a user and insert it in the node
post
Application > applications/{application uuid} > nodes > {node uuid}
Delete node and hangup all calls
del
Show a node
get
Application > applications/{application uuid} > nodes
List nodes from the application
get
Make a new node and add calls
post
Application > applications/{application uuid} > snoops > {snoop uuid}
Stop snooping
del
View snooping parameters
get
Change snooping parameters
put
Application > applications/{application uuid} > snoops
List active snoops
get
Configuration > applications > {application uuid}
Get application
get
Delete application
del
Update application
put
Application > applications/{application uuid}
Stop and remove playback
del
Application > conferences/{conference id} > participants > {participant id}
Kick participant from a conference
del
Mute a participant in a conference
put
Unmute a participant in a conference
put
Application > conferences/{conference id} > participants
List participants of a conference
get
Application > conferences/{conference id} > record
Stop recording a conference
del
Record a conference
post
Application > switchboards/{switchboard uuid}/calls > held > {call id}
Put the specified call on hold in the switchboard
put
Answer the specified held call
put
Application > switchboards/{switchboard uuid}/calls > held
List calls held in the switchboard
get
Application > switchboards/{switchboard uuid}/calls > queued
List calls queued in the switchboard
get
Answer the specified queued call
put
Application > transfers > {transfer id}
Cancel a transfer
del
Get details of a transfer
get
Complete a transfer
put
Application > transfers
Initiate a transfer
post
Application > users/me > calls > {call id} > hold
Hold a call from user
put
Unhold a call from user
put
Application > users/me > calls > {call id} > mute
Mute a call from user
put
Unmute a call from user
put
Application > users/me > calls > {call id} > record
Start recording a call
put
Stop recording a call
put
Application > users/me > calls > {call id}
Hangup a call from a user
del
Answer a call from user
put
Simulate a user pressing DTMF keys
put
Application > users/me > calls
List calls of a user
get
Make a new call from a user
post
Application > users/me > conferences > adhoc > {conference id} > participants/{call id}
Remove a participant from an adhoc conference
del
Add a participant into an adhoc conference
put
Application > users/me > conferences > adhoc > {conference id}
Delete an adhoc conference
del
Application > users/me > conferences > adhoc
Create an adhoc conference
post
Application > users/me > conferences
List participants of a conference as a user
get
Application > users/me > relocates > {relocate uuid}
Get details of a relocate
get
Cancel a relocate
put
Complete a relocate
put
Application > users/me > relocates
Get the relocates of the authenticated user
get
Initiate a relocate from the authenticated user
post
Application > users/me > transfers > {transfer id}
Cancel a transfer
del
Complete a transfer
put
Application > users/me > transfers
Get the transfers of the authenticated user
get
Initiate a transfer from the authenticated user
post
Application > users/me > voicemails > greetings/{greeting}
Delete a custom greeting
del
Get a custom greeting
get
Check if greeting exists
head
Create a custom greeting
post
Update a custom greeting
put
Copy a custom greeting
post
Application > users/me > voicemails > messages/{message id}
Delete a mesage
del
Get a message
get
Update a message
put
Get a message's recording
get
Application > users/me > voicemails
Get details of the voicemail of the authenticated user
get
Get details of a folder
get
Application > users/me
Send a fax as the user detected from the token
post
List participants of a meeting as a user
get
Application > voicemails/{voicemail id} > greetings/{greeting}
Delete a custom greeting
del
Get a custom greeting
get
Check if greeting exists
head
Create a custom greeting
post
Update a custom greeting
put
Copy a custom greeting
post
Application > voicemails/{voicemail id} > messages/{message id}
Delete a mesage
del
Get a message
get
Update a message
put
Get a message's recording
get
Configuration > voicemails > {voicemail id}
Get voicemail
get
Delete voicemail
del
Update voicemail
put
Application > voicemails/{voicemail id}
Get details of a folder
get
Application
Send a fax
post
List participants of a meeting
get
Configuration > lines
List lines
get
Create line
post
Configuration > trunks
List trunks
get
Create trunk
post
Configuration > wizard
Get wizard status
get
Pass the wizard
post
Get wizard discover
get
Configuration > voicemails
List voicemails
get
Create voicemail
post
Configuration > users > import
Mass import users and associated resources
post
**Disabled!** Mass import users and associated resources
put
Configuration > users > me/meetings > {meeting uuid}
Delete one of the meetings of the current user
del
Get one of the meetings of the current user
get
Update one of the meetings of the current user
put
Configuration > users > me/meetings
List user meetings
get
Create user meeting
post
Configuration > users > {user id} > agents
Dissociate user and agent
del
Associate user and agent
put
Configuration > users > {user id} > callpermissions/{callpermission id}
Dissociate user and call permission
del
Associate user and call permission
put
Configuration > users > {user id} > fallbacks
List all fallbacks for user
get
Update user's fallbacks
put
Configuration > users > {user id} > forwards > {forward name}
Get forward for a user
get
Update a forward for a user
put
Configuration > users > {user id} > forwards
List forwards for a user
get
Update all forwards for a user
put
Configuration > users > {user id} > funckeys > templates > {template id}
Dissociate a func key template to a user
del
Associate a func key template to a user
put
Configuration > users > {user id} > funckeys > templates
List funckey templates associated to user
get
Configuration > users > {user id} > funckeys > {position}
Remove func key for user
del
Get a func key for a user
get
Add/Replace a func key for a user
put
Configuration > users > {user id} > funckeys
List func keys for a user
get
Update func keys for a user
put
Configuration > users > {user id} > lines > {line id}
Dissociate user and line
del
Associate user and line
put
Configuration > users > {user id} > lines
Associate user and lines
put
Configuration > users > {user id} > schedules/{schedule id}
Dissociate user and schedule
del
Associate user and schedule
put
Configuration > users > {user id} > services > {service name}
Get status of service
get
Enable/Disable service for a user
put
Configuration > users > {user id} > services
Get status of all user's services
get
Update all services for a user
put
Configuration > users > {user id} > voicemails
Dissociate user and voicemail
del
Get user voicemails
get
Associate user and voicemail
put
Configuration > users > {user id}
Delete user
del
Get user
get
Check if user exists
head
Update user
put
Update user and groups
put
Configuration > users > {user uuid} > external/apps > {app name}
Delete user external app
del
Get user external app
get
Create user external app
post
Update user external app
put
Configuration > users > {user uuid} > external/apps
List user external apps
get
Configuration > users > {user uuid} > lines
Get SIP endpoint of main line for a user
get
Get SIP endpoint of a line for a user
get
Configuration > trunks > {trunk id} > endpoints > custom/{custom id}
Dissociate trunk and Custom endpoint
del
Associate trunk and Custom endpoint
put
Configuration > trunks > {trunk id} > endpoints > iax/{iax id}
Dissociate trunk and IAX endpoint
del
Associate trunk and IAX endpoint
put
Configuration > trunks > {trunk id} > endpoints > sip/{sip uuid}
Dissociate trunk and SIP endpoint
del
Associate trunk and SIP endpoint
put
Configuration > trunks > {trunk id} > registers/iax/{iax id}
Dissociate trunk and IAX register
del
Associate trunk and IAX register
put
Configuration > trunks > {trunk id}
Delete trunk
del
Get trunk
get
Update trunk
put
Configuration > tenants
List tenants
get
Get tenant
get
Configuration > switchboards > {switchboard uuid} > fallbacks
List all fallbacks for switchboard
get
Update switchboard's fallbacks
put
Configuration > switchboards > {switchboard uuid}
Delete a switchboard
del
Get a switchboard
get
Update a switchboard
put
Update switchboard and members
put
Configuration > switchboards
List switchboards
get
Create a switchboard
post
Configuration > sounds > {sound category} > files/{sound filename}
Delete audio file
del
Get audio file
get
Add or update audio file
put
Configuration > sounds > {sound category}
Delete sound category
del
Get sound category
get
Configuration > sounds
List sound categories
get
Create sound category
post
List all languages for sounds
get
Configuration > sip/transports > {transport uuid}
Delete SIP transport
del
Get SIP transport
get
Update SIP transport
put
Configuration > sip/transports
List all configured SIP transports
get
Create SIP transport
post
Configuration > registrars > {registrar id}
Delete registrar
del
Get registrar
get
Update registrar
put
Configuration > registrars
Get registrars
get
Create registrar
post
Configuration > queues > skillrules > {skillrule id}
Delete skill rule
del
Get skill rule
get
Update skill rule
put
Configuration > queues > skillrules
List skill rule
get
Create skill rule
post
Configuration > queues > {queue id} > extensions/{extension id}
Dissociate queue and extension
del
Associate queue and extension
put
Configuration > queues > {queue id} > fallbacks
List all fallbacks for queue
get
Update queue's fallbacks
put
Configuration > queues > {queue id} > members > agents/{agent id}
Dissociate agent and queue
del
Update Agent-Queue association
put
Configuration > queues > {queue id} > members > users/{user id}
Dissociate user and queue
del
Update User-Queue association
put
Configuration > queues > {queue id} > schedules/{schedule id}
Dissociate queue and schedule
del
Associate queue and schedule
put
Configuration > queues > {queue id}
Delete queue
del
Get queue
get
Update queue
put
Configuration > queues
List queues
get
Create queue
post
Configuration > registers/iax > {register iax id}
Delete register IAX
del
Get register IAX
get
Update register IAX
put
Configuration > registers/iax
List registers iax
get
Create register_iax
post
Configuration > schedules > {schedule id}
Delete schedule
del
Get schedule
get
Update schedule
put
Configuration > schedules
List schedule
get
Create schedule
post
Configuration > provisioning/networking
Get Provisioning Networking configuration
get
Update Provisioning Networking configuration
put
Configuration > parkinglots > {parking lot id} > extensions/{extension id}
Dissociate parking lot and extension
del
Associate parking_lot and extension
put
Configuration > parkinglots > {parking lot id}
Delete parking lot
del
Get parking lot
get
Update parking lot
put
Configuration > parkinglots
List parking lots
get
Create parking lot
post
Configuration > pagings > {paging id}
Delete paging
del
Get paging
get
Update paging
put
Update paging and callers
put
Update paging and members
put
Configuration > pagings
List paging
get
Create paging
post
Configuration > outcalls > {outcall id} > callpermissions/{callpermission id}
Dissociate outcall and call permission
del
Associate outcall and call permission
put
Configuration > outcalls > {outcall id} > extensions/{extension id}
Dissociate outcall and extension
del
Associate outcall and extension
put
Configuration > outcalls > {outcall id} > schedules/{schedule id}
Dissociate outcall and schedule
del
Associate outcall and schedule
put
Configuration > outcalls > {outcall id}
Delete outgoing call
del
Get outgoing call
get
Update outgoing call
put
Associate outcall and trunks
put
Configuration > outcalls
List outgoing calls
get
Create outgoing call
post
Configuration > moh > {moh uuid} > files/{moh filename}
Delete audio file
del
Get audio file
get
Add or update audio file
put
Configuration > moh > {moh uuid}
Delete MOH class
del
Get MOH class
get
Update MOH class
put
Configuration > moh
List MOH classes
get
Create MOH class
post
Configuration > meetings > {meeting uuid}
Delete meeting
del
Get meeting
get
Update meeting
put
Configuration > meetings
List meetings
get
Create meeting
post
Configuration > lines > {line id} > applications/{application uuid}
Dissociate line and application
del
Associate line and application
put
Configuration > lines > {line id} > devices > {device id}
Dissociate line and device
del
Associate line and device
put
Configuration > lines > {line id} > devices
Get Device associated to Line
get
Configuration > lines > {line id} > endpoints > custom/{custom id}
Dissociate line and Custom endpoint
del
Associate line and Custom endpoint
put
Configuration > lines > {line id} > endpoints > sccp/{sccp id}
Dissociate line and SCCP endpoint
del
Associate line and SCCP endpoint
put
Configuration > lines > {line id} > endpoints > sip/{sip uuid}
Dissociate line and SIP endpoint
del
Associate line and SIP endpoint
put
Configuration > lines > {line id} > extensions/{extension id}
Dissociate line and extension
del
Associate line and extension
put
Configuration > lines > {line id}
Delete line
del
Get line
get
Update line
put
Configuration > ivr > {ivr id}
Delete IVR
del
Get IVR
get
Update IVR
put
Configuration > ivr
List IVR
get
Create IVR
post
Configuration > incalls > {incall id} > extensions/{extension id}
Dissociate incall and extension
del
Associate incall and extension
put
Configuration > incalls > {incall id} > schedules/{schedule id}
Dissociate incall and schedule
del
Associate incall and schedule
put
Configuration > incalls > {incall id}
Delete incoming call
del
Get incoming call
get
Update incoming call
put
Configuration > incalls
List incoming calls
get
Create incoming call
post
Configuration > ha
Get High Availability configuration
get
Update High Availability configuration
put
Configuration > groups > {group uuid} > callpermissions/{callpermission id}
Dissociate group and call permission
del
Associate group and call permission
put
Configuration > groups > {group uuid} > extensions/{extension id}
Dissociate group and extension
del
Associate group and extension
put
Configuration > groups > {group uuid} > fallbacks
List all fallbacks for group
get
Update group's fallbacks
put
Configuration > groups > {group uuid} > members
Update group and extensions
put
Update group and users
put
Configuration > groups > {group uuid} > schedules/{schedule id}
Dissociate group and schedule
del
Associate group and schedule
put
Configuration > funckeys > templates > {template id} > {position}
Remove func key from template
del
Get a func key inside template
get
Add/Replace a func key in a template
put
Configuration > funckeys > templates > {template id}
Delete func key template
del
Get a func key template
get
Update a func key template
put
List users associated to template
get
Configuration > funckeys > templates
List a func key template
get
Create a template of func keys
post
Configuration > funckeys
List of possible func key destinations and their parameters
get
Configuration > external/apps > {app name}
Delete external app
del
Get external app
get
Create external app
post
Update external app
put
Configuration > external/apps
List external apps
get
Configuration > extensions > features > {extension id}
Get extension feature
get
Update extension
put
Configuration > extensions > features
List extensions features
get
Configuration > extensions > {extension id}
Delete extension
del
Get extension
get
Update extension
put
Configuration > extensions
List extensions
get
Create extension
post
Configuration > endpoints > custom > {custom id}
Delete Custom Endpoint
del
Get Custom Endpoint
get
Update Custom Endpoint
put
Configuration > endpoints > custom
List Custom endpoints
get
Create Custom endpoint
post
Configuration > endpoints > iax > {iax id}
Delete IAX Endpoint
del
Get IAX Endpoint
get
Update IAX Endpoint
put
Configuration > endpoints > iax
List IAX endpoints
get
Create IAX endpoint
post
Configuration > endpoints > sccp > {sccp id}
Delete SCCP Endpoint
del
Get SCCP Endpoint
get
Update SCCP Endpoint
put
Configuration > endpoints > sccp
List SCCP endpoints
get
Create SCCP endpoint
post
Configuration > endpoints > sip > templates > {template uuid}
Delete SIP Endpoint Template
del
Get SIP Endpoint template
get
Update SIP Endpoint Template
put
Configuration > endpoints > sip > templates
List SIP endpoints templates
get
Create a SIP endpoint template
post
Configuration > endpoints > sip > {sip uuid}
Delete SIP Endpoint
del
Get SIP Endpoint
get
Update SIP Endpoint
put
Configuration > endpoints > sip
List SIP endpoints
get
Create a SIP endpoint
post
Configuration > emails
Get e-mail configuration
get
Update e-mail configuration
put
Configuration > dhcp
Get DHCP configuration
get
Update DHCP configuration
put
Configuration > devices > unallocated
List unallocated devices
get
Assign unallocated device tenant
put
Configuration > devices > {device id}
Delete device
del
Get device
get
Update device
put
Reset device to autoprov
get
List lines associated to device
get
Synchronize device
get
Configuration > devices
List devices
get
Create device
post
Configuration > contexts > {context id}
Delete context
del
Get context
get
Update context
put
Include contexts inside context
put
Configuration > contexts
List contexts
get
Create context
post
Configuration > configuration/live reload
Get live reload status
get
Update live reload status
put
Configuration > conferences > {conference id} > extensions/{extension id}
Dissociate conference and extension
del
Associate conference and extension
put
Configuration > conferences > {conference id}
Delete conference
del
Get conference
get
Update conference
put
Configuration > conferences
List conference
get
Create conference
post
Configuration > callpickups > {callpickup id} > interceptors
Update call pickup and interceptors
put
Update call pickup and interceptors
put
Configuration > callpickups > {callpickup id} > targets
Update call pickup and targets
put
Update call pickup and targets
put
Configuration > callpickups > {callpickup id}
Delete call pickup
del
Get call pickup
get
Update call pickup
put
Configuration > callpickups
List call pickups
get
Create call pickup
post
Configuration > callpermissions > {callpermission id}
Delete call permission
del
Get call permission
get
Update call permission
put
Configuration > callpermissions
List call permissions
get
Create call permission
post
Configuration > callfilters > {callfilter id} > fallbacks
List all fallbacks for call filter
get
Update call filter's fallbacks
put
Configuration > callfilters > {callfilter id}
Delete call filter
del
Get call filter
get
Update call filter
put
Update call filter and recipients
put
Update call filter and surrogates
put
Configuration > callfilters
List call filters
get
Create call filter
post
Configuration > asterisk > confbridge > ytel default bridge
List ConfBridge wazo_default_bridge options
get
Update ConfBridge wazo_default_bridge option
put
Configuration > asterisk > confbridge > ytel default user
List ConfBridge wazo_default_user options
get
Update ConfBridge wazo_default_user option
put
Configuration > asterisk > features > applicationmap
List Features applicationmap options
get
Update Features applicationmap option
put
Configuration > asterisk > features > featuremap
List Features featuremap options
get
Update Features featuremap option
put
Configuration > asterisk > features > general
List Features general options
get
Update Features general option
put
Configuration > asterisk > hep/general
List HEP general options
get
Update HEP general option
put
Configuration > asterisk > iax > callnumberlimits
List IAX callnumberlimits options
get
Update IAX callnumberlimits option
put
Configuration > asterisk > iax > general
List IAX general options
get
Update IAX general option
put
Configuration > asterisk > pjsip > global
List of PJSIP options for the `global` section
get
Update PJSIP section options
put
Configuration > asterisk > pjsip > system
List of PJSIP options for the `system` section
get
Update PJSIP section options
put
Configuration > asterisk > pjsip
List all PJSIP configuration options
get
Configuration > asterisk > queues/general
List Queue general options
get
Update Queue general option
put
Configuration > asterisk > rtp > general
List RTP general options
get
Update RTP general option
put
Configuration > asterisk > rtp > ice host candidates
List RTP ice_host_candidates options
get
Update RTP ice_host_candidates option
put
Configuration > asterisk > sccp/general
List SCCP general options
get
Update SCCP general option
put
Configuration > asterisk > voicemail > general
List Voicemail general options
get
Update Voicemail general option
put
Configuration > asterisk > voicemail > zonemessages
List Voicemail zonemessages options
get
Update Voicemail zonemessages option
put
Configuration > applications
List application
get
Create application
post
Configuration > agents > skills > {skill id}
Delete skill
del
Get skill
get
Update skill
put
Configuration > agents > skills
List skill
get
Create skill
post
Configuration > agents > {agent id} > skills/{skill id}
Dissociate agent and skill
del
Associate agent and skill
put
Configuration > agents > {agent id}
Delete agent
del
Get agent
get
Update agent
put
Call Center Agent > agents
Get the status of all agents.
get
Logoff all agents.
post
Relog all agents.
post
Configuration > agents
Create agent
post
Configuration > access features > {access feature id}
Delete access feature
del
Get access_feature
get
Update access_feature
put
Configuration > access features
List access features
get
Create access_feature
post
Configuration > tenants/{tenant}/phonebooks > {phonebook id} > contacts > {contact id}
Delete an existing contact
del
Get the attributes of a contact
get
Modify an existing contact
put
Configuration > tenants/{tenant}/phonebooks > {phonebook id} > contacts
List all contacts for a given phonebook
get
Create a new contact
post
Import multiple contacts at once
post
Configuration > tenants/{tenant}/phonebooks > {phonebook id}
Delete an existing phonebook
del
Get the attributes of a phonebook
get
Modify an existing phonebook
put
Configuration > tenants/{tenant}/phonebooks
List all phonebooks for a given tenant
get
Create a new phonebook
post
Configuration
List all available timezones
get
Get server info
get
Get one guest meeting
get
Contacts > backends > conference/sources > {source uuid}
Delete a `conference` source configuration
del
Get a `conference` source configuration
get
Update a `conference` source configuration
put
Retrieve all contacts from a conference source
get
Contacts > backends > conference/sources
Get all `conference` source configurations
get
Configure a source for the `conference` backend
post
Contacts > backends > csv/sources > {source uuid}
Delete a `csv` source configuration
del
Get a `csv` source configuration
get
Update a `csv` source configuration
put
Contacts > backends > csv/sources
Get all `csv` source configurations
get
Configure a source for the `csv` backend
post
Contacts > backends > csv ws/sources > {source uuid}
Delete a `csv_ws` source configuration
del
Get a `csv_ws` source configuration
get
Update a `csv_ws` source configuration
put
Contacts > backends > csv ws/sources
Get all `csv_ws` source configurations
get
Configure a source for the `csv_ws` backend
post
Contacts > backends > google/sources > {source uuid}
Delete a `google` source configuration
del
Get a `google` source configuration
get
Update a `google` source configuration
put
Retrieve all contacts from `google`
get
Contacts > backends > google/sources
Get google configuration
get
Configure a source for the google backend
post
Contacts > backends > ldap/sources > {source uuid}
Delete a `ldap` source configuration
del
Get a `ldap` source configuration
get
Update a `ldap` source configuration
put
Contacts > backends > ldap/sources
Get all `ldap` source configurations
get
Configure a source for the `ldap` backend
post
Contacts > backends > office365/sources > {source uuid}
Delete a `microsoft` source configuration
del
Get a `microsoft` source configuration
get
Update a `microsoft` source configuration
put
Retrieve all contacts from `office365`
get
Contacts > backends > office365/sources
Get microsoft configuration
get
Configure a source for the microsoft backend
post
Contacts > backends > personal/sources > {source uuid}
Delete a `personal` source configuration
del
Get a `personal` source configuration
get
Update a `personal` source configuration
put
Contacts > backends > personal/sources
Get all `personal` source configurations
get
Configure a source for the `personal` backend
post
Contacts > backends > phonebook/sources > {source uuid}
Delete a `phonebook` source configuration
del
Get a `phonebook` source configuration
get
Update a `phonebook` source configuration
put
Contacts > backends > phonebook/sources
Get all `phonebook` source configurations
get
Configure a source for the `phonebook` backend
post
Contacts > backends > wazo/sources > {source uuid}
Delete a `wazo` source configuration
del
Get a `wazo` source configuration
get
Update a `wazo` source configuration
put
Retrieve all contacts from `wazo`
get
Contacts > backends > wazo/sources
Get all `wazo` source configurations
get
Configure a source for the `wazo` backend
post
Contacts > directories > favorites > {directory}/{contact}
Unmark a contact as favorite
del
Mark a contact as favorite
put
Contacts > directories > favorites
List favorite contacts
get
Contacts > directories > lookup/{profile}
Search for contacts
get
Lookup headers
get
Search for contacts for a particular user
get
Contacts > directories
List personal contacts with formatting
get
Search for contact by number
get
List all sources configured for the given profile
get
Contacts > displays > {display uuid}
Delete display
del
Get display
get
Update display
put
Contacts > displays
List displays
get
Create a new display configuration
post
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}
Remove personal contact
del
Get personal contact
get
Edit personal contact
put
Contacts > personal
Purge personal contacts
del
List personal contacts
get
Create new personal contact
post
Import multiple personal contacts at once
post
Contacts > profiles > {profile uuid}
Delete a profile configuration
del
Get a profile configuration
get
Update a profile configuration
put
Contacts > profiles
List all configured profiles
get
Create a new configuration profile
post
Contacts
List all loaded services
get
List all configured sources
get
Phone Provisioning > configure > {param id}
Get the configuration parameter value
get
Set the value of a parameter
put
Phone Provisioning > configure
Get the general provd configuration
get
Update the configuration's plugin_server
put
Update the configuration's http_proxy
put
Update the configuration's https_proxy
put
Update the configuration's ftp_proxy
put
Update the configuration's locale
put
Update the configuration's NAT
put
Phone Provisioning > dev mgr > devices > {device id}
Get a device by ID
get
Update a device
put
Delete a device
del
Phone Provisioning > dev mgr > devices
List and find devices
get
Create a device
post
Phone Provisioning > dev mgr > synchronize > {operation id}
Get the status of a synchronize Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > dev mgr > synchronize
Synchronize a device
post
Phone Provisioning > dev mgr
Get the Device Manager resource
get
Reconfigure a device
post
Push DHCP request information
post
Phone Provisioning > cfg mgr > configs > {config id}
Get a configuration
get
Update a configuration
put
Delete a configuration
del
Get a raw configuration
get
Phone Provisioning > cfg mgr > configs
List and find configurations
get
Create a configuration
post
Phone Provisioning > cfg mgr
Get the Config Manager resource
get
Create an autocreate configuration
post
Phone Provisioning > pg mgr > plugins > {plugin id} > install > install > {operation id}
Get the status of a package installation Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > pg mgr > plugins > {plugin id} > install > install
Install a package
post
Phone Provisioning > pg mgr > plugins > {plugin id} > install > upgrade/{operation id}
Get the status of a package upgrade Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > pg mgr > plugins > {plugin id} > install
Get the package installation service resources
get
Uninstall a package
post
Get the installable packages list
get
Get the installed packages list
get
Phone Provisioning > pg mgr > plugins > {plugin id}
Get the resources of a specific plugin
get
Get the information of a plugin
get
Phone Provisioning > pg mgr > plugins
List the installed plugins
get
Phone Provisioning > pg mgr > install > install > {operation id}
Get the status of a plugin installation Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > pg mgr > install > install
Install a plugin
post
Phone Provisioning > pg mgr > install > upgrade > {operation id}
Get the status of a plugin upgrade Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > pg mgr > install > upgrade
Upgrade a plugin
post
Phone Provisioning > pg mgr > install > update > {operation id}
Get the status of a plugin database update Operation In Progress
get
Delete the Operation In Progress
del
Phone Provisioning > pg mgr > install > update
Update the List of installable plugins
post
Phone Provisioning > pg mgr > install
Get the installation service resources
get
Uninstall a plugin
post
Get the installable plugins list
get
Get the installed plugins list
get
Phone Provisioning > pg mgr
Get the Plugin Manager resource
get
Reload a plugin
post
Phone Provisioning
Get the Provd Manager resource
get
Webhooks > subscriptions > {subscription uuid}
Delete a subscription
del
Get a subscription
get
Edit a subscription
put
Get hook logs
get
Webhooks > subscriptions
List subscriptions to HTTP callbacks
get
Subscribe to a HTTP callback (webhook)
post
Show the available subscription services
get
Webhooks > users/me/subscriptions > {subscription uuid}
Delete a user subscription
del
Get a user subscription
get
Webhooks > users/me/subscriptions
List subscriptions of a user to HTTP callbacks
get
Subscribe to a HTTP callback (webhook) as a user
post
Call Detail Records > agents
Statistics for all agents
get
Statistics for a specific agent
get
Call Detail Records > cdr > recordings/media
Delete multiple CDRs recording media
del
Create an export for the recording media of multiple CDRs
post
Call Detail Records > cdr > {cdr id} > recordings/{recording uuid}/media
Delete a recording media
del
Get a recording media
get
Call Detail Records > cdr > {cdr id}
Get a CDR by ID
get
Call Detail Records > cdr
List CDR
get
Call Detail Records > exports/{export uuid}
Get an export by the given UUID
get
Download an export as a ZIP archive by the given UUID
get
Call Detail Records > queues > {queue id}/statistics
Statistics for a specific queue
get
QoS statistics for a specific queue
get
Call Detail Records > queues
Statistics for all queues
get
Call Detail Records > retention
Retention configuration
get
Update retention configuration
put
Call Detail Records > users
List CDR of the authenticated user
get
List CDR of the given user
get
Plugins > market
List plugins available on the configured market
get
Fetch the information about a plugin from the market
get
Plugins > plugins > {namespace}/{name}
Uninstall a plugin
del
Fetch the information about a plugin that has been installed
get
Plugins > plugins
List installed plugins
get
Install a plugin
post
Call Center Agent > agents > by-id/{agent id}
Get agent status.
get
Add agent to a queue.
post
Log an agent.
post
Logoff an agent.
post
Remove agent from a queue.
post
Call Center Agent > agents > by-number/{agent number}
Get agent status.
get
Log an agent.
post
Logoff an agent.
post
Pause an agent.
post
Unpause an agent.
post
Call Center Agent > users/me/agents
Get agent status of the user holding the authentication token.
get
Log the agent of the user holding the authentication token
post
Logoff the agent of the user holding the authentication token
post
Pause the agent of the user holding the authentication token
post
Unpause the agent of the user holding the authentication token
post
Presence and Chat > users > me/rooms > {room uuid}/messages
List room messages
get
Create room messages
post
Presence and Chat > users > me/rooms
Get room
get
Create room
post
List rooms messages
get
Presence and Chat > users > {user uuid}/presences
Get user presence
get
Update user presence
put
Presence and Chat > users
List presences
get
List and find devices
get
http://{{baseurl}}/dev_mgr/devices
Required ACL:
provd.dev_mgr.devices.read
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
http://
baseurl
/dev_mgr/devices
Response
Click
Try It!
to start a request and see the response here!