Genesys Telephony Providers Edge API
Edge phones, trunks, lines.
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 3.2.0, at version v2.
Requests are made against a single 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.
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
GET
/api/v2/telephony/providers/edges/certificateauthorities
Get the list of certificate authorities
POST
/api/v2/telephony/providers/edges/certificateauthorities
Create a certificate authority
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…
POST
/api/v2/telephony/providers/edges/{edgeId}/reboot
Reboot an Edge
GET
/api/v2/telephony/providers/edges/{edgeId}
Get edge
PUT
/api/v2/telephony/providers/edges/{edgeId}
Update a edge
DELETE
/api/v2/telephony/providers/edges/{edgeId}
Delete a edge
POST
/api/v2/telephony/providers/edges/{edgeId}/statuscode
Take an Edge in or out of service
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/timezones
Get a list of Edge-compatible time zones
POST
/api/v2/telephony/providers/edges/{edgeId}/unpair
Unpair an Edge
GET
/api/v2/telephony/providers/edges/edgeversionreport
Get the edge version report
GET
/api/v2/telephony/providers/edges/logicalinterfaces
Get edge logical interfaces
GET
/api/v2/telephony/providers/edges/physicalinterfaces
Get physical interfaces for edges
GET
/api/v2/telephony/providers/edges
Get the list of edges
POST
/api/v2/telephony/providers/edges
Create an 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
GET
/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces
Get edge logical interfaces
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
GET
/api/v2/telephony/providers/edges/alertablepresences
Get the list alertable presences.
PUT
/api/v2/telephony/providers/edges/alertablepresences
Creates or updates alertable presences overrides
DELETE
/api/v2/telephony/providers/edges/alertablepresences
Deletes alertable presences overrides
GET
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Get a DID Pool by ID
PUT
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Update a DID Pool by ID
DELETE
/api/v2/telephony/providers/edges/didpools/{didPoolId}
Delete a DID Pool by ID
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/didpools
Get a listing of DID Pools
POST
/api/v2/telephony/providers/edges/didpools
Create a new DID pool
GET
/api/v2/telephony/providers/edges/dids/{didId}
Get a DID by ID
GET
/api/v2/telephony/providers/edges/dids
Get a listing of DIDs
GET
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Get edge group
PUT
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Update an edge group
DELETE
/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}
Delete an edge group
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/edgegroups
Get the list of edge groups
POST
/api/v2/telephony/providers/edges/edgegroups
Create an 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/extensionpools
Get a listing of extension pools
POST
/api/v2/telephony/providers/edges/extensionpools
Create a new extension pool
GET
/api/v2/telephony/providers/edges/extensions/{extensionId}
Get an extension by ID
GET
/api/v2/telephony/providers/edges/extensions
Get a listing of extensions
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/{lineId}
Get a Line by ID
GET
/api/v2/telephony/providers/edges/lines
Get a list of Lines
GET
/api/v2/telephony/providers/edges/lines/template
Get a Line instance template based on a Line Base Settings object.
GET
/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}
Get an Edge logs job
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/{edgeId}/metrics
Get the edge metrics
GET
/api/v2/telephony/providers/edges/metrics
Get the metrics for a list of edges
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
PUT
/api/v2/telephony/providers/edges/sites/{siteId}/numberplans
Update the list of Number Plans.
GET
/api/v2/telephony/providers/edges/outboundroutes
Get outbound routes
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
Get a list of Phone Base Settings objects
POST
/api/v2/telephony/providers/edges/phonebasesettings
Create a new Phone Base Settings object
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/phones/{phoneId}
Get a Phone by ID
PUT
/api/v2/telephony/providers/edges/phones/{phoneId}
Update a Phone by ID
DELETE
/api/v2/telephony/providers/edges/phones/{phoneId}
Delete a Phone by ID
GET
/api/v2/telephony/providers/edges/phones
Get a list of Phone Instances.
POST
/api/v2/telephony/providers/edges/phones
Create a new Phone
POST
/api/v2/telephony/providers/edges/phones/{phoneId}/reboot
Reboot a Phone
POST
/api/v2/telephony/providers/edges/phones/reboot
Reboot Multiple Phones
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/{siteId}
Get a Site by ID
PUT
/api/v2/telephony/providers/edges/sites/{siteId}
Update a Site by ID
DELETE
/api/v2/telephony/providers/edges/sites/{siteId}
Delete a Site by ID
GET
/api/v2/telephony/providers/edges/sites
Get the list of Sites
POST
/api/v2/telephony/providers/edges/sites
Create a Site
GET
/api/v2/telephony/providers/edges/sites/search
Search sites using the q64 value returned from a previous search
POST
/api/v2/telephony/providers/edges/sites/search
Search sites
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/sites/{siteId}/outboundroutes
Get outbound routes
POST
/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes
Create outbound route
GET
/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics
Get the trunk metrics
GET
/api/v2/telephony/providers/edges/trunks/metrics
Get the metrics for a list of trunks
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
Get Trunk Base Settings listing
POST
/api/v2/telephony/providers/edges/trunkbasesettings
Create a Trunk Base Settings object
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/trunks/{trunkId}
Get a Trunk by ID
GET
/api/v2/telephony/providers/edges/trunks
Get the list of available trunks
GET
/api/v2/telephony/providers/edges/{edgeId}/setuppackage
Get the setup package for a locally deployed edge device.
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.
OutboundRouteBase
object
17 properties
2 required
TrunkEntityListing
object
11 properties
Number
object
2 properties
EdgeTrunkBase
object
18 properties
3 required
AddressableEntityRef
object
2 properties
OutboundRouteBaseEntityListing
object
11 properties
DomainPhysicalCapabilities
object
2 properties
Line
object
22 properties
1 required
DomainEntityRef
object
3 properties
PhysicalInterfaceEntityListing
object
10 properties
TrunkRecordingEnabledCount
object
2 properties
DIDNumber
object
Represents an unassigned or assigned DID in a DID Pool.
8 properties
LineBase
object
15 properties
1 required
Detail
object
4 properties
DIDPoolEntityListing
object
11 properties
PhonesReboot
object
2 properties
LogicalInterfaceEntityListing
object
10 properties
LocationImage
object
2 properties
ExtensionPoolDivisionViewEntityListing
object
11 properties
SitesSearchResponse
object
9 properties
6 required
EdgeGroupEntityListing
object
11 properties
TrunkMetricsQoS
object
1 property
1 required
ExtensionPool
object
15 properties
1 required
EdgeMetricsDisk
object
3 properties
DIDPool
object
17 properties
3 required
Trunk
object
29 properties
1 required
DIDEntityListing
object
11 properties
DomainNetworkAddress
object
4 properties
CertificateDetails
object
Represents the details of a parsed certificate.
7 properties
LineStatus
object
5 properties
EdgeVersionReport
object
2 properties
EdgeVersionInformation
object
1 property
LocationEmergencyNumber
object
3 properties
DIDNumberEntityListing
object
10 properties
DomainEdgeSoftwareUpdateDto
object
10 properties
1 required
TrunkMetricsOptions
object
4 properties
PhoneBaseSettings
object
3 properties
1 required
EdgeAutoUpdateConfig
object
4 properties
4 required
EdgeLogsJobRequest
object
3 properties
StreetAddress
object
8 properties
6 required
TrunkBaseEntityListing
object
11 properties
EdgeLogsJobFile
object
19 properties
1 required
LineBaseEntityListing
object
11 properties
PhoneBase
object
17 properties
3 required
LocationAddressVerificationDetails
object
4 properties
DomainNetworkRoute
object
5 properties
TrunkMetabaseEntityListing
object
11 properties
PhoneMetaBaseEntityListing
object
11 properties
ConnectedEdge
object
6 properties
EdgeMetricsProcessor
object
5 properties
CertificateAuthorityEntityListing
object
10 properties
DID
object
17 properties
1 required
TrunkErrorInfoDetails
object
3 properties
EdgeLogsJob
object
14 properties
1 required
ExtensionEntityListing
object
11 properties
Extension
object
17 properties
1 required
ErrorBody
object
11 properties
DomainCapabilities
object
6 properties
EdgeNetworkDiagnosticRequest
object
1 property
1 required
Metabase
object
14 properties
1 required
TrunkMetricsRegisters
object
4 properties
SiteSearchCriteria
object
9 properties
1 required
EdgeMetricsMemory
object
3 properties
EdgeServiceStateRequest
object
2 properties
1 required
PhoneStatus
object
9 properties
ExpiredEdgeListing
object
1 property
PhoneBaseEntityListing
object
11 properties
DomainLogicalInterface
object
42 properties
4 required
DomainNetworkCommandResponse
object
4 properties
Site
object
31 properties
2 required
SiteConnection
object
11 properties
ValidateAddressRequest
object
1 property
EdgeNetworkDiagnosticResponse
object
2 properties
SiteEntityListing
object
11 properties
TrunkMetrics
object
5 properties
TrunkErrorInfo
object
3 properties
EdgeLogsJobUploadRequest
object
1 property
1 required
ExtensionPoolDivisionView
object
4 properties
1 required
AlertablePresences
object
1 property
1 required
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
LocationDefinition
object
16 properties
DigitLength
object
2 properties
DomainPhysicalInterface
object
18 properties
1 required
EdgeMetricsSubsystem
object
3 properties
DomainEdgeSoftwareVersionDtoEntityListing
object
10 properties
NTPSettings
object
1 property
Division
object
3 properties
ProvisionInfo
object
3 properties
LocationAddress
object
7 properties
SiteSearchRequest
object
7 properties
Limit
object
3 properties
ExtensionPoolEntityListing
object
11 properties
TimeZoneEntityListing
object
10 properties
SubscriberResponse
object
2 properties
1 required
TrunkBaseAssignment
object
2 properties
EdgeEntityListing
object
11 properties
NumberPlan
object
20 properties
1 required
TrunkConnectedStatus
object
2 properties
ErrorDetails
object
8 properties
EdgeConnectionInfo
object
7 properties
Edge
object
43 properties
1 required
TrunkMetricsNetworkTypeIp
object
2 properties
ValidateAddressResponse
object
2 properties
1 required
OutboundRoute
object
19 properties
2 required
EdgeGroup
object
17 properties
3 required
SearchSort
object
2 properties
PhoneCapabilities
object
9 properties
EdgeLogsJobResponse
object
13 properties
1 required
DomainEdgeSoftwareVersionDto
object
8 properties
Contact
object
7 properties
TrunkMetricsCalls
object
2 properties
RegionTimeZone
object
5 properties
EdgeInterface
object
8 properties
TrunkBase
object
19 properties
3 required
LineEntityListing
object
11 properties
SiteConnections
object
4 properties
OutboundRouteEntityListing
object
11 properties
EdgeNetworkDiagnostic
object
2 properties
EdgeRebootParameters
object
1 property
Phone
object
27 properties
4 required
UserAgentInfo
object
3 properties
MetaData
object
3 properties
EdgeMetricsNetwork
object
5 properties
EdgeMetrics
object
8 properties
DisableSiteConnectionsRequest
object
1 property
PhoneEntityListing
object
11 properties
VmPairingInfo
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Genesys 12
Other APIs Genesys publishes across the network.
Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
#Telephony Providers Edge
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.