Post
/api/v1/method.call/{method}
Execute a realtime API method.
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
method
stringRequired
The Metoer method
ExamplecreateChannel
Body parameters
Example
{
"message": "{\"msg\":\"method\",\"method\":\"createChannel\",\"id\":\"2\",\"params\":[\"test-websocket\",[\"doe.john\"],false]}"
}object
message
string Required
The method call message.
Responses
200
Example
{
"message": "{\"msg\":\"result\",\"id\":\"2\",\"result\":{\"rid\":\"67937a74f7ca7be1b5fcf599\",\"inserted\":true,\"_id\":\"67937a74f7ca7be1b5fcf599\",\"_updatedAt\":{\"$date\":1737718388248},\"fname\":\"test-websocket\",\"name\":\"test-websocket\",\"t\":\"c\",\"msgs\":0,\"usersCount\":0,\"u\":{\"_id\":\"P2dgWPPw5veigwcdK\",\"username\":\"funke.olasupo\",\"name\":\"Funke Olasupo\"},\"ts\":{\"$date\":1737718388248},\"ro\":false,\"default\":false,\"sysMes\":true}}",
"success": true
}object
message
string
success
boolean