Slack.Web.Calls (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Returns information about a Call.

Updates information about a Call.

Functions

add(external_unique_id, join_url, optional_params \\ %{})

Registers a new Call.

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • external_unique_id - An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. ex: 025169F6-E37A-4E62-BB54-7F93A0FC4C1F
  • join_url - The URL required for a client to join the Call. ex: https://example.com/calls/1234567890

Optional Params

  • created_by - 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. ex: U1H77
  • date_start - Unix timestamp of the call start time ex: 1562002086
  • desktop_app_join_url - When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. ex: callapp://join/1234567890
  • external_display_id - An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object. ex: 705-292-868
  • title - The name of the Call. ex: Kimpossible sync up
  • users - The list of users to register as participants in the Call. Read more on how to specify users here. ex: [{"slack_id": "U1H77"}, {"external_id": "54321678", "display_name": "External User", "avatar_url": "https://example.com/users/avatar1234.jpg"}]

Errors the API can return:

  • invalid_created_by - The created_by user ID is invalid.
  • invalid_start_time - The start time is invalid.
  • not_authorized - The specified user is not authorized to create a Call in this channel.
  • not_implemented - This method is not available.
  • user_not_found - A specified user wasn't found.

See the Common Errors guide for errors returned by every Web API method.

end(id, optional_params \\ %{})

Ends a Call.

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • id - id returned when registering the call using the calls.add method. ex: R0E69JAIF

Optional Params

  • duration - Call duration in seconds ex: 1800

Errors the API can return:

  • inactive_call - The Call has been already stopped.
  • invalid_call_id - Invalid Call ID.
  • not_implemented - This method is not publicly available yet.

See the Common Errors guide for errors returned by every Web API method.

info(id, optional_params \\ %{})

Returns information about a Call.

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • id - id of the Call returned by the calls.add method. ex: R0E69JAIF

Errors the API can return:

  • not_implemented - This method is not available.

See the Common Errors guide for errors returned by every Web API method.

update(id, optional_params \\ %{})

Updates information about a Call.

API reference

Rate limit: Tier 3: 50+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • id - id returned by the calls.add method. ex: R0E69JAIF

Optional Params

  • desktop_app_join_url - When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. The Call fields that may be updated are the Call's title, join_url, and desktop_app_join_url. ex: callapp://join/0987654321
  • join_url - The URL required for a client to join the Call. The Call fields that may be updated are the Call's title, join_url, and desktop_app_join_url. ex: https://example.com/calls/0987654321
  • title - The name of the Call. The Call fields that may be updated are the Call's title, join_url, and desktop_app_join_url. ex: Kimpossible sync up call

Errors the API can return:

  • invalid_call_id - The Call's id was invalid.
  • not_implemented - This method is not available.

See the Common Errors guide for errors returned by every Web API method.