Execute command's preview item

Prev Next
Post
/api/v1/commands.preview

Changelog

Version Description
3.0.0 Added tmid and triggerId fields
0.65.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example
{
  "command": "unmute",
  "roomId": "ByehQjC44FwMeiLbX",
  "tmid": "Hsj2435g4bvrj4bjh",
  "params": "@user123",
  "triggerId": "awovufbukuefzuper",
  "previewItem": {
    "id": "nucobdipokaikazia",
    "type": "image",
    "value": "https://dev.null/gif"
  }
}
Expand All
object
command
string Required

The name of the command to be executed.

roomId
string Required

The ID of the room.

tmid
string Required

The ID of the thread to run the command.

params
string

Parameters of the command if required. It is undefined by default.

triggerId
string

The triggerId generated by the client that allows the command to interact with the UI

previewItem
object Required

The data of the preview item to be executed by the command

id
string Required

The ID of the selected preview item

type
string Required

The type of the selected preview item

value
string Required

The value of the selected preview item

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "You must provide a command to run the preview item on."
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string