Slack. Web. Calls
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Registers a new Call.
Ends a Call.
Returns information about a Call.
Updates information about a Call.
Functions
Registers a new Call.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
calls:write - User token:
calls:write
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-7F93A0FC4C1Fjoin_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, thecreated_byfield is optional and defaults to the authed user of the token. Otherwise, the field is required. ex:U1H77date_start- Unix timestamp of the call start time ex:1562002086desktop_app_join_url- When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL. ex:callapp://join/1234567890external_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-868title- The name of the Call. ex:Kimpossible sync upusers- 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- Thecreated_byuser 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.
Ends a Call.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
calls:write - User token:
calls:write
Required Params
id-idreturned when registering the call using thecalls.addmethod. 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.
Returns information about a Call.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
calls:read - User token:
calls:read
Required Params
id-idof the Call returned by thecalls.addmethod. 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.
Updates information about a Call.
API reference
Rate limit: Tier 3: 50+ per minute
Scopes:
- Bot token:
calls:write - User token:
calls:write
Required Params
id-idreturned by thecalls.addmethod. 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'stitle,join_url, anddesktop_app_join_url. ex:callapp://join/0987654321join_url- The URL required for a client to join the Call. The Call fields that may be updated are the Call'stitle,join_url, anddesktop_app_join_url. ex:https://example.com/calls/0987654321title- The name of the Call. The Call fields that may be updated are the Call'stitle,join_url, anddesktop_app_join_url. ex:Kimpossible sync up call
Errors the API can return:
invalid_call_id- The Call'sidwas invalid.not_implemented- This method is not available.
See the Common Errors guide for errors returned by every Web API method.