https://github.com/customerly/customerlyandroidsdk
Embed the Best-in-Class Live Chat for your Android apps with Customerly mobile SDK
https://github.com/customerly/customerlyandroidsdk
android android-studio customer-care customer-support customerly live-chat messaging messenger sdk
Last synced: about 2 months ago
JSON representation
Embed the Best-in-Class Live Chat for your Android apps with Customerly mobile SDK
- Host: GitHub
- URL: https://github.com/customerly/customerlyandroidsdk
- Owner: Customerly
- License: gpl-3.0
- Created: 2025-04-22T15:26:58.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-08-26T15:41:37.000Z (10 months ago)
- Last Synced: 2025-08-26T21:40:01.920Z (10 months ago)
- Topics: android, android-studio, customer-care, customer-support, customerly, live-chat, messaging, messenger, sdk
- Language: Kotlin
- Homepage: https://www.customerly.io/
- Size: 228 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Customerly Android SDK
[](https://search.maven.org/artifact/io.customerly/customerlyandroidsdk)
Customerly is a customer service platform that helps businesses provide better support to their customers. The Android SDK allows you to integrate Customerly's features directly into your Android application, including:
- Live chat support
- Help center articles
- User profiling
- Event tracking
- Lead generation
- Surveys
- Real-time video calls
## Installation
1. Add the following dependency to your app's `build.gradle` file:
```gradle
dependencies {
implementation 'io.customerly:customerlyandroidsdk:1.0.1'
}
```
2. Add the following permissions to your `AndroidManifest.xml` to enable file attachments in the live chat:
```xml
```
These permissions are required to allow users to attach files in the live chat. The `WRITE_EXTERNAL_STORAGE` permission is limited to Android 10 (API level 28) and below, while `MANAGE_EXTERNAL_STORAGE` is used for Android 11 (API level 30) and above.
## Basic Usage
1. Initialize the SDK in your Application class or MainActivity:
```kotlin
Customerly.load(context, CustomerlySettings(app_id = "YOUR_APP_ID"))
```
2. Show the chat interface:
```kotlin
Customerly.show()
```
## APIs
### Initialization
#### load
Initializes the Customerly SDK with the provided settings.
```kotlin
Customerly.load(context, CustomerlySettings(app_id = "YOUR_APP_ID"))
```
#### setContext
Updates the context used by the SDK. Call this when your application's context changes.
```kotlin
Customerly.setContext(context)
```
#### update
Updates the Customerly SDK settings.
```kotlin
Customerly.update(CustomerlySettings(app_id = "YOUR_APP_ID"))
```
#### requestNotificationPermissionIfNeeded
Requests notification permissions if not already granted.
```kotlin
Customerly.requestNotificationPermissionIfNeeded()
```
### Chat Interface
#### show
Shows the Customerly chat interface.
```kotlin
Customerly.show()
```
#### hide
Hides the Customerly chat interface.
```kotlin
Customerly.hide()
```
#### back
Navigates back in the chat interface.
```kotlin
Customerly.back()
```
### User Management
#### logout
Logs out the current user.
```kotlin
Customerly.logout()
```
#### registerLead
Registers a new lead with the provided email and optional attributes.
```kotlin
Customerly.registerLead(email = "test@customerly.io", attributes = mapOf("name" to "John Doe"))
```
### Messaging
#### showNewMessage
Shows the chat interface with a pre-filled message.
```kotlin
Customerly.showNewMessage(message = "Hello, how are you?")
```
#### sendNewMessage
Sends a new message and shows the chat interface.
```kotlin
Customerly.sendNewMessage(message = "Hello, how are you?")
```
#### navigateToConversation
Navigates to a specific conversation.
```kotlin
Customerly.navigateToConversation(conversationId = 123)
```
### Help Center
#### showArticle
Shows a specific help center article.
```kotlin
Customerly.showArticle(collectionSlug = "collection", articleSlug = "article")
```
### Analytics
#### event
Tracks a custom event.
```kotlin
Customerly.event(name = "event_name")
```
#### attribute
Sets a custom attribute for the current user.
```kotlin
Customerly.attribute(name = "attribute_name", value = "attribute_value")
```
### Message Counts
#### getUnreadMessagesCount
Gets the count of unread messages.
```kotlin
Customerly.getUnreadMessagesCount(resultCallback = { count ->
Log.d("Customerly", "Unread messages count: $count")
})
```
#### getUnreadConversationsCount
Gets the count of unread conversations.
```kotlin
Customerly.getUnreadConversationsCount(resultCallback = { count ->
Log.d("Customerly", "Unread conversations count: $count")
})
```
### Callbacks
The SDK provides various callback methods to handle different events:
```kotlin
fun setOnChatClosed(callback: () -> Unit)
fun setOnChatOpened(callback: () -> Unit)
fun setOnMessageRead(callback: (Int, Int) -> Unit)
fun setOnMessengerInitialized(callback: () -> Unit)
fun setOnNewMessageReceived(callback: (UnreadMessage) -> Unit)
fun setOnNewConversation(callback: (String, List) -> Unit)
fun setOnNewConversationReceived(callback: (Int) -> Unit)
fun setOnHelpCenterArticleOpened(callback: (HelpCenterArticle) -> Unit)
fun setOnLeadGenerated(callback: (String?) -> Unit)
fun setOnMessengerInitialized(callback: () -> Unit)
fun setOnProfilingQuestionAnswered(callback: (String, String) -> Unit)
fun setOnProfilingQuestionAsked(callback: (String) -> Unit)
fun setOnRealtimeVideoAnswered(callback: (RealtimeCall) -> Unit)
fun setOnRealtimeVideoCanceled(callback: () -> Unit)
fun setOnRealtimeVideoReceived(callback: (RealtimeCall) -> Unit)
fun setOnRealtimeVideoRejected(callback: () -> Unit)
fun setOnSurveyAnswered(callback: () -> Unit)
fun setOnSurveyPresented(callback: (Survey) -> Unit)
fun setOnSurveyRejected(callback: () -> Unit)
```
Each callback has a corresponding remove method:
```kotlin
fun removeOnChatClosed()
fun removeOnChatOpened()
// ... and so on for all callbacks
```
You can also remove all callbacks at once:
```kotlin
fun removeAllCallbacks()
```
## Examples
The SDK includes a sample app project located in the `sampleapp` directory that demonstrates how to integrate and use the Customerly SDK. The sample app showcases various features including:
- Basic SDK initialization
- Messenger presentation
- User management
- Event tracking
- Message handling
- Notification handling
- Callback usage
To run the sample app:
1. Open the project in Android Studio
2. Navigate to the `sampleapp` module
3. Replace the `app_id` in `MainActivity.kt` with your Customerly app ID
4. Run the app on your device or emulator
The sample app provides a complete reference implementation of all SDK features and can be used as a starting point for your integration.
## Development
To release a new version of the SDK, you need to:
1. Update the version in the `build.gradle` file
2. Update the version in the `README.md` file
3. Push the changes to the `main` branch
4. Create a new tag with the version number (e.g. `1.0.0`)
5. The GitHub Actions workflow will build the SDK and release it to Maven Central
## License
This SDK is licensed under the GNU GPLv3 License. See the LICENSE file for more details.