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

View Source

Summary

Functions

Registers new participants added to a Call.

Registers participants removed from a Call.

Functions

add(id, users, optional_params \\ %{})

Registers new participants added to 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
  • users - The list of users to add 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:

  • bad_users - At least one specified user is already part of the Call.
  • inactive_call - The Call has been already ended.
  • invalid_call_id - The specified Call wasn't found.
  • missing_argument - A required argument is missing.
  • not_implemented - This method is not available.
  • user_not_found - At least one specified user wasn't found.

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

remove(id, users, optional_params \\ %{})

Registers participants removed from 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
  • users - The list of users to remove 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:

  • bad_users - At least one specified user is not part of the Call.
  • inactive_call - The Call has been already ended.
  • invalid_call_id - The specified Call wasn't found.
  • missing_argument - A required argument is missing.
  • not_implemented - This method is not available.
  • user_not_found - At least one specified user wasn't found.

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