SDK

Chatness provides official SDKs for the Node and Browser platforms. You can use these SDKs to integrate Chatness into any kind of application and whenever you are on a different platform, you can use our REST API endpoints directly. We provide examples for every endpoint in the documentation, but if you need help, feel free to contact us.

Install

npm install @chatness/browser

npm install @chatness/server

  const { Chatness } = require('@chatness/server')

  const orgToken = 'your-org-token';
  const botId = 'your-bot-id';

  const chat = new Chatness({
    orgToken
  });

  // create a token
  const { data } = await chat.auth
                         .contacts({ botId })
                         .create({
                            email: '[email protected]'
                         });
  const { token } = data;

  // pass down the contact token
  // to your frontend application
  console.log(token);

Browser Methods

Here is a list of the different methods available in the SDK for browser:

Auth Contacts Login

Login a contact using the authorization token.

chat.auth.contacts.login({ ...payload })

Payload

Auth Contacts Logout

Logout the current contact.

chat.auth.contacts.logout()

Widget Open

Open the widget to start new conversations.

chat.widget.open()

Widget Close

Close the widget but keep the launcher visible.

chat.widget.close()

Widget Hide

Completely hide the widget. The launcher won't be shown.

chat.widget.hide()

Widget Show

Show the widget launcher.

chat.widget.show()

Widget Message

Send a message to the current conversation.

chat.widget.message({ ...payload })

Payload

Server Methods

Here is a list of the different methods available in the SDK for server:

Auth Contacts Tokenize

Generate a contact authorization token.

chat.auth.contacts.tokenize({ ...payload })

Payload

Auth Contacts Revoke

Revoke a contact authorization token. Will logout the contact from all devices.

chat.auth.contacts.revoke({ ...payload })

Payload

Contacts Create

Create a new contact.

chat.contacts.create({ ...payload })

Payload

Contacts Upsert

Create or update contacts in bulk.

chat.contacts.upsert([{ ...payload }])

Payload

Contacts Search

Search for contacts by name, email, phone, id, mid, or wid.

chat.contacts.search({ ...payload })

Payload

Contacts Retrieve

Retrieve a contact by its ID.

chat.contacts.retrieve(contactId)

Contacts Update

Update a contact by its ID.

chat.contacts.update(contactId, payload)

Payload

Contacts Delete

Delete a contact by its ID.

chat.contacts.delete(contactId)