Slack: Registers a new Call

← Calls operations · Get started

Operation slack.calls_add

Provider route: POST /calls.add. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/slack with npm, or alter-sdk-slack with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SlackIntegration } from "@alter-ai/slack";

async function execute(input: Parameters<SlackIntegration["calls"]["add"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SlackIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.calls.add(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_slack import SlackIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SlackIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.calls.add(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent
body.created_by	string	Optional	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.
body.date_start	integer	Optional	Unix timestamp of the call start time
body.desktop_app_join_url	string	Optional	When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
body.external_display_id	string	Optional	An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
body.external_unique_id	string	Required within parent	An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
body.join_url	string	Required within parent	The URL required for a client to join the Call.
body.title	string	Optional	The name of the Call.
body.users	string	Optional	The list of users to register as participants in the Call. Read more on how to specify users here.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	This method either only returns a brief OK response or a verbose schema is not available for this method. Additional keys: allowed
ok	boolean	Required within parent	Must equal: true

Policy, approvals and errors

SDK function policy ID: slack.calls_add. Catalog operation: calls_add. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["calls:write"]

Official provider source