Node SDK

Use the official Chatness SDK for server to integrate Chatness into your system. The SDK provides a secure way to interact with Chatness API and customize functionality.

Installation

You can install the Chatness SDK for server using npm or any other package manager.

npm install @chatness/server

Setup

In order to use the SDK, you need to initialize it with your organization token and a bot ID. Learn how to get your organization token. You can grab the bot ID from the Chatness dashboard.

import { Chatness } from '@chatness/server';

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

// export the chat instance
// so you can reuse it across your app
export const chat = new Chatness({ orgToken, botId });

Contacts authorization

Generate a token for contact authorization.

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

Payload

Revoke authorization

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

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

Payload

Create a contact

Create a new contact.

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

Payload

Contacts bulk import

Create or update contacts in bulk.

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

Payload

Search contacts

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

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

Payload

Contact details

Retrieve a contact by its ID.

chat.contacts.retrieve(contactId)

Updating contacts

Update a contact by its ID.

chat.contacts.update(contactId, payload)

Payload

Deleting contacts

Delete a contact by its ID.

chat.contacts.delete(contactId)