Skip to main content

Interface: CallsAddArguments

Defined in: packages/web-api/src/types/request/calls.ts:28

Extends​

  • Partial<Users>.CallDetails.TokenOverridable

Properties​

created_by?​

optional created_by: string;

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

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.

date_start?​

optional date_start: number;

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

Description​

Unix timestamp of the call start time.

desktop_app_join_url?​

optional desktop_app_join_url: string;

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

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

external_display_id?​

optional external_display_id: string;

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

Description​

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

external_unique_id​

external_unique_id: string;

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

Description​

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

join_url​

join_url: string;

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

Description​

The URL required for a client to join the Call.

Inherited from​

CallDetails.join_url

title?​

optional title: string;

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

Description​

The name of the Call.

Inherited from​

CallDetails.title

token?​

optional token: string;

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

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

users?​

optional users: CallUser[];

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

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