@deepvision/dvm.js v1.2.5

Deepvision Messenger API Library

Installing

To install library use:

npm install @deepvision/dvm.js

Initializing

Import library into your script file and create dvm instance with constructor.

import DVMApi from '<path_to_library>';

const dvm = new DVMApi({
    endpoint: 'api-enpoint',
    getAccessToken: () => 'token',
});

Getting updates

There is one way of receiving updates for your client — the updates.list method.

Update

This object represents an incoming update.

List Updates

Use this method to receive incoming updates. An Array of Update objects is returned.

const { updates, meta } = await dvm.updates.list({
    since,
    limit,
});

Request:

Response:

Notes 1. In order to avoid getting duplicate updates, recalculate offset after each server response.

Available types

All types used in the Bot API responses are represented as JSON-objects.

Optional fields may be not returned when irrelevant.

Chat

Message

User

User object can have more optional fields.

PaginationMeta

List of fields in PaginationMeta object can be different depending on the model.

Available methods

On successful call, a JSON-object containing the result will be returned.

Create Chat

Use this method to create new chat. On success, the created Chat is returned.

This method is available for registered users only.

const chat = await dvm.chats.create({
    type,
    members,
});

Request:

List Chats

Use this method to get list of chats of the current user and incomplete chats also, that can be joined.

This method is available for registered users only.

const { chats, meta } = await dvm.chats.list({
    offset,
    limit,
});

Request:

Response:

Get Chat

Use this method to get info about chat. On success, a Chat object is returned

This method is available for registered users only.

const chat = await dvm.chats.withId(id).get();

Request:

Delete Chat

Use this method to delete chat

This method is available for registered users only.

await dvm.chats.withId(id).delete();

Request:

Join Chat

Use this method to add current user as a new member to a chat. Chats with incomplete type can be joined only. As soon as user join chat, the last one's type will be changed to private.

This method is available for registered users only.

await dvm.chats.withId(id).join();

Request:

Create Chat Message

Use this method to send text messages. On success, the sent Message is returned.

This method is available for registered users only. This method is available for members of the chat only.

const message = await dvm.chats.withId(id).messages.create({
    text,
});

Request:

List Chat Messages

Use this method to get list of Message objects for this chat

This method is available for registered users only.

const { messages, meta } = await dvm.chats.withId(id).messages.list({
    offset,
    limit,
    text,
});

Request:

Response:

Get Message

Use this method to get message. On success, a Message object is returned.

This method is available for registered users only.

const chat = await dvm.messages.withId(id).get();

Request:

Edit Message

Use this method to edit message. On success, the new version of Message object is returned.

This method is available for registered users only.

const message = await dvm.messages.withId(id).edit({
    text,
});

Request:

Delete Message

Use this method to delete message

This method is available for registered users only.

await dvm.messages.withId(id).delete()

Request:

Register User

Use this method to register user in DVM service. On success, the registered user is returned. If user with such id has already registered, throws error

const user = await dvm.users.register({
    id,
    firstName,
    lastName,
    ...
});

Request:

It is not finished list of properties. You can pass other user's info such as email, phone, avatar etc.

Get User

Use this method to get info about registered user. If user is not registered, method throws error

const chat = await dvm.users.withId(id).get();

Request:

List Users

Use this method to get list of registered users

const { users, meta } = await dvm.users.list({
    offset,
    limit,
});

Request:

Response:

License

This project is licensed under the MIT License