Chats API - en

Using this API, you can get a list of created chats, get information about a chat, mark it as “read” or “close”.

You can also receive messages from a conversation or send a message.

Reading.

Allows you to view existing chats.

GET https://api.smartsender.com/v1/chats

Main parameters:

Name	Description	Validation

Name	Description	Validation
page	Requested Page	Minimum value 1
limitation	Amount of data to display per page	Minimum value 1, maximum 20
term	Keyword to search	Not necessary, String
state	Chat status	Not necessary, Enum open, if only clock with open status closed, if only chats with closed status
selector[name]	Chat filter	Not necessary, Enum none, all chats private, only chats of a certain operator unread, only unread chats
selector[operatorId]	Selecting an operator for the private filter	Required if selector[name] is private. ID of the required operator

In case of a successful response, you will receive the following:

{
    "cursor": Cursor,
    "collection": Chats[]
}

Main parameters:

Name	Description

Name	Description
cursor	Object of type Cursor
collection	Array of type objects Chat

Getting by ID.

Allows you to get information about the specified chat.

GET https://api.smartsender.com/v1/chats/{chatId}

In case of a successful response, get an object of type Chat.

Read the selected chat.

Allows you to read all notifications in the selected chat.

PUT https://api.smartsender.com/v1/chats/{chatId}/read

In case of a successful response, you will receive the following:

{
    "state": true
}

Close the selected chat.

Allows you to close the selected chat.

PUT https://api.smartsender.com/v1/chats/{chatId}/close

In case of a successful response, you will receive the following:

{
    "state": true
}

Assign a chat.

Allows you to assign the selected chat to a specific operator.

POST https://api.smartsender.com/v1/chats/{chatId}/forward/{operatorId}

Main parameters:

Name	Description

Name	Description
text	Informative text - description of the destination

In case of a successful response, you will receive the following:

{
    "state": true
}

Get the messages of the selected chat.

Allows you to receive messages in the selected chat

GET https://api.smartsender.com/v1/chats/{chatId}/messages

Main parameters:

Name	Description	Validation

Name	Description	Validation
page	Requested Page	Minimum value 1
limitation	Amount of data to display per page	Minimum value 1, maximum 20

……