How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Telephony Providers Edge API

Edge phones, trunks, lines.

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Telephony Providers Edge API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Telephony Providers Edge. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 123 operations across 77 paths, and defines 127 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

123 operations 77 paths 127 schemas 13 DELETE69 GET1 PATCH25 POST15 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Telephony Providers Edge API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 123

Across 77 paths, the API surfaces 123 operations — 13 DELETE, 69 GET, 1 PATCH, 25 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

Telephony Providers Edge 123

Edge phones, trunks, lines.

POST
/api/v2/telephony/providers/edges/addressvalidation
Validates a street address
postTelephonyProvidersEdgesAddressvalidation 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/certificateauthorities
Get the list of certificate authorities.
getTelephonyProvidersEdgesCertificateauthorities → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/certificateauthorities
Create a certificate authority.
postTelephonyProvidersEdgesCertificateauthorities 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Get a certificate authority.
getTelephonyProvidersEdgesCertificateauthority 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Update a certificate authority.
putTelephonyProvidersEdgesCertificateauthority 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}
Delete a certificate authority.
deleteTelephonyProvidersEdgesCertificateauthority 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping
Get networking-related information from an Edge for a target IP or host.
getTelephonyProvidersEdgeDiagnosticPing 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping
Ping Request command to collect networking-related information from an Edge for a target IP or host.
postTelephonyProvidersEdgeDiagnosticPing 2 params → 202400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath
Get networking-related information from an Edge for a target IP or host.
getTelephonyProvidersEdgeDiagnosticTracepath 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath
Tracepath request command to collect networking-related information from an Edge for a target IP or host.
postTelephonyProvidersEdgeDiagnosticTracepath 2 params → 202400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup
Get networking-related information from an Edge for a target IP or host.
getTelephonyProvidersEdgeDiagnosticNslookup 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup
Nslookup request command to collect networking-related information from an Edge for a target IP or host.
postTelephonyProvidersEdgeDiagnosticNslookup 2 params → 202400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route
Get networking-related information from an Edge for a target IP or host.
getTelephonyProvidersEdgeDiagnosticRoute 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route
Route request command to collect networking-related information from an Edge for a target IP or host.
postTelephonyProvidersEdgeDiagnosticRoute 2 params → 202400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/reboot
Reboot an Edge
postTelephonyProvidersEdgeReboot 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}
Get edge.
getTelephonyProvidersEdge 2 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/{edgeId}
Update a edge.
putTelephonyProvidersEdge 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/{edgeId}
Delete a edge.
deleteTelephonyProvidersEdge 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/statuscode
Take an Edge in or out of service
postTelephonyProvidersEdgeStatuscode 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Gets software update status information about any edge.
getTelephonyProvidersEdgeSoftwareupdate 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Starts a software update for this edge.
postTelephonyProvidersEdgeSoftwareupdate 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/{edgeId}/softwareupdate
Cancels any in-progress update for this edge.
deleteTelephonyProvidersEdgeSoftwareupdate 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/softwareversions
Gets all the available software versions for this edge.
getTelephonyProvidersEdgeSoftwareversions 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/timezones
Get a list of Edge-compatible time zones
getTelephonyProvidersEdgesTimezones 2 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/unpair
Unpair an Edge
postTelephonyProvidersEdgeUnpair 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/edgeversionreport
Get the edge version report.
getTelephonyProvidersEdgesEdgeversionreport → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/logicalinterfaces
Get edge logical interfaces.
getTelephonyProvidersEdgesLogicalinterfaces 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/physicalinterfaces
Get physical interfaces for edges.
getTelephonyProvidersEdgesPhysicalinterfaces 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges
Get the list of edges.
getTelephonyProvidersEdges 8 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges
Create an edge.
postTelephonyProvidersEdges 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Get an edge logical interface
getTelephonyProvidersEdgeLogicalinterface 3 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Update an edge logical interface.
putTelephonyProvidersEdgeLogicalinterface 3 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}
Delete an edge logical interface
deleteTelephonyProvidersEdgeLogicalinterface 2 params → default400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
Get edge logical interfaces.
getTelephonyProvidersEdgeLogicalinterfaces 2 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
Create an edge logical interface.
postTelephonyProvidersEdgeLogicalinterfaces 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}
Get edge physical interface.
getTelephonyProvidersEdgePhysicalinterface 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces
Retrieve a list of all configured physical interfaces from a specific edge.
getTelephonyProvidersEdgePhysicalinterfaces 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/alertablepresences
Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.
getTelephonyProvidersEdgesAlertablepresences 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/alertablepresences
Creates or updates alertable presences overrides.
putTelephonyProvidersEdgesAlertablepresences 1 param → 202400401403404408409413
DELETE
/api/v2/telephony/providers/edges/alertablepresences
Deletes alertable presences overrides.
deleteTelephonyProvidersEdgesAlertablepresences → 202400401403404408409413
GET
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Get a DID Pool by ID.
getTelephonyProvidersEdgesDidpool 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Update a DID Pool by ID.
putTelephonyProvidersEdgesDidpool 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Delete a DID Pool by ID.
deleteTelephonyProvidersEdgesDidpool 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/didpools/dids
Get a listing of unassigned and/or assigned numbers in a set of DID Pools.
getTelephonyProvidersEdgesDidpoolsDids 6 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/didpools
Get a listing of DID Pools
getTelephonyProvidersEdgesDidpools 4 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/didpools
Create a new DID pool
postTelephonyProvidersEdgesDidpools 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/dids/{didId}
Get a DID by ID.
getTelephonyProvidersEdgesDid 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/dids
Get a listing of DIDs
getTelephonyProvidersEdgesDids 8 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Get edge group.
getTelephonyProvidersEdgesEdgegroup 2 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Update an edge group.
putTelephonyProvidersEdgesEdgegroup 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Delete an edge group.
deleteTelephonyProvidersEdgesEdgegroup 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
Gets the edge trunk base associated with the edge group
getTelephonyProvidersEdgesEdgegroupEdgetrunkbase 2 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}
Update the edge trunk base associated with the edge group
putTelephonyProvidersEdgesEdgegroupEdgetrunkbase 3 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/edgegroups
Get the list of edge groups.
getTelephonyProvidersEdgesEdgegroups 5 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/edgegroups
Create an edge group.
postTelephonyProvidersEdgesEdgegroups 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Get an extension pool by ID
getTelephonyProvidersEdgesExtensionpool 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Update an extension pool by ID
putTelephonyProvidersEdgesExtensionpool 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}
Delete an extension pool by ID
deleteTelephonyProvidersEdgesExtensionpool 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/extensionpools/divisionviews
Get a pageable list of basic extension pool objects filterable by query parameters.
getTelephonyProvidersEdgesExtensionpoolsDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/extensionpools
Get a listing of extension pools
getTelephonyProvidersEdgesExtensionpools 5 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/extensionpools
Create a new extension pool
postTelephonyProvidersEdgesExtensionpools 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/extensions/{extensionId}
Get an extension by ID.
getTelephonyProvidersEdgesExtension 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/extensions
Get a listing of extensions
getTelephonyProvidersEdgesExtensions 5 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}
Get a line base settings object by ID
getTelephonyProvidersEdgesLinebasesetting 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/linebasesettings
Get a listing of line base settings objects
getTelephonyProvidersEdgesLinebasesettings 5 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/lines/{lineId}
Get a Line by ID
getTelephonyProvidersEdgesLine 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/lines
Get a list of Lines
getTelephonyProvidersEdgesLines 5 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/lines/template
Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
getTelephonyProvidersEdgesLinesTemplate 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}
Get an Edge logs job.
getTelephonyProvidersEdgeLogsJob 2 params → 202200400401403404408409
POST
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload
Request that the specified fileIds be uploaded from the Edge.
postTelephonyProvidersEdgeLogsJobUpload 3 params → 202400401403404408409413
POST
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs
Create a job to upload a list of Edge logs.
postTelephonyProvidersEdgeLogsJobs 2 params → 202400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/metrics
Get the edge metrics.
getTelephonyProvidersEdgeMetrics 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/metrics
Get the metrics for a list of edges.
getTelephonyProvidersEdgesMetrics 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications
Get a list of Classifications for this Site
getTelephonyProvidersEdgesSiteNumberplansClassifications 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}
Get a Number Plan by ID.
getTelephonyProvidersEdgesSiteNumberplan 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans
Get the list of Number Plans for this Site. Only fetches the first 200 records.
getTelephonyProvidersEdgesSiteNumberplans 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans
Update the list of Number Plans. A user can update maximum 200 number plans at a time.
putTelephonyProvidersEdgesSiteNumberplans 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/outboundroutes
Get outbound routes
getTelephonyProvidersEdgesOutboundroutes 6 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phonebasesettings/template
Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance
getTelephonyProvidersEdgesPhonebasesettingsTemplate 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Get a Phone Base Settings object by ID
getTelephonyProvidersEdgesPhonebasesetting 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Update a Phone Base Settings by ID
putTelephonyProvidersEdgesPhonebasesetting 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}
Delete a Phone Base Settings by ID
deleteTelephonyProvidersEdgesPhonebasesetting 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phonebasesettings
Get a list of Phone Base Settings objects
getTelephonyProvidersEdgesPhonebasesettings 6 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/phonebasesettings
Create a new Phone Base Settings object
postTelephonyProvidersEdgesPhonebasesettings 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases
Get a list of available makes and models to create a new Phone Base Settings
getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phones/template
Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance
getTelephonyProvidersEdgesPhonesTemplate 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phones/{phoneId}
Get a Phone by ID
getTelephonyProvidersEdgesPhone 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/phones/{phoneId}
Update a Phone by ID
putTelephonyProvidersEdgesPhone 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/phones/{phoneId}
Delete a Phone by ID
deleteTelephonyProvidersEdgesPhone 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/phones
Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supp…
getTelephonyProvidersEdgesPhones 17 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/phones
Create a new Phone
postTelephonyProvidersEdgesPhones 1 param → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/phones/{phoneId}/reboot
Reboot a Phone
postTelephonyProvidersEdgesPhoneReboot 1 param → default400401403404408409413
POST
/api/v2/telephony/providers/edges/phones/reboot
Reboot Multiple Phones
postTelephonyProvidersEdgesPhonesReboot 1 param → default400401403404408409413
GET
/api/v2/telephony/providers/edges/expired
List of edges more than 4 edge versions behind the latest software.
getTelephonyProvidersEdgesExpired → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Get site connections for a site.
getTelephonyProvidersEdgesSiteSiteconnections 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Update site connections for a site.
putTelephonyProvidersEdgesSiteSiteconnections 2 params → 200400401403404408409413
PATCH
/api/v2/telephony/providers/edges/sites/{siteId}/siteconnections
Disable site connections for a site.
patchTelephonyProvidersEdgesSiteSiteconnections 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}
Get a Site by ID.
getTelephonyProvidersEdgesSite 1 param → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/sites/{siteId}
Update a Site by ID.
putTelephonyProvidersEdgesSite 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/sites/{siteId}
Delete a Site by ID
deleteTelephonyProvidersEdgesSite 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites
Get the list of Sites.
getTelephonyProvidersEdgesSites 8 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/sites
Create a Site.
postTelephonyProvidersEdgesSites 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/search
Search sites using the q64 value returned from a previous search
getTelephonyProvidersEdgesSitesSearch 2 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/sites/search
Search sites
postTelephonyProvidersEdgesSitesSearch 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Get an outbound route
getTelephonyProvidersEdgesSiteOutboundroute 2 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Update outbound route
putTelephonyProvidersEdgesSiteOutboundroute 3 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}
Delete Outbound Route
deleteTelephonyProvidersEdgesSiteOutboundroute 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
Get outbound routes
getTelephonyProvidersEdgesSiteOutboundroutes 6 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
Create outbound route
postTelephonyProvidersEdgesSiteOutboundroutes 2 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics
Get the trunk metrics.
getTelephonyProvidersEdgesTrunkMetrics 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunks/metrics
Get the metrics for a list of trunks.
getTelephonyProvidersEdgesTrunksMetrics 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunkbasesettings/template
Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
getTelephonyProvidersEdgesTrunkbasesettingsTemplate 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Get a Trunk Base Settings object by ID
getTelephonyProvidersEdgesTrunkbasesetting 2 params → 200400401403404408409413
PUT
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Update a Trunk Base Settings object by ID
putTelephonyProvidersEdgesTrunkbasesetting 2 params → 200400401403404408409413
DELETE
/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}
Delete a Trunk Base Settings object by ID
deleteTelephonyProvidersEdgesTrunkbasesetting 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunkbasesettings
Get Trunk Base Settings listing
getTelephonyProvidersEdgesTrunkbasesettings 9 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/trunkbasesettings
Create a Trunk Base Settings object
postTelephonyProvidersEdgesTrunkbasesettings 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases
Get a list of available makes and models to create a new Trunk Base Settings
getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases 3 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunkswithrecording
Get Counts of trunks that have recording disabled or enabled
getTelephonyProvidersEdgesTrunkswithrecording 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/trunks
Get the list of available trunks for the given Edge.
getTelephonyProvidersEdgeTrunks 7 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunks/{trunkId}
Get a Trunk by ID
getTelephonyProvidersEdgesTrunk 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/trunks
Get the list of available trunks.
getTelephonyProvidersEdgesTrunks 7 params → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/{edgeId}/setuppackage
Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.
getTelephonyProvidersEdgeSetuppackage 1 param → 200400401403404408409413

Schemas 127

The contract defines 127 schemas that model the data the API accepts and returns. The most detailed are Edge (43 properties), DomainLogicalInterface (42 properties), Site (31 properties), Trunk (29 properties). Each schema is shown below with its type and property counts.

DomainCertificateAuthority
object
A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device.
17 properties 4 required
Line
object
22 properties 1 required
AddressableEntityRef
object
2 properties
TrunkMetricsNetworkTypeIp
object
2 properties
PhoneEntityListing
object
11 properties
SiteConnection
object
11 properties
EdgeMetricsSubsystem
object
3 properties
DIDPoolEntityListing
object
11 properties
EdgeNetworkDiagnosticRequest
object
1 property 1 required
DomainLogicalInterface
object
42 properties 4 required
SitesSearchResponse
object
9 properties 6 required
TrunkEntityListing
object
11 properties
ValidateAddressResponse
object
2 properties 1 required
EdgeMetrics
object
8 properties
EdgeTrunkBase
object
18 properties 3 required
LocationAddressVerificationDetails
object
4 properties
CertificateDetails
object
Represents the details of a parsed certificate.
7 properties
PhysicalInterfaceEntityListing
object
10 properties
PhoneCapabilities
object
9 properties
NTPSettings
object
1 property
EdgeEntityListing
object
11 properties
NumberPlan
object
20 properties 1 required
EdgeServiceStateRequest
object
2 properties 1 required
TrunkErrorInfo
object
3 properties
SiteSearchCriteria
object
9 properties 1 required
EdgeAutoUpdateConfig
object
4 properties 4 required
DID
object
17 properties 1 required
TrunkBaseEntityListing
object
11 properties
DIDNumberEntityListing
object
10 properties
ExtensionEntityListing
object
11 properties
Site
object
31 properties 2 required
EdgeNetworkDiagnosticResponse
object
2 properties
EdgeConnectionInfo
object
7 properties
ErrorDetails
object
8 properties
DomainEdgeSoftwareUpdateDto
object
10 properties 1 required
EdgeMetricsNetwork
object
5 properties
RegionTimeZone
object
5 properties
Metabase
object
14 properties 1 required
ExpiredEdgeListing
object
1 property
TrunkConnectedStatus
object
2 properties
SubscriberResponse
object
2 properties 1 required
Trunk
object
29 properties 1 required
EdgeNetworkDiagnostic
object
2 properties
ProvisionInfo
object
3 properties
DigitLength
object
2 properties
DomainEntityRef
object
3 properties
DomainCapabilities
object
6 properties
PhoneMetaBaseEntityListing
object
11 properties
EdgeMetricsProcessor
object
5 properties
ExtensionPoolEntityListing
object
11 properties
CertificateAuthorityEntityListing
object
10 properties
UserAgentInfo
object
3 properties
PhoneBase
object
17 properties 3 required
DIDNumber
object
Represents an unassigned or assigned DID in a DID Pool.
8 properties
TimeZoneEntityListing
object
10 properties
SearchSort
object
2 properties
StreetAddress
object
8 properties 6 required
TrunkMetricsRegisters
object
4 properties
ConnectedEdge
object
6 properties
Detail
object
4 properties
TrunkMetrics
object
5 properties
EdgeInterface
object
8 properties
Extension
object
17 properties 1 required
DomainEdgeSoftwareVersionDto
object
8 properties
AlertablePresences
object
1 property 1 required
EdgeVersionReport
object
2 properties
TrunkMetricsCalls
object
2 properties
DIDEntityListing
object
11 properties
TrunkMetricsQoS
object
1 property 1 required
LocationEmergencyNumber
object
3 properties
DomainPhysicalInterface
object
18 properties 1 required
EdgeLogsJobRequest
object
3 properties
EdgeVersionInformation
object
1 property
MetaData
object
3 properties
OutboundRoute
object
19 properties 2 required
ExtensionPoolDivisionViewEntityListing
object
11 properties
Edge
object
43 properties 1 required
EdgeGroupEntityListing
object
11 properties
OutboundRouteBase
object
17 properties 2 required
SiteSearchRequest
object
7 properties
EdgeRebootParameters
object
1 property
TrunkMetricsOptions
object
4 properties
DomainNetworkAddress
object
4 properties
OutboundRouteBaseEntityListing
object
11 properties
DIDPool
object
17 properties 3 required
Limit
object
3 properties
PhoneStatus
object
9 properties
SiteEntityListing
object
11 properties
ValidateAddressRequest
object
1 property
EdgeLogsJobUploadRequest
object
1 property 1 required
DomainPhysicalCapabilities
object
2 properties
EdgeMetricsMemory
object
3 properties
Contact
object
7 properties
LocationDefinition
object
16 properties
ExtensionPool
object
15 properties 1 required
OutboundRouteEntityListing
object
11 properties
EdgeLogsJobResponse
object
13 properties 1 required
LineEntityListing
object
11 properties
ExtensionPoolDivisionView
object
4 properties 1 required
EdgeMetricsDisk
object
3 properties
TrunkErrorInfoDetails
object
3 properties
EdgeLogsJobFile
object
19 properties 1 required
TrunkBaseAssignment
object
2 properties
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
Number
object
2 properties
EdgeGroup
object
17 properties 3 required
LineStatus
object
5 properties
LineBase
object
15 properties 1 required
Phone
object
27 properties 4 required
DomainNetworkCommandResponse
object
4 properties
TrunkMetabaseEntityListing
object
11 properties
DisableSiteConnectionsRequest
object
1 property
DomainNetworkRoute
object
5 properties
PhonesReboot
object
2 properties
LineBaseEntityListing
object
11 properties
PhoneBaseSettings
object
3 properties 1 required
EdgeLogsJob
object
14 properties 1 required
PhoneBaseEntityListing
object
11 properties
DomainEdgeSoftwareVersionDtoEntityListing
object
10 properties
SiteConnections
object
4 properties
LocationAddress
object
7 properties
LogicalInterfaceEntityListing
object
10 properties
TrunkRecordingEnabledCount
object
2 properties
TrunkBase
object
19 properties 3 required
VmPairingInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-telephony-providers-edge-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Telephony Providers Edge
← Back to G APIs
API Details
ID
genesys:genesys-telephony-providers-edge-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-telephony-providers-edge-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-telephony-providers-edge-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys Telephony Providers Edge API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.