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 API

Telephony providers and configuration

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Telephony 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. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 22 operations across 17 paths, and defines 68 schemas. It is described by OpenAPI 2.0, at version v2.

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

22 operations 17 paths 68 schemas 1 DELETE12 GET1 PATCH5 POST3 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 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 22

Across 17 paths, the API surfaces 22 operations — 1 DELETE, 12 GET, 1 PATCH, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Telephony 22

Telephony providers and configuration

GET
/api/v2/telephony/mediaregions
Retrieve the list of AWS regions media can stream through.
getTelephonyMediaregions → 200400401403404408409413
GET
/api/v2/telephony/settings
Get the global telephony configuration.
getTelephonySettings → 200400401403404408409413
PUT
/api/v2/telephony/settings
Update the global telephony configuration.
putTelephonySettings 1 param → 200400401403404408409413
GET
/api/v2/telephony/agents/{agentId}/greetings
Get an agent's greetings.
getTelephonyAgentGreetings 1 param → 200400401403404408409413
PUT
/api/v2/telephony/agents/{agentId}/greetings
Updates an agent's greetings.
putTelephonyAgentGreetings 2 params → 200400401403404408409413
GET
/api/v2/telephony/agents/greetings/me
Get the agent's own greetings.
getTelephonyAgentsGreetingsMe → 200400401403404408409413
PUT
/api/v2/telephony/agents/greetings/me
Updates the agent's own greetings.
putTelephonyAgentsGreetingsMe 1 param → 200400401403404408409413
POST
/api/v2/telephony/numbers/routing/all
Re-route all numbers on an organization
postTelephonyNumbersRoutingAll 1 param → 204400401403404408409413
GET
/api/v2/telephony/numbers/routing
Get Number Routings by organizationId
getTelephonyNumbersRouting 7 params → 200400401403404408409413
POST
/api/v2/telephony/numbers/routing
Update the routing of numbers for one or multiple organizations
postTelephonyNumbersRouting 1 param → 204400401403404408409413
POST
/api/v2/telephony/numbers/routing/reset
Reset routing for organization
postTelephonyNumbersRoutingReset 1 param → 204400401403404408409413
GET
/api/v2/telephony/organization/link
Get organization links
getTelephonyOrganizationLink → 200400401403404408409413
POST
/api/v2/telephony/organization/link
Create a link with an organization
postTelephonyOrganizationLink 1 param → 200400401403404408409413
DELETE
/api/v2/telephony/organization/link/{targetOrganizationId}
Delete a link
deleteTelephonyOrganizationLinkTargetOrganizationId 1 param → 204400401403404408409413
PATCH
/api/v2/telephony/organization/link/approve/{requestingOrganizationId}
Approving a requested link
patchTelephonyOrganizationLinkApproveRequestingOrganizationId 2 params → 204400401403404408409413
GET
/api/v2/telephony/organization/link/regions
Get all the replica regions by primary region
getTelephonyOrganizationLinkRegions → 200400401403404408409413
GET
/api/v2/telephony/sipmessages/conversations/{conversationId}/headers
Get SIP headers.
getTelephonySipmessagesConversationHeaders 2 params → 200400401403404408409413
GET
/api/v2/telephony/sipmessages/conversations/{conversationId}
Get a SIP message.
getTelephonySipmessagesConversation 1 param → 200400401403404408409413
GET
/api/v2/telephony/calls/metrics
Get the concurrent call metrics for a given organization.
getTelephonyCallsMetrics 1 param → 200400401403404408409413
POST
/api/v2/telephony/siptraces/download
Request a download of a pcap file to S3
postTelephonySiptracesDownload 1 param → 200400401403404408409413
GET
/api/v2/telephony/siptraces/download/{downloadId}
Get signed S3 URL for a pcap download
getTelephonySiptracesDownloadDownloadId 1 param → 200202400401403404408409
GET
/api/v2/telephony/siptraces
Fetch SIP metadata
getTelephonySiptraces 6 params → 200400401403404408409413

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are HomerRecord (51 properties), User (39 properties), Group (17 properties), LocationDefinition (16 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
UserConversationSummary
object
8 properties
Image
object
2 properties
AddressableEntityRef
object
2 properties
User
object
39 properties 1 required
WorkPlanBidRanks
object
4 properties
Education
object
5 properties
MediaSummaryDetail
object
2 properties
HomerRecord
object
51 properties
AudioFormat
object
4 properties
Biography
object
5 properties
NumberRoutingResetOrganizationRequest
object
Number Routing reset routing request body
1 property 1 required
UserAuthorization
object
4 properties
ResourcePermissionPolicy
object
11 properties
WritableDivision
object
3 properties
OrganizationLinkResponse
object
6 properties
OutOfOffice
object
8 properties
UserPresence
object
10 properties
CreateOrganizationLink
object
2 properties 2 required
LocationEmergencyNumber
object
3 properties
TelephonySettings
object
2 properties
NumberRouting
object
8 properties
AgentGreeting
object
6 properties
ErrorBody
object
11 properties
UserStations
object
4 properties
LocationImage
object
2 properties
Division
object
3 properties
ResourceConditionNode
object
5 properties
OAuthLastTokenIssued
object
1 property
EmployerInfo
object
4 properties
NumberRoutingRequest
object
3 properties
PresenceDefinition
object
3 properties
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
OrganizationLinkApprovalRequest
object
1 property 1 required
RoutingStatus
object
3 properties
UserStation
object
8 properties
ResourceConditionValue
object
2 properties
OrganizationLink
object
5 properties 4 required
Contact
object
7 properties
Operation
object
10 properties
Group
object
17 properties 4 required
SipSearchResult
object
8 properties
Location
object
5 properties
Geolocation
object
11 properties
DomainEntityRef
object
3 properties
DisasterRecoveryAllRoutingRequest
object
Disaster Recovery all numbers routing request body
3 properties 3 required
MediaRegions
object
3 properties
RegionResponse
object
1 property
SignedUrlResponse
object
4 properties
Callheader
object
4 properties
OrganizationCallMetrics
object
9 properties 9 required
Callmessage
object
4 properties
Limit
object
3 properties
Prompt
object
6 properties 1 required
SipDownloadResponse
object
2 properties
SIPSearchPublicRequest
object
10 properties 2 required
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
PromptAsset
object
14 properties
DomainRole
object
2 properties
Chat
object
1 property
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
GroupContact
object
5 properties 3 required
NumberRoutingListing
object
4 properties
LocationAddress
object
7 properties
LocationDefinition
object
16 properties
SelfAgentGreeting
object
6 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-telephony-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
← Back to G APIs
API Details
ID
genesys:genesys-telephony-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-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-telephony-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 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.