{"id":18736616,"url":"https://github.com/kommunicate-io/kommunicate-react-native-sdk","last_synced_at":"2026-01-27T08:04:19.517Z","repository":{"id":44649809,"uuid":"200037783","full_name":"Kommunicate-io/Kommunicate-React-Native-SDK","owner":"Kommunicate-io","description":"The Kommunicate React Native SDK enables quick integration of AI chatbots powered by OpenAI ChatGPT, Google Gemini, and Anthropic Claude into React Native apps. It acts as a React Native wrapper to bridge our iOS and Android SDKs, supporting NLP, hybrid chat, and real-time messaging for seamless automation.","archived":false,"fork":false,"pushed_at":"2025-04-04T14:02:20.000Z","size":73928,"stargazers_count":28,"open_issues_count":4,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-04T15:22:24.474Z","etag":null,"topics":["ai-chatbot","android","app-framework","chat","chatbot","cross-platform","ios","mobile","react","react-native"],"latest_commit_sha":null,"homepage":"https://docs.kommunicate.io/docs/reactnative-installation.html","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kommunicate-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-01T11:26:48.000Z","updated_at":"2025-04-04T14:02:24.000Z","dependencies_parsed_at":"2023-02-16T18:31:26.754Z","dependency_job_id":"ec9b13cd-cf48-468b-b261-ffec911894ca","html_url":"https://github.com/Kommunicate-io/Kommunicate-React-Native-SDK","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kommunicate-io%2FKommunicate-React-Native-SDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kommunicate-io%2FKommunicate-React-Native-SDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kommunicate-io%2FKommunicate-React-Native-SDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kommunicate-io%2FKommunicate-React-Native-SDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kommunicate-io","download_url":"https://codeload.github.com/Kommunicate-io/Kommunicate-React-Native-SDK/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248621103,"owners_count":21134741,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ai-chatbot","android","app-framework","chat","chatbot","cross-platform","ios","mobile","react","react-native"],"created_at":"2024-11-07T15:21:43.860Z","updated_at":"2026-01-27T08:04:19.512Z","avatar_url":"https://github.com/Kommunicate-io.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Installation\n\nThis is the installation doc for the Kommunicate SDK for React Native.\n\nTo add the Kommunicate module to you react native application, add it using npm:\n\n```\nnpm install react-native-kommunicate-chat --save\n```\n\nThen link the module:\n\n```\nreact-native link react-native-kommunicate-chat\n```\n\nFor iOS, navigate to YourApp/ios directory from terminal and run the below command:\n    ```\n    pod install\n    ```\n\nNote: Kommunicate requires a minimum iOS platform version of 13, uses dynamic frameworks, and requires New Architecture to be disabled. Ensure the following settings are added at the top of your Podfile:\n ```\n platform :ios, '13.0'\n use_frameworks!\n ```\n\nAdd permissions for Camera, Photo Library, Microphone, Contacts and Location usage. \u003c/br\u003e\n\nNote: We won't be asking the users for these permissions unless they use the respective feature. Due to Apple's requirement, we have to add these permissions if we are using any of their APIs related to Camera, Microphone etc.\n\nOpen `Info.plist` from `/ios/YOUR_PROJECT_NAME/Info.plist` file and paste these permissions anywhere inside the `\u003cdict\u003e` tag.\n```\n\u003ckey\u003eNSCameraUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow Camera\u003c/string\u003e\n\u003ckey\u003eNSContactsUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow Contacts\u003c/string\u003e\n\u003ckey\u003eNSLocationWhenInUseUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow location sharing!!\u003c/string\u003e\n\u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow MicroPhone\u003c/string\u003e\n\u003ckey\u003eNSPhotoLibraryUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow Photos\u003c/string\u003e\n\u003ckey\u003eNSPhotoLibraryAddUsageDescription\u003c/key\u003e\n\u003cstring\u003eAllow write access\u003c/string\u003e\n```\n## ProGuard rules\n\nAdd these proguard rules in the proguard-rules.pro file. If you skip this step then your app might crash in the the release build if minify enable is set to true.\n\n```\n-keep class net.sqlcipher.** { *; }\n-keep class javax.crypto.** { *; }\n-keep class net.zetetic.database.sqlcipher.* { *; }\n-keep class net.zetetic.database.sqlcipher.** { *; }\n-keepattributes *Annotation*\n```\n\n## Import the module\n\nYou can use the module by importing it in your react native files as below:\n\n```js\nimport RNKommunicateChat from 'react-native-kommunicate-chat';\n```\n\n## Get your Application Id\nSign up for [Kommunicate](https://www.kommunicate.io/?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=react+native) to get your [APP_ID](https://dashboard.kommunicate.io/settings/install). This APP_ID is used to create/launch conversations.\n\n## Launch chat\nKommunicate provides buildConversation function to create and launch chat directly saving you the extra steps of authentication, creation, initialization and launch. You can customize the process by building the conversationObject according to your requirements.\nTo launch the chat you need to create a conversation object. This object is passed to the `buildConversation` function and based on the parameters of the object the chat is created/launched.\n\nBelow are some examples to launch chat in different scenarios:\n\n### Launching chat for visitor:\nIf you would like to launch the chat directly without the visiting user entering any details, then use the method as below:\n\n```js\nlet conversationObject = {\n     'appId' : '\u003cAPP_ID\u003e' // The [APP_ID](https://dashboard.kommunicate.io/settings/install) obtained from kommunicate dashboard.\n}\n\n RNKommunicateChat.buildConversation(conversationObject, (response, responseMessage) =\u003e {\n        if(response == \"Success\") {\n            console.log(\"Conversation Successfully with id:\" + responseMessage);\n        }\n      });\n```\n### Launching chat for visitor with lead collection:\nIf you need the user to fill in details like phone number, emailId and name before starting the support chat then launch the chat with `withPreChat` flag as true. In this case you wouldn't need to pass the kmUser. A screen would open up for the user asking for details like emailId, phone number and name. Once the user fills the valid details (atleast emailId or phone number is required), the chat would be launched. Use the function as below:\n\n```js\nlet conversationObject = {\n     'appId' : '\u003cAPP_ID\u003e', // The [APP_ID](https://dashboard.kommunicate.io/settings/install) obtained from kommunicate dashboard.\n     'withPreChat' : true\n}\n\n RNKommunicateChat.buildConversation(conversationObject, (response, responseMessage) =\u003e {\n        if(response == \"Success\") {\n            console.log(\"Conversation Successfully with id:\" + responseMessage);\n        }\n      });\n```\n\n### Launching chat with existing user:\nIf you already have the user details then create a KMUser object using the details and launch the chat. Use the method as below to create KMUser with already existing details:\n\n```js\nlet user = {\n      'userId' : '\u003cUSER_ID\u003e',   //Replace it with the userId of the logged in user\n      'password' : '\u003cPASSWORD\u003e'  //Put password here if user has password, ignore otherwise\n}\n\nlet conversationObject = {\n     'appId' : '\u003cAPP_ID\u003e', // The [APP_ID](https://dashboard.kommunicate.io/settings/install) obtained from kommunicate dashboard.\n     'kmUser' : JSON.stringify(user)\n}\n\n RNKommunicateChat.buildConversation(conversationObject, (response, responseMessage) =\u003e {\n        if(response == \"Success\") {\n            console.log(\"Conversation Successfully with id:\" + responseMessage);\n        }\n      });\n```\n\nIf you have a different use-case and would like to customize the chat creation, user creation and chat launch, you can use more parameters in the conversationObject.\n\nBelow are all the parameters you can use to customize the conversation according to your requirements:\n\n| Parameter        | Type           | Description  |\n| ------------- |:-------------:| :-----|\n| appId      | String      |   The [APP_ID](https://dashboard.kommunicate.io/settings/install) obtained from kommunicate dashboard |\n| groupName      | String      |   Optional, you can pass a group name or ignore |\n| kmUser | KMUser     |    Optional, Pass the details if you have the user details, ignore otherwise. The details you pass here are used **only the first time**, to login the user. These login details persists until the app is uninstalled or you call [logout](https://docs.kommunicate.io/docs/reactnative-logout). |\n| withPreChat | boolean      |   Optional, Pass true if you would like the user to fill the details before starting the chat. If you have user details then you can pass false or ignore. |\n| isUnique | boolean      |   Optional,  Pass true if you would like to create only one conversation for every user. The next time user starts the chat the same conversation would open, false if you would like to create a new conversation everytime the user starts the chat. True is recommended for single chat|\n| metadata      | Any      |   Optional. This metadata if set will be sent with all the messages sent from that device. Also this metadata will be set to the conversations created from that device.  |\n| agentIds | List\u003cString\u003e      |    Optional, Pass the list of agents you want to add in this conversation. The agent ID is the email ID with which your agent is registered on Kommunicate. You may use this to add agents to the conversation while creating the conversation. Note that, conversation assignment will be done on the basis of the routing rules set in the [Conversation Rules section](https://dashboard.kommunicate.io/settings/conversation-rules). Adding agent ID here will only add the agents to the conversation and will not alter the routing rules.|\n| botIds | List\u003cString\u003e      |    Optional, Pass the list of bots you want to add in this conversation. Go to [bots](https://dashboard.kommunicate.io/bot) -\u003e Manage Bots -\u003e Copy botID . Ignore if you haven't integrated any bots. You may use this to add any number of bots to the conversation while creating the conversation. Note that this has no effect on the conversation assignee, as the [Conversation Rules](https://dashboard.kommunicate.io/settings/conversation-rules) set forth in the Dashboard will prevail.|\n| createOnly      | boolean      |   Optional. Pass true if you need to create the conversation and not launch it. In this case you will receive the clientChannelKey of the created conversation in the success callback function.|\n\n\nFor more detailed documentation, follow this: https://docs.kommunicate.io/docs/reactnative-installation\nHere is the sample app which implements this SDK: https://github.com/Kommunicate-io/Kommunicate-React-Native-Sample\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkommunicate-io%2Fkommunicate-react-native-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkommunicate-io%2Fkommunicate-react-native-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkommunicate-io%2Fkommunicate-react-native-sdk/lists"}