Genesys Telephony Providers Edge API
Edge phones, trunks, lines.
Operations 123
GET
/api/v2/telephony/providers/edges/certificateauthorities
Get the list of certificate authorities
#
GET
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Get a certificate authority
#
PUT
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Update a certificate authority
#
DELETE
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Delete a certificate authority
#
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping
Get networking-related information from an Edge for a target IP or host
#
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping
Ping Request command to collect networking-related information from an Edge for…
#
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath
Get networking-related information from an Edge for a target IP or host
#
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath
Tracepath request command to collect networking-related information from an…
#
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup
Get networking-related information from an Edge for a target IP or host
#
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup
Nslookup request command to collect networking-related information from an Edge…
#
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route
Get networking-related information from an Edge for a target IP or host
#
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route
Route request command to collect networking-related information from an Edge…
#
GET
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Gets software update status information about any edge
#
POST
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Starts a software update for this edge
#
DELETE
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Cancels any in-progress update for this edge
#
GET
/api/v2/telephony/providers/edges/{edgeId}/softwareversions
Gets all the available software versions for this edge
#
GET
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Get an edge logical interface
#
PUT
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Update an edge logical interface
#
DELETE
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Delete an edge logical interface
#
POST
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
Create an edge logical interface
#
GET
/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}
Get edge physical interface
#
GET
/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces
Retrieve a list of all configured physical interfaces from a specific edge
#
PUT
/api/v2/telephony/providers/edges/alertablepresences
Creates or updates alertable presences overrides
#
GET
/api/v2/telephony/providers/edges/didpools/dids
Get a listing of unassigned and/or assigned numbers in a set of DID Pools
#
GET
/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
Gets the edge trunk base associated with the edge group
#
PUT
/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
Update the edge trunk base associated with the edge group
#
GET
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Get an extension pool by ID
#
PUT
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Update an extension pool by ID
#
DELETE
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Delete an extension pool by ID
#
GET
/api/v2/telephony/providers/edges/extensionpools/divisionviews
Get a pageable list of basic extension pool objects filterable by query…
#
GET
/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}
Get a line base settings object by ID
#
GET
/api/v2/telephony/providers/edges/linebasesettings
Get a listing of line base settings objects
#
GET
/api/v2/telephony/providers/edges/lines/template
Get a Line instance template based on a Line Base Settings object.
#
POST
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload
Request that the specified fileIds be uploaded from the Edge
#
POST
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs
Create a job to upload a list of Edge logs
#
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications
Get a list of Classifications for this Site
#
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}
Get a Number Plan by ID
#
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans
Get the list of Number Plans for this Site. Only fetches the first 200 records
#
GET
/api/v2/telephony/providers/edges/phonebasesettings/template
Get a Phone Base Settings instance template from a given make and model.
#
GET
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Get a Phone Base Settings object by ID
#
PUT
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Update a Phone Base Settings by ID
#
DELETE
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Delete a Phone Base Settings by ID
#
GET
/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases
Get a list of available makes and models to create a new Phone Base Settings
#
GET
/api/v2/telephony/providers/edges/phones/template
Get a Phone instance template based on a Phone Base Settings object.
#
GET
/api/v2/telephony/providers/edges/expired
List of edges more than 4 edge versions behind the latest software
#
GET
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Get site connections for a site
#
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Update site connections for a site
#
PATCH
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Disable site connections for a site
#
GET
/api/v2/telephony/providers/edges/sites/search
Search sites using the q64 value returned from a previous search
#
GET
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Get an outbound route
#
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Update outbound route
#
DELETE
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Delete Outbound Route
#
GET
/api/v2/telephony/providers/edges/trunkbasesettings/template
Get a Trunk Base Settings instance template from a given make and model.
#
GET
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Get a Trunk Base Settings object by ID
#
PUT
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Update a Trunk Base Settings object by ID
#
DELETE
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Delete a Trunk Base Settings object by ID
#
GET
/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases
Get a list of available makes and models to create a new Trunk Base Settings
#
GET
/api/v2/telephony/providers/edges/trunkswithrecording
Get Counts of trunks that have recording disabled or enabled
#
GET
/api/v2/telephony/providers/edges/{edgeId}/trunks
Get the list of available trunks for the given Edge
#
GET
/api/v2/telephony/providers/edges/{edgeId}/setuppackage
Get the setup package for a locally deployed edge device.
#
Documentation
Specifications
Other Resources
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml