undefined

Chat API

ConnectyCube Chat (messaging) API consists of 2 parts: REST API and Real-Time (XMPP) API. This document describes the REST API part. To get an info about Real-Time (XMPP) API - please refer to Real-Time (XMPP) API documentation page.

Features

Robust, quick, ‘keep-alive’ connection. Unlimited concurrent connections thanks to ConnectyCube auto-scalable AWS powered cloud chat servers infrastructure.

  • 1:1 chat (private user to user chat)
  • Group chat (unlimited chat rooms)
  • Incoming chat alerts (push notifications) for offline users
  • File attachments - cloud hosted, so both users don’t have to be online to receive messages. Allow users to send photos, videos and other files.
  • Voice chat / call – enable 1:1 voice calls in the application
  • Video chat / call – enable video chats in the application
  • NAT traversal – our TURN server and optimization system take care of NAT traversal and traffic compression making sure your chat, voice and video traffic reaches all users across the networks with different configurations

Chat dialog model

Chat Dialog model describes a dialog between users. Dialog can have custom parameters (if available).

Chat model structure:

Field name Description
_id ID of dialog. Generated automatically by server after dialog is created
user_id ID of dialog's owner
created_at Unix timestamp. Date & time when record was created. System creates this parameter automatically
description Dialog description
updated_at Unix timestamp. Date & time when record was updated. System creates this parameter automatically
type Type of the dialog: type 1 - broadcast, type 2 - group chat, type 3 - private chat, type 4 - public chat
name Name of a group chat
photo Image of the chat. Can contain a link to a file in Connectycube storage, Custom Objects module or just a web link
xmpp_room_jid Jaber identifier of XMPP room for group chat to connect. Not applicable for private chat (type 3). Generated automatically by server after dialog is created
occupants_ids List of users in the chat. Applicable for private and group chats only
occupants_count Number of users in the public chat
admins_ids List of users who have admin rights
last_message Last message sent in the chat dialog
last_message_date_sent Date & time when the last message in the chat dialog was sent
last_message_id ID of the last message in the chat dialog
last_message_user_id ID of user who sent the last message in the chat dialog
unread_messages_count Number of unread messages in the dialog for current user
pinned_messages_ids IDs of messages pinned in the chat dialog

Message model

Chat Message model describes a chat message in a chat dialog.

Message model structure:

Field name Description
_id Message ID. Generated automatically by server after message is created
created_at Unix timestamp. Created by system automatically
updated_at Unix timestamp. Created by system automatically and is updated when the message is updated or read
chat_dialog_id ID of the dialog the current chat message is related to. Generated automatically by server after message is created
message Message body
date_sent Date when massage has been sent
sender_id ID of a user who sent a message
recipient_id ID of user who received a message
read_ids List of IDs of users who read the messages
delivered_ids List of users IDs a message was delivered to
views_count Number of views of the messages. Available for broadcast (type 1) and public chats (type 1)
attachments List of attachments. Each attachment object contains 3 keys: type (audio / video / image), id (link to file in Connectycube storage), url (link to file in the Internet)
Custom parameters Chat message can contain any other user custom parameters (additional metadata)

Roles and privileges

There are different roles of users in a chat dialog:

Regular user - user who can send and receive messages.

Admin - advanced user with moderation privileges.

Super admin - chat owner (creator) with all possible privileges.

Roles Private chat Group chat Public chat Broadcast
Regular user
  • send/receive messages
  • delete own message (one side/both sides)
  • delete chat dialog for themselves
  • send/receive messages
  • delete own message (one side/both sides)
  • delete chat dialog for themselves
  • add more users
  • change name, photo, description
  • send/receive messages
  • delete own message (one side/both sides)
  • delete chat dialog for themselves (or unsubscribe)
  • receive messages
  • delete chat dialog for themselves
  • Admin -
  • delete any messages for everyone
  • pin messages
  • add/remove users
  • regular user privileges
  • change name, description, photo
  • delete any messages for everyone
  • pin messages
  • block/unblock users
  • regular user privileges
  • change name, description, photo
  • delete any messages for everyone
  • pin messages
  • block/unblock users
  • Super admin -
  • add/remove admins
  • delete dialog for everyone
  • regular admin privileges
  • add/remove admins
  • delete dialog for everyone
  • regular admin privileges
  • add/remove admins
  • delete dialog for everyone
  • Retrieve chat dialogs

    Retrive all the dialogs associated with the current user. Server returns all dialogs where the current user's ID is in the list of 'occupants_ids' field (type 2, type 3) OR in the list of 'occupants_count' (type 4). Server identifies user ID with a session token. If there is a broadcast chat in the app, this chat will be retrieved for all users.

    Retrieving of chat dialogs is possible by specifying one or more custom parameter(s).

    Endpoint
    GET https://api.connectycube.com/chat/Dialog
    Parameters
    Operator Applied fields Description Value example
    {field_name} _id, type, name, last_message_date_sent, created_at, updated_at Search dialogs with the exact data specified in the request with applying sorting. Filters available to apply: lt (Less Than), lte (Less Than or Equal to), gt (Greater Than), gte (Greater Than or Equal to), ne (Not Equal to), in (Contained IN array), nin (Not contained IN array), all (ALL contained IN array), ctn (Contains substring operator) type[in]=2,4
    limit standalone operator Setting of limit for a number of search results to display. Default - 100 limit=70
    skip standalone operator Skip the defined number of records in the search results. By default all records are shown skip=20
    count standalone operator Count search results. Response will contain only count of records found. count=1
    sort_desc/sort_asc last_message_date_sent Sorting of query result set in ascending / descending order sort_desc=date_sent
    Request Example
    curl -X GET \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Dialog
    Response
    {
        "total_entries": 4,
        "skip": 0,
        "limit": 1000,
        "items": [
            {
                "_id": "5c094c0ce588ce6856f87422",
                "admins_ids": [29085],
                "created_at": "2018-12-06T16:19:24Z",
                "description": "Cute chat",
                "last_message": "nope?",
                "last_message_date_sent": 1544452627,
                "last_message_id": "5c0e7a13e588ce6b6f3ebf80",
                "last_message_user_id": 29086,
                "name": "hello kitty",
                "occupants_ids": [
                    29085,
                    29086,
                    29087
                ],
                "photo": null,
                "pinned_messages_ids": ["5c0e7a13e588ce6b6f3ebf80"],
                "type": 2,
                "updated_at": "2018-12-10T14:37:07Z",
                "user_id": 29085,
                "unread_messages_count": 1,
                "xmpp_room_jid": "105_5c094c0ce588ce6856f87422@muc.chatstage.connectycube.com"
            },
            ...
        ]
    }

    Create a dialog

    There are four types of dialogs available to be created:

    • type=1 - broadcast - type of chat where a message is sent to all users within application at once. All the users from the application are able to join this group.

      Max users count - all chat users

      Roles: 1 Super Admin (chat creator) and up to 5 admins

    • type=2 - group chat - type of chat where one user creates chat with other users. More users can be added later. All messages in chat have read / delivered status

      Max users count - according to Plans

      Roles: 1 Super Admin (chat creator) and up to 5 admins

    • type=3 - private chat between 2 users. If user sends a chat message to some user and private dialog isn't created - it will be created automatically with the first chat message. All messages in chat have read / delivered status

      Max users count - 2

      Roles: two regular users

    • type=4 - public chat - type of chat where any user can subscribe via public link.

      Max users count - according to Plans

      Roles: 1 Super Admin (chat creator) and up to 5 admins

    Endpoint
    POST https://api.connectycube.com/chat/Dialog
    Parameters
    Parameter Required Description
    type Yes Type of new dialog. Possible values: 1 - broadcast, 2 - group chat, 3 - private 1-to-1 chat, 4 - public chat
    occupants_ids Yes, for group (type 2) and private (type 3) chats List of users who are able to chat. The current user is added automatically, no need to specify his ID in the occupant_ids
    name Yes, for broadcast (type 1), public (type 4) and group (type 2) chats Name of a dialog. Ignored for private chats (type 3)
    photo No Dialog image. Ignored for private chats (type 3)
    description No Dialog description
    Custom parameters

    Dialogs can have additional (or custom) parameters to store additional information. These parameters can be used as a value for retriving dialogs.

    To start using custom parameters, an additional schema of these parameters should be created first. This is a CustomObjects empty class with all needed fields. These fields will be additional parameters for a dialog.

    To set additional parameters to dialog, the following parameters should be used in the request of dialog creation:

    • data[class_name] - should contain CustomObjects class name created for additional parameters
    • data[field1]
    • data[...]
    • data[fieldN]
    Request example
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"type":2,"name":"Friday party","occupants_ids":"29085,29086,29087","description":"lets dance the night away","photo":"party.jpg"}' \
    https://api.connectycube.com/chat/Dialog
    Response
    {
        "_id": "5c091060e588ce59fdf873dc",
        "admins_ids": [],
        "created_at": "2018-12-06T12:04:48Z",
        "description": "lets dance the night away",
        "last_message": null,
        "last_message_date_sent": null,
        "last_message_id": null,
        "last_message_user_id": null,
        "name": "Friday party",
        "occupants_ids": [
            29085,
            29086,
            29087
        ],
        "photo": "party.jpg",
        "pinned_messages_ids": [],
        "type": 2,
        "updated_at": "2018-12-06T12:04:48Z",
        "user_id": 29085,
        "unread_messages_count": 0,
        "xmpp_room_jid": "105_5c091060e588ce59fdf873dc@muc.chatstage.connectycube.com"
    }

    Update a dialog

    Based on the roles and privileges, users with different roles can update different data.

    Endpoint
    PUT https://api.connectycube.com/chat/Dialog/{dialog_id}
    Parameters
    Parameter Description Value example
    occupants_ids Add / delete occupants in the dialog
  • {"push_all": {"occupants_ids": ["id_1","id_2"]}}
  • "pull_all": {"occupants_ids": ["id_1","id_2"]}
  • pinned_messages_ids Make messages pinned / unpinned in the chat history
  • {"push_all": {"pinned_messages_ids": ["pinned_message_id_1", "pinned_message_id_2"]}}
  • {"pull_all": {"pinned_messages_ids": ["pinned_message_id_1", "pinned_message_id_2"]}}
  • admins_ids Add / delete admins in the dialog
  • {"push_all": {"admins_ids": [admin_id_1]}}
  • {"pull_all": {"admins_ids": [admin_id_1]}}
  • name Name of the dialog {"name": "dialog_name"}
    photo Photo of the dialog {"photo": "image.jpg"}
    description Description of the dialog {"description": "Chat for Java developers"}
    Custom parameters

    To update additional parameters in a dialog use next parameters in a request:

    Request example
    curl -X PUT \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"name":"Crossfit2","push_all":{"occupants_ids":[29088],"pinned_messages_ids":["5c123fdce588ce064043f53a"]},"photo":"gym2.jpeg"}' \
    https://api.connectycube.com/chat/Dialog/5c123f75e588ce063e43f541
    Response
    {
        "_id": "5c123f75e588ce063e43f541",
        "admins_ids": [],
        "created_at": "2018-12-13T11:16:05Z",
        "description": "strong man",
        "last_message": "cool",
        "last_message_date_sent": 1544699868,
        "last_message_id": "5c123fdce588ce064043f53a",
        "last_message_user_id": 29085,
        "name": "Crossfit2",
        "occupants_ids": [
            29085,
            29086,
            29087,
            29088
        ],
        "photo": "gym2.jpeg",
        "pinned_messages_ids": [
            "5c123fdce588ce064043f53a"
        ],
        "type": 2,
        "updated_at": "2018-12-13T11:21:21Z",
        "user_id": 29085,
        "unread_messages_count": 0,
        "xmpp_room_jid": "105_5c123f75e588ce063e43f541@muc.chatstage.connectycube.com"
    }

    Delete dialog

    Each user from 'occupant_ids' (type=) can remove the dialog. Dialog will be removed for the current user only and will continue to be available for other users in the group.

    To remove a dialog completely, set force=1 parameter in the DELETE request. Only owner can do this.

    Delete single dialog

    Endpoint
    DELETE https://api.connectycube.com/chat/Dialog/{dialog_id}
    Request example
    curl -X DELETE \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Dialog/5c091060e588ce59fdf873dc
    Response
    200 OK

    Delete several dialogs

    Endpoint
    DELETE https://api.connectycube.com/chat/Dialog/{dialog1_id},{dialog2_id}
    Request example
    curl -X DELETE \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Dialog/23thnu15e4b077ddd43e7db7,499abe15e4b077ddd43e7b5h
    Response
    {
      "SuccessfullyDeleted": {
        "ids": [
          "23thnu15e4b077ddd43e7db7"
        ]
      },
      "NotFound": {
        "ids": [
          "499abe15e4b077ddd43e7b5h"
        ]
      }
    }

    Subscribe to public dialog

    Add user to the list of occupants. Applicable for public dialogs (type=4) only.

    Endpoint
    POST https://api.connectycube.com/chat/Dialog/{dialog_id}/subscribe
    Request example
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Dialog/5c091822e588ce6856f873de/subscribe
    Response
    {
        "_id": "5c091822e588ce6856f873de",
        "admins_ids": [],
        "created_at": "2018-12-06T12:37:54Z",
        "description": "good news",
        "last_message": null,
        "last_message_date_sent": null,
        "last_message_id": null,
        "last_message_user_id": null,
        "name": "Public chat",
        "occupants_count": 2,
        "occupants_ids": [],
        "photo": null,
        "pinned_messages_ids": [],
        "type": 4,
        "updated_at": "2018-12-06T12:40:03Z",
        "user_id": 28926,
        "unread_messages_count": null,
        "xmpp_room_jid": "105_5c091822e588ce6856f873de@muc.chatstage.connectycube.com"
    }

    Unsubsribe from public dialog

    Remove user from the list of occupants. Applicable for public dialogs (type=4) only.

    Endpoint
    DELETE https://api.connectycube.com/chat/dialog/{dialog_id}/subscribe
    Request example
    curl -X DELETE \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/dialog/5c091822e588ce6856f873de/subscribe
    Response
    200 OK

    Add / Remove admins

    Options to add or remove admins from the dialog can be done by Super admin (dialog's creator) only. Options are supported in group chat, public or broadcast.

    Up to 5 admins can be added to chat.

    Endpoint
    PUT https://api.connectycube.com/chat/Dialog/{dialog_id}/admins
    Parameters
    Parameter Description Value example
    push_all[admins_ids][] Add admin(s) to the chat. Several admin IDs can be specified separated by comma {"push_all": {"admins_ids":[admin_id_1]}}
    pull_all[admins_ids][] Remove admin(s) from the chat. Several admin IDs can be specified separated by comma {"pull_all":{"admins_ids": [admin_id_1]}}
    Request example
    curl -X PUT \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"push_all": {"admins_ids": [29087]}}' \
    https://api.connectycube.com/chat/Dialog/5c093376e588ce6856f873fe/admins
    Response
    {
        "_id": "5c093376e588ce6856f873fe",
        "admins_ids": [
            29087
        ],
        "created_at": "2018-12-06T14:34:30Z",
        "description": "admins only",
        "last_message": null,
        "last_message_date_sent": null,
        "last_message_id": null,
        "last_message_user_id": null,
        "name": "Friday party",
        "occupants_ids": [
            29085,
            29086,
            29087
        ],
        "photo": null,
        "pinned_messages_ids": [],
        "type": 2,
        "updated_at": "2018-12-06T14:42:25Z",
        "user_id": 29085,
        "unread_messages_count": null,
        "xmpp_room_jid": "105_5c093376e588ce6856f873fe@muc.chatstage.connectycube.com"
    }

    Update notifications settings

    User can turn on/off push notifications for offline messages in a dialog. By default push notification are turned ON, so offline user receives push notifications for new messages in a chat if notifications setting wasn't changed.

    Endpoint
    PUT https://api.connectycube.com/chat/Dialog/{dialog_id}/notifications
    Parameters
    Parameter Value Description
    enabled 0 or 1 Enable/ Disable notifications
    Request example
    curl -X PUT \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"enabled":"0"}'
    https://api.connectycube.com/chat/Dialog/5c093376e588ce6856f873fe/notifications
    Response
    {
      "notifications": {
        "enabled": 0
      }
    }

    Get notifications settings

    Check a status of notifications setting - either it is ON or OFF for a particular chat.

    Available responses: 1 - enabled, 0 - disabled.

    Endpoint
    GET https://api.connectycube.com/chat/Dialog/{dialog_id}/notifications
    Request example
    curl -X GET \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Dialog/5c093376e588ce6856f873fe/notifications
    Response
    {
      "notifications": {
        "enabled": 1
      }
    }

    Retrieve messages

    Retrieve all chat messages within a particular dialog. For broadcast chat (type=1) all users within the app can see messages from the dialog. To retrieve chat messages from group chat (type=2) and privat chat (type=3) user's IDs should be in occupants_ids field, whereas for public chat (type=4) user's IDs should belong to occupants_count field. Server will return dialog's chat messages sorted ascending by date_sent field (default sort is applied and can be changed if required).

    Note: All retrieved chat messages will be marked as read after the request.

    Endpoint
    GET https://api.connectycube.com/chat/Message
    Parameters
    Operator Applied fields Description Value example
    {field_name} _id, message, date_sent, sender_id, recipient_id, attachments.type, updated_at Search dialogs with the exact data specified in the request recipient_id=546
    {field_name}[{search_operator}] _id, message, date_sent, sender_id, recipient_id, attachments.type, updated_at Search dialogs with the exact data specified in the request with applying sorting. Filters available to apply: lt (Less Than operator), lte (Less Than or Equal to operator), gt (Greater Than operator), gte (Greater Than or Equal to operator), ne (Not Equal to operator), in (Contained IN array operator), nin (Not contained IN array), all (ALL contained IN array), ctn (Contains substring operator) sender_id[lt]=132
    limit standalone operator Set limit for a number of search results. Default - 100 limit=50
    skip standalone operator Skip the defined number of records in the search results. By default all records are shown skip=30
    count standalone operator Count search results. Response will contain only count of records found count=1
    sort_desc/sort_asc date_sent Sorting of query result set in ascending / descending order sort_asc=date_sent
    mark_as_read Do not mark the received messages as read. To do not mark retrieved messages as ‘read’, mark_as_read parameter should be set to 0 mark_as_read=0
    Request example
    curl -X GET \
    -H "CB-Token: <TOKEN>" \
    -d 'chat_dialog_id=5c093376e588ce6856f873fe' \
    https://api.connectycube.com/chat/Message
    Response
    {
        "skip": 0,
        "limit": 1000,
        "items": [
            {
                "_id": "5c094682e588ce59fff87424",
                "attachments": [],
                "chat_dialog_id": "5c093376e588ce6856f873fe",
                "created_at": "2018-12-06T15:55:46Z",
                "date_sent": 1544111746,
                "delivered_ids": [
                    29085,
                    29086
                ],
                "message": "What's the price of it?",
                "read_ids": [
                    29085,
                    29086
                ],
                "recipient_id": 0,
                "sender_id": 29085,
                "updated_at": "2018-12-06T16:05:21Z",
                "views_count": 0,
                "read": 0
            },
            {
                "_id": "5c094687e588ce59fff87425",
                "attachments": [],
                "chat_dialog_id": "5c093376e588ce6856f873fe",
                "created_at": "2018-12-06T15:55:51Z",
                "date_sent": 1544111751,
                "delivered_ids": [
                    29085,
                    29086
                ],
                "message": "Hello Daniel, how things are going on?",
                "read_ids": [
                    29085,
                    29086
                ],
                "recipient_id": 0,
                "sender_id": 29085,
                "updated_at": "2018-12-06T16:05:21Z",
                "views_count": 0,
                "read": 0
            }
      ]
    }

    Retrieve unread messages count

    Retrieve the number of unread chat messages, split across dialogs or just a total number.

    Endpoint
    GET https://api.connectycube.com/chat/Message/unread
    Parameters
    Operator Description Value example
    chat_dialog_ids List of dialogs to retrieve the number of unread messages. To receive the total number of the unread messages, do not use this parameter chat_dialog_ids=id_1,id_2
    Request example
    curl -X GET \
    -H "CB-Token: <TOKEN>" \
    -d 'chat_dialog_ids=5c093376e588ce6856f873fe,76ok0l3e989c12a0e45432a7' \
    https://api.connectycube.com/chat/Message/unread
    Response
    {
      "total": 5,
      "53aadc78535c127f15009b6c": 3,
      "76ok0l3e989c12a0e45432a7": 2
    }

    Create a message

    Create a chat message to add it to the chat history. Created message won't be delivered to the recipient(s) by Real-Time (XMPP) transport and will be just added to the chat history.

    To initiate a real sending to the chat - pass send_to_chat=1 parameter.

    Endpoint
    POST https://api.connectycube.com/chat/Message
    Parameters
    Parameter Required Description Value example
    chat_dialog_id yes, if the recipient_id key is not specified ID of a dialog where a new message will be added {"chat_dialog_id": "5bec0186e588ce7ff1c0ad0a"}
    message no text of the message (CGI-escaped) {"message": "Hi! How are you doing?"}
    recipient_id yes, if the 'chat_dialog_id' key is not specified ID of a recipient. Useful for private chats only (type 3) {"recipient_id": "4377"}
    attachments[n][type/id/url] no List of attachments. Each attachment object contains 3 keys: type (audio/video/image/...), id (link to file ID in Connectycube), url (link to file in the Internet) {"attachments": {"0": {"type": "image", "id": "654645"}, "1": {"type": "video", "id": "654646"}}}
    Custom parameters no Key-value parameters. Chat message can contain any other custom parameters {"country": "USA"}
    send_to_chat no Send message to chat. Should be set to 1 if message should be sent {"send_to_chat": "1"}
    markable no Mark message to be processed as read / delivered statuses on a client side {"markable": "1"}
    Request example
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"chat_dialog_id": "5c094c0ce588ce6856f87422", "message": "where are you?", "recipient_id": 29086, "attachments": {"3":  {"type": "image", "id": "3004"}, "7": {"type": "image", "id": "24504"}}}' \
    https://api.connectycube.com/chat/Message
    Response
    {
        "_id": "5c094e30e588ce59fff87431",
        "attachments": [
            {
                "type": "image",
                "id": "3004"
            },
            {
                "type": "image",
                "id": "24504"
            }
        ],
        "chat_dialog_id": "5c094c0ce588ce6856f87422",
        "created_at": "2018-12-06T16:28:32Z",
        "date_sent": 1544113712,
        "delivered_ids": [
            29086
        ],
        "message": "where are you?",
        "read_ids": [
            29086
        ],
        "recipient_id": 29086,
        "sender_id": 29086,
        "updated_at": "2018-12-06T16:28:32Z",
        "views_count": 0,
        "read": 0
    }

    Update message

    Update of sent chat message. Message body and message status can be updated.

    It's possible to mark all messages as read / delivered - just don't pass a message id.

    Endpoint
    PUT https://api.connectycube.com/chat/Message/{message_id}
    Parameters
    Field Description Example
    chat_dialog_id Dialog’s id which message is updated {"chat_dialog_id": "5b7411335bd08d0e5761bc96"}
    read Mark message as read {"read":"1"}
    delivered Mark message as delivered {"delivered": "1}
    message Updated message body {"message": "Morning"}
    Request example
    curl -X PUT \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    -d '{"read": "1", "chat_dialog_id": "5c094c0ce588ce6856f87422"}'\
    https://api.connectycube.com/chat/Message/5c094e30e588ce59fff87431
    Response
    200 OK

    Delete message

    Remove of a chat message for the current user in a specified chat dialog.

    There are some rules for removing messages depending the type of the dialog:

    • For broadcast chat (type=1) only Super admin and admins are able to remove messages from the dialog. General users are readers only.

    • For group chat (type=2) any user in the dialog’s occupant_ids is able to remove a message from the dialog. The message will only be removed for the current user - the message will still be viewable in the chat history for all other users in the dialog. To remove a message completely, force=1 parameter should be set. Super admin and admins can remove all messages from the dialog, whereas general users are able to remove only own message for all users with force=1 parameter, but other users messages can remove only for themselves.

    • For private chat (type=3) users are able remove their own messages from the history. Users can remove messages both, without affecting the history of other user, and, as well as completely remove a message. To remove message for both sides force=1 parameter should be set for own messages.

    • For public chat (type=4) any user in the dialog’s occupants_count is able to remove a message from the dialog. The message will only be removed for the current user - the message will still be viewable in the chat history for all other users in the dialog. To remove a message completely, force=1 parameter should be set. Super admin and admins can remove all messages from the dialog, whereas general users are able to remove only own message for all users with force=1 parameter, but other users messages can remove only for themselves.

    Endpoint
    DELETE https://api.connectycube.com/chat/Message/{message1_id},{message2_id}
    Request example
    curl -X DELETE \
    -H "CB-Token: <TOKEN>" \
    https://api.connectycube.com/chat/Message/5c094687e588ce59fff87425,5c094682e588ce59fff87424
    Response
    200 OK

    It helps to find some messages and chat dialogs.

    Endpoint
    GET https://api.connectycube.com/chat/search
    Parameters
    Field Required Description Value example
    search_text Yes String or word. Should be longer than 4 symbols. Performs 'or' seach. For an exact search, you need to wrap the search phrase in quotes. search_text="lorem%20ipsum"
    chat_dialog_ids No List of dialog ids separated by comas. Max cam include 10 items. chat_dialog_ids=5c49cb855368b57a05dc5872
    start_date No Closest date to Time.now. Uses lte comparison. start_date=2016-03-23T170042Z
    end_date Yes, if start_date passed Shouldn't differ by more than 3 months from the start_date. Uses gte comparison. start_date=2016-01-23T170042Z
    limit No Maximum number of items returned from the server in the search results. Max value - 100 limit=3
    Request example
    curl -X GET \
    -H "Content-Type: application/json" \
    -H "CB-Token: <TOKEN>" \
    'https://api.connectycube.com/chat/search?search_text=lorem%20ipsum&limit=3'
    Response
    {
     "results": {
       "dialogs":   [
        {
          "_id": "5c4867115368b52b3f5c6b16",
          "admins_ids": [],
          "created_at": "2019-01-23T13:07:29Z",
          "description": null,
          "last_message": null,
          "last_message_date_sent": null,
          "last_message_id": null,
          "last_message_user_id": null,
          "name": null,
          "occupants_ids": [
            23,
            2172
          ],
          "photo": null,
          "pinned_messages_ids": [],
          "type": 3,
          "updated_at": "2019-01-23T13:07:29Z",
          "user_id": 2172,
          "unread_messages_count": null,
          "xmpp_room_jid": null
        }
      ],
       "messages":   [
        {
          "_id": "5c49ccef5368b57a05dc5877",
          "attachments": [],
          "chat_dialog_id": "5c49cb855368b57a05dc5872",
          "created_at": "2019-01-24T14:34:23Z",
          "date_sent": 1548340463,
          "delivered_ids": [
            2172
          ],
          "message": "Ipsa tempore vitae earum sequi aut velit qui.",
          "read_ids": [
            2172
          ],
          "recipient_id": 0,
          "sender_id": 2172,
          "updated_at": "2019-01-24T14:34:23Z",
          "views_count": 0,
          "read": 0
        },
        {
          "_id": "5c49cd815368b57a05dc5882",
          "attachments": [],
          "chat_dialog_id": "5c49cb855368b57a05dc5872",
          "created_at": "2019-01-24T14:36:49Z",
          "date_sent": 1548340609,
          "delivered_ids": [
            2172
          ],
          "message": "Incidunt maxime sapiente cum est dolor fugit.",
          "read_ids": [
            2172
          ],
          "recipient_id": 0,
          "sender_id": 2172,
          "updated_at": "2019-01-24T14:36:49Z",
          "views_count": 0,
          "read": 0
        },
        {
          "_id": "5c49cd825368b57a05dc5885",
          "attachments": [],
          "chat_dialog_id": "5c49cb855368b57a05dc5872",
          "created_at": "2019-01-24T14:36:50Z",
          "date_sent": 1548340610,
          "delivered_ids": [
            2172
          ],
          "message": "Aut quod aperiam optio.",
          "read_ids": [
            2172
          ],
          "recipient_id": 0,
          "sender_id": 2172,
          "updated_at": "2019-01-24T14:36:50Z",
          "views_count": 0,
          "read": 0
        }
      ],
      "users": [
        {
          "user": {
            "id": 23,
            "full_name": "Ms. Devin Kling",
            "email": "jayden@vandervortkirlin.name",
            "login": "Vaporeon96",
            "phone": null,
            "website": null,
            "created_at": "2018-06-11T14:04:18Z",
            "updated_at": "2018-06-11T14:04:18Z",
            "last_request_at": null,
            "external_user_id": null,
            "facebook_id": null,
            "twitter_id": null,
            "custom_data": null,
            "blob_id": null,
            "avatar": null,
            "user_tags": "name,age"
          }
        },
        {
          "user": {
            "id": 2172,
            "full_name": "Marcus Cronin",
            "email": "kayli@zulauf.name",
            "login": "Slowbro2",
            "phone": null,
            "website": null,
            "created_at": "2018-11-30T15:40:50Z",
            "updated_at": "2019-01-28T15:55:44Z",
            "last_request_at": "2019-01-28T15:55:44Z",
            "external_user_id": null,
            "facebook_id": null,
            "twitter_id": null,
            "custom_data": null,
            "blob_id": null,
            "avatar": null,
            "user_tags": ""
          }
        }
      ]
     }
    }