Skip to content

Giosg client API

Giosg client API

POST /api/v5/orgs/<organization_id>/users/<user_id>/giosg_client/execute

With this API you can command certain users' giosg client to do specified tasks or commands. For now the only supported command is “open_chat” which will open the given chats’ chat window for the user.

Request payload

Attribute Type Required Description
type string true Type of command. Currently only supported type is "open_Chat".
parameters object true Object which contains the following values: "chat_id": string - Chat uuid and "focus": boolean - Will the opened panel take focus automatically after it has been opened.

Example request payload

1
2
3
4
5
6
7
{
    "type": "open_chat",
    "parameters": {
        "chat_id": "61be73d3-51fc-4acd-958f-aaaaaaaaaaaa",
        "focus": false
    }
}