Post
/api/v1/commands.run
Execute a slash command in the specified room.
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Added triggerId property |
| 2.0.0 | Added tmid property |
| 0.60.2 | 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
Success
{
"command": "unmute",
"roomId": "ByehQjC44FwMeiLbX",
"params": "@user123",
"tmid": "Hsj2435g4bvrj4bjh",
"triggerId": "awovufbukuefzuper"
}object
command
string Required
The name of the command to be executed.
roomId
string Required
The ID of the room.
params
string
Parameters of the command if required. It is undefined by default
tmid
string
The ID of the thread to run the command.
triggerId
string
The triggerId generated by the client that allows the command to interact with the UI
Responses
200
OK
Success
{
"success": true
}object
success
boolean