← Reference

Chats

Common Chat Api · 143 operations

Legacy Account

  • GET/accountGet accounts by filter
  • POST/accountAdd account
  • GET/account/statusesGet accounts with statuses

AI

  • GET/ai/balanceGetting AI balance of the account
  • POST/ai/correctCorrecting spelling and grammar of text
  • POST/ai/rephraseRephrasing text in certain style
  • POST/ai/summarySummarizing a chat and saving the summary as a note
  • POST/ai/transcribe-messageStarting transcription of an audio message
  • GET/ai/transcription/{chatMessageUuid}Getting the transcription status of an audio message
  • POST/ai/translateTranslating text into certain language
  • POST/ai/translate-messageTranslating a chat message into the language of the current user

altegio

  • POST/altegio/authAuthorization

AuthMain

  • POST/authMake auth with login and password
  • POST/auth/captchaMake auth with login, password and captcha guard
  • PATCH/auth/passwordChange user password
  • POST/auth/passwordChange user password (legacy, requires previous password)
  • POST/auth/registerRegister new user
  • POST/auth/static-tokenMake auth with static token

StaticAuthToken

  • GET/auth/static-codeGet static token
  • POST/auth/static-code/generateGenerate
  • POST/auth/static-code/regenerateRegenerate

AuthToken

  • POST/auth/token/logoutLogout and delete refreshToken
  • POST/auth/token/refreshRefresh tokens pair

auto-reply-config

  • GET/auto-reply-config/group/{groupToken}Get auto reply config for group
  • PATCH/auto-reply-config/group/{groupToken}Update auto reply config for group
  • POST/auto-reply-config/group/{groupToken}Create auto reply config for group

Blocked Contact

  • GET/blocked-contactGet blocked contacts
  • POST/blocked-contactBlock contact
  • POST/blocked-contact/unblockUnblock contact

chat-user

  • GET/chat-user/countGetting count of chat users by filter
  • GET/chat-user/listGetting list of chat users by filter
  • GET/chat-user/{chatUserUuid}Getting chat user by uuid
  • PUT/chat-user/{chatUserUuid}Updating chat user name by uuid

chat

  • GET/chat/by-source-threadGetting chat by source and thread
  • GET/chat/count/{chatUuid}Getting total message count in chat by uuid
  • GET/chat/statisticsGetting statistic for all user chats
  • GET/chat/v2Get chats v2
  • GET/chat/v3Get chats v3
  • GET/chat/{chatUuid}Getting chat by chat uuid
  • POST/chat/{chatUuid}/unreadMake chat unread

clean-up

  • POST/clean-up/deleteDataDelete data by userChannelUuid

Contact

  • POST/contactContact saving for certain user
  • GET/contact/countGetting count of contacts by filter
  • POST/contact/linkLinking chat users for certain contact
  • GET/contact/listGetting list of contacts by filter
  • GET/contact/sourcesGetting contact sources info by phone sorted by last message date in chat
  • GET/contact/unlink-preview/{chatUserUuid}Getting the contact a chat user would be linked to after unlinking, if any
  • POST/contact/unlink/{chatUserUuid}Unlinking chat user from certain contact
  • DELETE/contact/{contactUuid}Deleting certain contact
  • GET/contact/{contactUuid}Getting certain contact
  • PATCH/contact/{contactUuid}Contact updating for certain user
  • PATCH/contact/{contactUuid}/emailChange contact email
  • PATCH/contact/{contactUuid}/languageChange contact language
  • PATCH/contact/{contactUuid}/phoneChange contact phone

crm

  • GET/crmGet list of linked crms
  • POST/crm/linkLinking
  • GET/crm/linkedGet linked user uuid
  • POST/crm/unlinkUnlinking

Crm Sub User

  • GET/crm/sub-userGet list of linked crms
  • POST/crm/sub-user/link/{subUserUuid}Linking
  • GET/crm/sub-user/linkedGet linked user uuid
  • POST/crm/sub-user/unlink/{subUserUuid}Unlinking

delayed-message

  • POST/delayed-messageCreate delayed message
  • GET/delayed-message/{chatUuid}Getting list by chatUuid
  • DELETE/delayed-message/{delayedMessageUuid}Delayed message deletion
  • PATCH/delayed-message/{delayedMessageUuid}Update delayed message

FcmTokens

  • PUT/fcm-tokensRegister or update FCM token for current device

File Uploader

  • GET/file-uploader/payload/{fileOriginalName}

HealthCheck

  • GET/healthCheck if server is up

Hook Processing Health Check

  • GET/hook-processing/health-checkGet info about api hook statuses

hook

  • POST/hook/{userChannelUuid}Save hook from API

messenger

  • PATCH/messenger/chatUpdating chat state by uuid
  • POST/messenger/chat/list/closeClosing all user chats
  • POST/messenger/chat/list/seenMarking all unread chats as seen
  • POST/messenger/chat/pin/{chatUuid}Pin chat by uuid
  • POST/messenger/chat/seenMarking chat as seen
  • POST/messenger/chat/unpin/{chatUuid}Unpin chat by uuid
  • GET/messenger/check/send-firstCheck ability to send first by phone
  • GET/messenger/messageGet chat message by filter
  • GET/messenger/message/history-aroundGet history around certain message
  • GET/messenger/message/listGet messages
  • GET/messenger/message/pin/list/{chatUuid}Getting all pinned messages by chatUuid
  • POST/messenger/message/pin/{chatMessageUuid}Pinning or unpinning message
  • GET/messenger/message/search/global/{substring}Searching messages within all user's chats
  • GET/messenger/message/sequence/numberGet message sequence number
  • DELETE/messenger/noteDelete note
  • GET/messenger/note/contact/list/{contactUuid}Getting all notes by contact
  • GET/messenger/note/list/{chatUuid}Getting all notes by chat
  • POST/messenger/note/saveSave a note
  • POST/messenger/sendSend outgoing message to existing chat
  • POST/messenger/send/unexistOutgoing message sending to unexisting chat
  • GET/messenger/tags/{chatUuid}Get chat user tags by chatUuid
  • GET/messenger/template/listGet available message templates for a channel

check-messenger

  • GET/messenger/check/chatsValidate random chats
  • GET/messenger/check/messagesValidate random messages

rentinhand

  • POST/restinhand/authAuthorization

Settings

  • GET/settingsGetting user settings
  • POST/settingsSettings saving for certain user

Sub User

  • GET/sub-userGet list of extended sub users by filter
  • POST/sub-userSave sub user
  • GET/sub-user/countGet count of sub users by filter
  • GET/sub-user/listGet list of sub users by filter
  • GET/sub-user/static-token/{subUserUuid}Get static token of sub user
  • PATCH/sub-user/status/{subUserUuid}Update status of sub user
  • DELETE/sub-user/{subUserUuid}Delete sub user
  • GET/sub-user/{subUserUuid}Get extended sub user
  • PATCH/sub-user/{subUserUuid}Update sub user

Synchronization

  • POST/syncSynchronize chats by user

tag

  • DELETE/tagTag deletion
  • GET/tagGet all tags
  • POST/tagTag creation
  • POST/tag/assignTag assigning to contact
  • POST/tag/decoupleTag decoupling from contact
  • PATCH/tag/{tagUuid}Tag update

task-manager

  • POST/task-manager/creating-sync-chats-taskCreating sync chats task

Internal Template

  • GET/templateGet templates list
  • POST/templateCreate template
  • DELETE/template/{uuid}Delete template
  • PATCH/template/{uuid}Update template

test-integration

  • GET/test-integration/user-by-group-tokenGet main user by group token

user

  • DELETE/userDelete current user
  • PATCH/userUpdate user name
  • GET/user/meGet current user
  • GET/user/teamGet team members (root user and all sub-users)

User Channel

  • GET/user-channelGet user channels by filter
  • POST/user-channelAdd user channel
  • GET/user-channel/statusesGet user channels with statuses
  • DELETE/user-channel/{userChannelUuid}Delete user channel by uuid

User Channel Assignment

  • POST/user-channel-assignment/assignAssign user channel group by token on certain sub user
  • GET/user-channel-assignment/channel-groupsGet list of possible user channel groups for sub user
  • POST/user-channel-assignment/sync-chatsSynchronize chat access for certain sub user assignments
  • POST/user-channel-assignment/unassignUnassign user channel group by token from certain sub user

User Channel Group

  • GET/user-channel-groupGetting all user channel groups for certain user
  • POST/user-channel-groupUser channel group saving or updating for certain user
  • GET/user-channel-group/with-auto-reply-configGetting all user channel groups with auto reply config
  • DELETE/user-channel-group/{token}Deleting user channel group for certain user
  • GET/user-channel-group/{token}Getting user channel group for certain user

User Channel Group Distribution Settings

  • DELETE/user-channel-group-distribution-settings/group/{groupToken}Delete channel group settings
  • GET/user-channel-group-distribution-settings/group/{groupToken}Get channel group settings
  • PUT/user-channel-group-distribution-settings/group/{groupToken}Create or update channel group settings

User Contact Assignment

  • POST/user-contact-assignment/assignAssign sub-user to contact
  • POST/user-contact-assignment/unassignUnassign sub-user from contact

yc

  • POST/yc/authAuthorization