{"id":34802546,"url":"https://github.com/customerly/customerlyandroidsdk","last_synced_at":"2026-04-27T19:03:13.048Z","repository":{"id":297209169,"uuid":"970819181","full_name":"Customerly/CustomerlyAndroidSDK","owner":"Customerly","description":"Embed the Best-in-Class Live Chat for your Android apps with Customerly mobile SDK","archived":false,"fork":false,"pushed_at":"2025-08-26T15:41:37.000Z","size":233,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-26T21:40:01.920Z","etag":null,"topics":["android","android-studio","customer-care","customer-support","customerly","live-chat","messaging","messenger","sdk"],"latest_commit_sha":null,"homepage":"https://www.customerly.io/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Customerly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-22T15:26:58.000Z","updated_at":"2025-08-26T15:41:34.000Z","dependencies_parsed_at":"2025-06-04T18:04:54.149Z","dependency_job_id":null,"html_url":"https://github.com/Customerly/CustomerlyAndroidSDK","commit_stats":null,"previous_names":["customerly/customerlyandroidsdk"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Customerly/CustomerlyAndroidSDK","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Customerly%2FCustomerlyAndroidSDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Customerly%2FCustomerlyAndroidSDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Customerly%2FCustomerlyAndroidSDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Customerly%2FCustomerlyAndroidSDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Customerly","download_url":"https://codeload.github.com/Customerly/CustomerlyAndroidSDK/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Customerly%2FCustomerlyAndroidSDK/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32350245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T17:12:42.749Z","status":"ssl_error","status_checked_at":"2026-04-27T17:12:41.658Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","android-studio","customer-care","customer-support","customerly","live-chat","messaging","messenger","sdk"],"created_at":"2025-12-25T11:42:37.507Z","updated_at":"2026-04-27T19:03:13.041Z","avatar_url":"https://github.com/Customerly.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://customerly.io\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://avatars1.githubusercontent.com/u/23583405?s=200\u0026v=4\" height=\"100\" alt=\"Customerly logo\"\u003e\n\u003c/a\u003e\n\n# Customerly Android SDK\n\n[![Maven Central](https://img.shields.io/maven-central/v/io.customerly/customerlyandroidsdk)](https://search.maven.org/artifact/io.customerly/customerlyandroidsdk)\n![GitHub License](https://img.shields.io/github/license/Customerly/CustomerlyAndroidSDK)\n\nCustomerly 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:\n\n- Live chat support\n- Help center articles\n- User profiling\n- Event tracking\n- Lead generation\n- Surveys\n- Real-time video calls\n\n## Installation\n\n1. Add the following dependency to your app's `build.gradle` file:\n\n```gradle\ndependencies {\n    implementation 'io.customerly:customerlyandroidsdk:1.0.1'\n}\n```\n\n2. Add the following permissions to your `AndroidManifest.xml` to enable file attachments in the live chat:\n\n```xml\n\u003cuses-permission android:name=\"android.permission.READ_EXTERNAL_STORAGE\" /\u003e\n\u003cuses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\"\n    android:maxSdkVersion=\"28\" /\u003e\n\u003cuses-permission android:name=\"android.permission.MANAGE_EXTERNAL_STORAGE\"\n    tools:ignore=\"ScopedStorage\" /\u003e\n```\n\nThese 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.\n\n## Basic Usage\n\n1. Initialize the SDK in your Application class or MainActivity:\n\n```kotlin\nCustomerly.load(context, CustomerlySettings(app_id = \"YOUR_APP_ID\"))\n```\n\n2. Show the chat interface:\n\n```kotlin\nCustomerly.show()\n```\n\n## APIs\n\n### Initialization\n\n#### load\nInitializes the Customerly SDK with the provided settings.\n\n```kotlin\nCustomerly.load(context, CustomerlySettings(app_id = \"YOUR_APP_ID\"))\n```\n\n#### setContext\nUpdates the context used by the SDK. Call this when your application's context changes.\n\n```kotlin\nCustomerly.setContext(context)\n```\n\n#### update\nUpdates the Customerly SDK settings.\n\n```kotlin\nCustomerly.update(CustomerlySettings(app_id = \"YOUR_APP_ID\"))\n```\n\n#### requestNotificationPermissionIfNeeded\nRequests notification permissions if not already granted.\n\n```kotlin\nCustomerly.requestNotificationPermissionIfNeeded()\n```\n\n### Chat Interface\n\n#### show\nShows the Customerly chat interface.\n\n```kotlin\nCustomerly.show()\n```\n\n#### hide\nHides the Customerly chat interface.\n\n```kotlin\nCustomerly.hide()\n```\n\n#### back\nNavigates back in the chat interface.\n\n```kotlin\nCustomerly.back()\n```\n\n### User Management\n\n#### logout\nLogs out the current user.\n\n```kotlin\nCustomerly.logout()\n```\n\n#### registerLead\nRegisters a new lead with the provided email and optional attributes.\n\n```kotlin\nCustomerly.registerLead(email = \"test@customerly.io\", attributes = mapOf(\"name\" to \"John Doe\"))\n```\n\n### Messaging\n\n#### showNewMessage\nShows the chat interface with a pre-filled message.\n\n```kotlin\nCustomerly.showNewMessage(message = \"Hello, how are you?\")\n```\n\n#### sendNewMessage\nSends a new message and shows the chat interface.\n\n```kotlin\nCustomerly.sendNewMessage(message = \"Hello, how are you?\")\n```\n\n#### navigateToConversation\nNavigates to a specific conversation.\n\n```kotlin\nCustomerly.navigateToConversation(conversationId = 123)\n```\n\n### Help Center\n\n#### showArticle\nShows a specific help center article.\n\n```kotlin\nCustomerly.showArticle(collectionSlug = \"collection\", articleSlug = \"article\")\n```\n\n### Analytics\n\n#### event\nTracks a custom event.\n\n```kotlin\nCustomerly.event(name = \"event_name\")\n```\n\n#### attribute\nSets a custom attribute for the current user.\n\n```kotlin\nCustomerly.attribute(name = \"attribute_name\", value = \"attribute_value\")\n```\n\n### Message Counts\n\n#### getUnreadMessagesCount\nGets the count of unread messages.\n\n```kotlin\nCustomerly.getUnreadMessagesCount(resultCallback = { count -\u003e\n    Log.d(\"Customerly\", \"Unread messages count: $count\")\n})\n```\n\n#### getUnreadConversationsCount\nGets the count of unread conversations.\n\n```kotlin\nCustomerly.getUnreadConversationsCount(resultCallback = { count -\u003e\n    Log.d(\"Customerly\", \"Unread conversations count: $count\")\n})\n```\n\n### Callbacks\n\nThe SDK provides various callback methods to handle different events:\n\n```kotlin\nfun setOnChatClosed(callback: () -\u003e Unit)\nfun setOnChatOpened(callback: () -\u003e Unit)\nfun setOnMessageRead(callback: (Int, Int) -\u003e Unit)\nfun setOnMessengerInitialized(callback: () -\u003e Unit)\nfun setOnNewMessageReceived(callback: (UnreadMessage) -\u003e Unit)\nfun setOnNewConversation(callback: (String, List\u003cAttachmentPayload\u003e) -\u003e Unit)\nfun setOnNewConversationReceived(callback: (Int) -\u003e Unit)\nfun setOnHelpCenterArticleOpened(callback: (HelpCenterArticle) -\u003e Unit)\nfun setOnLeadGenerated(callback: (String?) -\u003e Unit)\nfun setOnMessengerInitialized(callback: () -\u003e Unit)\nfun setOnProfilingQuestionAnswered(callback: (String, String) -\u003e Unit)\nfun setOnProfilingQuestionAsked(callback: (String) -\u003e Unit)\nfun setOnRealtimeVideoAnswered(callback: (RealtimeCall) -\u003e Unit)\nfun setOnRealtimeVideoCanceled(callback: () -\u003e Unit)\nfun setOnRealtimeVideoReceived(callback: (RealtimeCall) -\u003e Unit)\nfun setOnRealtimeVideoRejected(callback: () -\u003e Unit)\nfun setOnSurveyAnswered(callback: () -\u003e Unit)\nfun setOnSurveyPresented(callback: (Survey) -\u003e Unit)\nfun setOnSurveyRejected(callback: () -\u003e Unit)\n```\n\nEach callback has a corresponding remove method:\n\n```kotlin\nfun removeOnChatClosed()\nfun removeOnChatOpened()\n// ... and so on for all callbacks\n```\n\nYou can also remove all callbacks at once:\n\n```kotlin\nfun removeAllCallbacks()\n```\n\n## Examples\n\nThe 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:\n\n- Basic SDK initialization\n- Messenger presentation\n- User management\n- Event tracking\n- Message handling\n- Notification handling\n- Callback usage\n\nTo run the sample app:\n\n1. Open the project in Android Studio\n2. Navigate to the `sampleapp` module\n3. Replace the `app_id` in `MainActivity.kt` with your Customerly app ID\n4. Run the app on your device or emulator\n\nThe sample app provides a complete reference implementation of all SDK features and can be used as a starting point for your integration.\n\n## Development\n\nTo release a new version of the SDK, you need to:\n\n1. Update the version in the `build.gradle` file\n2. Update the version in the `README.md` file\n3. Push the changes to the `main` branch\n4. Create a new tag with the version number (e.g. `1.0.0`)\n5. The GitHub Actions workflow will build the SDK and release it to Maven Central\n\n## License\n\nThis SDK is licensed under the GNU GPLv3 License. See the LICENSE file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustomerly%2Fcustomerlyandroidsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcustomerly%2Fcustomerlyandroidsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcustomerly%2Fcustomerlyandroidsdk/lists"}