Genesys

Genesys Telephony Providers Edge API

Edge phones, trunks, lines.

GitHub OpenAPI

Operations 123

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. #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-telephony-providers-edge-api-openapi.yml

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys:genesys-telephony-providers-edge-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

genesys-telephony-providers-edge-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Telephony Providers Edge API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (1048 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-telephony-providers-edge-api-openapi.yml