callsParticipantsRemove
Registers participants removed from a Call.
Details
- Method:
POST - Path:
/calls.participants.remove - Operation ID:
calls_participants_remove
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `calls:write`",
"required": true,
"location": "header",
"type": "string"
},
"id": {
"description": "`id` returned by the [`calls.add`](/methods/calls.add) method.",
"required": true,
"location": "formData",
"type": "string"
},
"users": {
"description": "The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).",
"required": true,
"location": "formData",
"type": "string"
}
}Response Schema
{
"additionalProperties": true,
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
}
},
"required": [
"ok"
],
"title": "Default success template",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('callsParticipantsRemove', {
# Add required parameters here
})