Open Context Protocol is live! 🚀 Read the launch post

callsAdd

Registers a new Call.

Details

  • Method: POST
  • Path: /calls.add
  • Operation ID: calls_add

Parameters

{
  "token": {
    "description": "Authentication token. Requires scope: `calls:write`",
    "required": true,
    "location": "header",
    "type": "string"
  },
  "external_unique_id": {
    "description": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.",
    "required": true,
    "location": "formData",
    "type": "string"
  },
  "external_display_id": {
    "description": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "join_url": {
    "description": "The URL required for a client to join the Call.",
    "required": true,
    "location": "formData",
    "type": "string"
  },
  "desktop_app_join_url": {
    "description": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "date_start": {
    "description": "Call start time in UTC UNIX timestamp format",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "title": {
    "description": "The name of the Call.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "created_by": {
    "description": "The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.",
    "required": false,
    "location": "formData",
    "type": "string"
  },
  "users": {
    "description": "The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).",
    "required": false,
    "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('callsAdd', {
    # Add required parameters here
})