Difference between revisions of "PEC-Developer/HIW"
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 1: | Line 1: | ||
{{TaskSummary | {{TaskSummary | ||
|DisplayName=How APIs work in Genesys Engage cloud | |DisplayName=How APIs work in Genesys Engage cloud | ||
| − | |||
|Dimension=Journey | |Dimension=Journey | ||
| − | |||
|ComingSoon=No | |ComingSoon=No | ||
|Context=Learn about the APIs you can use to customize your applications and integrate with Genesys. | |Context=Learn about the APIs you can use to customize your applications and integrate with Genesys. | ||
|overviewtext=APIs in Genesys Engage cloud fall under two categories: Web APIs that your web application accesses through Genesys Engage cloud and JavaScript APIs that you install in a location your web application can access. | |overviewtext=APIs in Genesys Engage cloud fall under two categories: Web APIs that your web application accesses through Genesys Engage cloud and JavaScript APIs that you install in a location your web application can access. | ||
| − | |TSSection= | + | |TSSection={{TSSection |
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{TSSection | ||
|sectionheading=Authentication API | |sectionheading=Authentication API | ||
|description=Provides OAuth2 authentication and authorization. | |description=Provides OAuth2 authentication and authorization. | ||
|relatedarticles=*[https://developer.genesyscloud.com/reference/authentication/ API reference] | |relatedarticles=*[https://developer.genesyscloud.com/reference/authentication/ API reference] | ||
*[https://developer.genesyscloud.com/client-libraries/authentication/ Client libraries] | *[https://developer.genesyscloud.com/client-libraries/authentication/ Client libraries] | ||
| − | *[https://github.com/ | + | *[https://github.com/GenesysPureEngage/authorization-code-grant-sample-app Sample application] |
}}{{TSSection | }}{{TSSection | ||
|sectionheading=CX Contact Service API | |sectionheading=CX Contact Service API | ||
| Line 62: | Line 55: | ||
*[https://developer.genesyscloud.com/client-libraries/workspace/ Client libraries] | *[https://developer.genesyscloud.com/client-libraries/workspace/ Client libraries] | ||
*[https://developer.genesyscloud.com/tutorials/ Tutorials] | *[https://developer.genesyscloud.com/tutorials/ Tutorials] | ||
| − | }} | + | }}{{TSSection |
| − | |||
| − | |||
| − | {{TSSection | ||
|sectionheading=Service Client API | |sectionheading=Service Client API | ||
|description=Extend the UI integration when Agent Desktop is configured to embed other web client business applications. | |description=Extend the UI integration when Agent Desktop is configured to embed other web client business applications. | ||
| Line 77: | Line 67: | ||
}} | }} | ||
}} | }} | ||
| + | {{#css: .dropdown {display:none;} }}==Web APIs== | ||
| + | Web APIs are documented on the [https://developer.genesyscloud.com/ Genesys Engage cloud Developer Center], where you can find reference information, tutorials and samples. Genesys recommends that you are familiar with [https://tools.ietf.org/html/rfc6749 OAuth 2] - Genesys Engage cloud web APIs implement this standard for secure authentication and support the Authorization Code Grant type. Check out the [https://developer.genesyscloud.com/reference/authentication/ Authentication API] for details. | ||
| + | |||
| + | See below for a complete list of web APIs and links to related documentation. | ||
| − | + | ==JavaScript APIs== | |
| + | Documentation for our JavaScript libraries is on this site and includes reference information, as well as how to download and get started with the APIs. See the sections below for details. | ||
Revision as of 16:07, April 22, 2021
Learn about the APIs you can use to customize your applications and integrate with Genesys.
Contents
APIs in Genesys Engage cloud fall under two categories: Web APIs that your web application accesses through Genesys Engage cloud and JavaScript APIs that you install in a location your web application can access.
Authentication API
Provides OAuth2 authentication and authorization.
CX Contact Service API
Create and manage outbound campaigns, import and work with contact lists, and enable compliance rules.
Consumer Messaging API
Create a session, send and fetch messages, and manage participants.
Data Download Service API
Securely export your contact center data.
Engagement API
Manage callbacks, query availability, estimated wait times, and create call-in requests.
Intelligent Workload Distribution API
Create, update, delete or find workitems that come from third-party applications.
Provisioning API
Configure your Genesys environment, create users, and retrieve configuration data.
Statistics API
Subscribe to statistics and get notifications when they change.
Task Routing API
Submit workitems to Genesys from third-party applications.
Workspace API
Manage agent state, access to voice and chat channels, and supervisor monitoring.
Service Client API
Extend the UI integration when Agent Desktop is configured to embed other web client business applications.
Widgets
A collection of JavaScript APIs that provide UIs (and their supporting services) you can use in your own web applications. For example, chat and co-browse.
Web APIs
Web APIs are documented on the Genesys Engage cloud Developer Center, where you can find reference information, tutorials and samples. Genesys recommends that you are familiar with OAuth 2 - Genesys Engage cloud web APIs implement this standard for secure authentication and support the Authorization Code Grant type. Check out the Authentication API for details.
See below for a complete list of web APIs and links to related documentation.
JavaScript APIs[ | edit source]
Documentation for our JavaScript libraries is on this site and includes reference information, as well as how to download and get started with the APIs. See the sections below for details.