Websocket

Client user

Conversations subscriptions

These emit actions are triggered by the client in order to manage the current socket subscriptions to conversations.

emit subscribe

{
    "authorization": "Bearer <token>", // Client conversation token
}

emit unsubscribe

{
    "authorization": "Bearer <token>", // Client conversation token
}

The Client conversation token is provided at the signup call

Conversations messages

This event is triggered from Quicktext to send messages to Clients instantly.

on message

{
    "conversation_id": "",
    "from": {
        "id": "",
        "type": "", // "bot", "user", "app"
        "name": "",
        "picture": ""
    },
    "content": {} // See message formats below
}

Message formats

Test env

You can test the socket using this tool, and subscribe to conversations.

Member user

Authenticate

Authenticate the user and register the connected socket to receive messaging events.

emit authorize

{
    "authorization": "Bearer <token>", // User token
}

The User token is provided at login call

Conversations messages

This event is triggered from Quicktext to send messages to device instantly.

on message

{
    "team_id": "",
    "conversation": {
        "id": "",
        "channels": [
            "" // id
        ]
    },
    "channel_id": "",
    "from": {
        "type": "", // client, bot, app, ...
        "id": "",
        "name": "",
        "phone_number": "",
        "email": ""
    },
    "content": {} // See message formats below
}

Message formats

Message status

This event is triggered from Quicktext to update messages statuses.

on message.status

{
    "status": "", // sent, delivered, read, unreachale
    "message_id": "",
    "conversation_id": "",
    "team_id": ""
}

Test env

You can test the socket using this tool, and authenticate.