Genesys Messenger Mobile SDK

Add a native, fully featured mobile messenger solution to your Android app, powered by Genesys Cloud.

Overview

This API documentation extends our main documentation source on the Genesys Developer Center. Use Genesys Developer Center to find our Changelog and detailed feature flow explanations.

Getting Started

Follow the Messenger Mobile SDK for Android guide on the Genesys Developer Center for installation, deployment configuration, authentication setup, and end-to-end examples.

Topics

Essentials

The primary types for starting, presenting, and observing a chat session.

• MessengerAccount

• ChatController

• ChatLoadedListener

• ChatLoadResponse

• ChatEventListener

• NRConversationFragment

Availability

Check whether chat is available for a deployment before starting a session.

• ChatAvailability

• AvailabilityResult

• UnavailableEvent

• UnavailableReason

Authentication

Configure OpenID authenticated chat and check whether a deployment requires authorization.

• AuthenticationInfo

• AuthenticationStatus

Chat Elements

Chat elements are delivered through ChatElementReceivedListener.onChatElementReceived. The received ChatElement can be cast to one of its subtypes for type-specific data.

• ChatElementReceivedListener

• ChatElement

• ContentChatElement

• IncomingChatElement

• IncomingAttachmentElement

• QuickReplyChatElement

• QuickReplyOption

• CarouselChatElement

• TimeSlotPickerChatElement

Attachments

File attachments sent and received in the conversation.

• BaseFile

• DownloadableFile

• DownloadStatus

• AttachmentFetcherError

• FileType

Push Notifications

Register and remove the device for push notifications.

• ChatPushNotificationIntegration

Session

Observe the chat session lifecycle through ChatEventListener.onChatStateChanged.

• StateEvent

• StateEventData

• EndedReason

Errors

Handle failures surfaced by the SDK through ChatEventListener.onError.

• NRError

• ErrorEvent

• ErrorListener

• InternalError

Tracking

Send app events to Genesys Cloud through the Mobile Tracking SDK.

• MessengerAccount.initiateTracking

• MessengerTracking

• TrackingConfig

• TrackingTraits

• DeviceCategory