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 WebMessaging API

Web messaging

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 4 operations across 2 paths, and defines 44 schemas. It is described by OpenAPI 2.0, at version v2.

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

4 operations 2 paths 44 schemas 1 DELETE1 GET1 PATCH1 POST

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 WebMessaging 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

WebMessaging 4

Web messaging

POST
/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}
Add a new device information
postWebmessagingDeploymentPushdevice 3 params → 204400401403404408409413
DELETE
/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}
Delete device information
deleteWebmessagingDeploymentPushdevice 2 params → 204400401403404408409413
PATCH
/api/v2/webmessaging/deployments/{deploymentId}/pushdevices/{tokenId}
Edit device information
patchWebmessagingDeploymentPushdevice 3 params → 204400401403404408409413
GET
/api/v2/webmessaging/messages
Get the messages for a web messaging session.
getWebmessagingMessages 2 params → 200400401403404408409413

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are WebMessagingMessage (11 properties), ErrorBody (11 properties), WebMessagingContent (10 properties), ConversationContentDatePicker (9 properties). Each schema is shown below with its type and property counts.

WebMessagingButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
5 properties 3 required
ConversationFormPage
object
Form page object.
3 properties 2 required
WebMessagingRecipient
object
Information about the recipient the message is sent to or received from.
5 properties
ContentCard
object
Card content object.
6 properties 2 required
WebMessagingContent
object
Message content element.
10 properties
ConversationContentLocation
object
Location object.
5 properties
Reason
object
Reasons for a failed message receipt.
2 properties 1 required
ConversationContentInput
object
Single or multiline text input component.
8 properties 2 required
RecipientAdditionalIdentifier
object
Additional identifiers for describing messaging recipient.
2 properties 2 required
ConversationContentListPickerSection
object
List Picker object for presenting a section of selectable items.
3 properties
ConversationContentDatePicker
object
DateTimePicker content object.
9 properties
ContentCarousel
object
Carousel content object.
1 property 1 required
WebMessagingEventCoBrowse
object
A Cobrowse event.
3 properties 1 required
ConversationContentDatePickerAvailableTime
object
A datetimepicker available time that a user can take.
2 properties
ConversationContentListPickerItem
object
Represents a selectable item in a list picker.
4 properties
Detail
object
4 properties
ErrorBody
object
11 properties
ConversationContentForm
object
Form content object.
8 properties 1 required
ConversationContentWheelPicker
object
Wheel Picker object for representing single selection of selectable items.
2 properties 1 required
ContentDatePickerAvailableTime
object
A datepicker available time that a user can take.
2 properties
ConversationFormResponseContent
object
Message content element for form responses
2 properties
WebMessagingGeneric
object
Generic content object. (Deprecated
5 properties
PushDeviceUpdateRequest
object
2 properties
ButtonComponent
object
Structured template button object.
2 properties
ConversationContentButtonResponse
object
Button response object representing the click of a structured message button, such as a quick reply.
4 properties 2 required
WebMessagingAttachment
object
Attachment object.
8 properties
ConversationContentIntroduction
object
Introduction content object.
4 properties 2 required
ConversationContentListPicker
object
List Picker object for presenting multiple sections of selectable items.
4 properties
ConversationFormPageComponent
object
Form component element. Examples include: List Picker, Date Picker, Wheel Picker and Input text.
5 properties
WebMessagingMessageEntityList
object
5 properties
WebMessagingEventPresence
object
A Presence event.
1 property 1 required
ConversationContentWheelPickerItem
object
Represents a selectable item in a Wheel Picker
3 properties 2 required
ContentDatePicker
object
DatePicker content object.
6 properties 1 required
Limit
object
3 properties
ContentCardAction
object
A card action that a user can take.
4 properties
ContentActions
object
User actions available on the content. All actions are optional and all actions are executed simultaneously.
3 properties
ConversationContentReceivedReplyMessage
object
ReceivedReplyMessage content object.
5 properties
WebMessagingEventVideo
object
A Video event.
3 properties 1 required
PushDeviceInsertRequest
object
4 properties 4 required
WebMessagingMessage
object
A web messaging message
11 properties
ConversationFormResponseComponent
object
A response component from a form
2 properties 2 required
WebMessagingChannel
object
Channel-specific information that describes the message and the message channel/provider.
4 properties
WebMessagingQuickReply
object
Quick reply object
4 properties 2 required
WebMessagingEvent
object
Message event element. Examples include: system messages, typing indicators, cobrowse offerings.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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