Calls

Calls Add

POST
/calls.add

Registers a new Call.

Authorization

slackAuth calls:write
AuthorizationBearer <token>

In: header

Scope: calls:write

Header Parameters

token*string

Authentication token. Requires scope: calls:write

Content-Type*"application/x-www-form-urlencoded"

Value in

  • "application/x-www-form-urlencoded"

Request Body

application/x-www-form-urlencoded

external_unique_id*string

An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.

external_display_id?string

An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.

join_url*string

The URL required for a client to join the Call.

desktop_app_join_url?string

When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

date_start?integer

Call start time in UTC UNIX timestamp format

Formatint32
title?string

The name of the Call.

created_by?string

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.

users?string

The list of users to register as participants in the Call. Read more on how to specify users here.

Response Body

application/json

application/json

curl -X POST "https://example.com/calls.add" \  -H "token: string" \  -H "Content-Type: application/x-www-form-urlencoded" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'external_unique_id=string&join_url=string'
{  "ok": "True"}