Skip to main content

Interface: CallsAddArguments

Extends

  • Partial<Users>.CallDetails.TokenOverridable

Properties

created_by?

optional created_by: string;

Description

ID of the user who created this Call. When this method is called with a user token, this field is optional and defaults to the authed user of the token. Otherwise, the field is required.

Defined in

packages/web-api/src/types/request/calls.ts:37


date_start?

optional date_start: number;

Description

Unix timestamp of the call start time.

Defined in

packages/web-api/src/types/request/calls.ts:39


desktop_app_join_url?

optional desktop_app_join_url: string;

Description

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

Inherited from

CallDetails.desktop_app_join_url

Defined in

packages/web-api/src/types/request/calls.ts:22


external_display_id?

optional external_display_id: string;

Description

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

Defined in

packages/web-api/src/types/request/calls.ts:44


external_unique_id

external_unique_id: string;

Description

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

Defined in

packages/web-api/src/types/request/calls.ts:32


join_url

join_url: string;

Description

The URL required for a client to join the Call.

Inherited from

CallDetails.join_url

Defined in

packages/web-api/src/types/request/calls.ts:17


title?

optional title: string;

Description

The name of the Call.

Inherited from

CallDetails.title

Defined in

packages/web-api/src/types/request/calls.ts:24


token?

optional token: string;

Description

Overridable authentication token bearing required scopes.

Inherited from

TokenOverridable.token

Defined in

packages/web-api/src/types/request/common.ts:43


users?

optional users: CallUser[];

Description

The list of users to add/remove to/from the Call.

See

Using the Calls API: a note on Users.

Inherited from

Partial.users

Defined in

packages/web-api/src/types/request/calls.ts:13