- In XCode, in the project navigator, right click
Add Files to [your project's name]
- Go to
- In XCode, in the project navigator, select your project. Add
libYMChat.ato your project's
Link Binary With Libraries
- Run your project (
- Open up
import com.reactlibrary.YMChatPackage;to the imports at the top of the file
new YMChatPackage()to the list returned by the
- Append the following lines to
android/settings.gradle:include ':ymchat-react-native'project(':ymchat-react-native').projectDir = new File(rootProject.projectDir, '../node_modules/ymchat-react-native/android')
- Insert the following lines inside the dependencies block in
- Add following key in your
strings.xmlfile, this will override default file provider used by SDK. Overriding the file provider path will avoid conflict with other app using YM CHATBOT SDK. You can use your application id and suffix it with
.fileproviderExample - applicationId :
com.abc.xyzthen application_id_for_provider =
Import YMChat in App.js
This is the first and compulsary step.
ymAuthenticationToken is used to associate an identity of the user with the chat bot.
Whenever chatbot is launched with ymAuthenticationToken it will load the previous chats associated with this user since inception.
Note: History will load only when
Show history flag is enabled in the channel settings
YMChat supports firebase notifications. Pass your
FCM token in setDeviceToken method.
Note: Firebase service account key is required to send notifications. You can share the service account key with us. More info here
Additional information can be passed in the form of key value pair from app to bot using payload.
Payload can be used to pass information from host app to bot. The payload dictionary should be JSON compatible else an error will be thrown
For passing data from bot to app refer bot Bot Events
Payload is securely passed in HTTPS post request to protect the information passed in it
ymchat-react-native supports bots with on-prem deployments. For the bot to work, pass the on-prem URL to
Speech to text can be enabled and disabled by calling setEnableSpeech(). Default value is
If you are supporting Speech recognization, add following snippet to Info.plist of the host app
Chat bot can be presented by calling
startChatbot(). This method will display full screen chat view
Bot events are used to pass information from bot to app. For passing events from app to bot refer Payload
Bot close event is separetly sent and it can be handled in following way.
Bot can be programatically closed using
If you want to stop receiving push notifications you can unlink the device token. Device token typically is unlinked when the user logs out of the app.
Note: API key can be found in account settings under Access keys section after you login.
A demo app can be used as a reference to better understand how this SDK can be integrated in the app https://github.com/yellowmessenger/ymchat-react-native-demo