calls.add
Registers a new Call.
Facts
Method URL: | https://slack.com/api/calls.add | ||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | POST | ||||||||
Accepted content types: | application/x-www-form-urlencoded , application/json | ||||||||
Rate limiting: | Tier 3 | ||||||||
Works with: |
|
This method is part of our Calls API.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
external_unique_id
An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
Example025169F6-E37A-4E62-BB54-7F93A0FC4C1F
join_url
The URL required for a client to join the Call.
Examplehttps://example.com/calls/1234567890
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.
U1H77
date_start
Call start time in UTC UNIX timestamp format
Example1562002086
desktop_app_join_url
When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
Examplecallapp://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.
Example705-292-868
title
The name of the Call.
ExampleKimpossible sync up
users
The list of users to register as participants in the Call. Read more on how to specify users here.
Example[{"slack_id": "U1H77"}, {"external_id": "54321678", "display_name": "External User", "avatar_url": "https://example.com/users/avatar1234.jpg"}]
application/json
via HTTP POST. Present your token
in your request's Authorization
header. Learn more.
For more information on how to specify users
, read our additional documentation in the usage guide.
Response
{
"ok": true,
"call": {
"id": "R0E69JAIF",
"date_start": 1562002086,
"external_unique_id": "025169F6-E37A-4E62-BB54-7F93A0FC4C1F",
"join_url": "https://example.com/calls/1234567890",
"desktop_app_join_url": "callapp://join/1234567890",
"external_display_id": "705-292-868",
"title": "Kimpossible sync up",
"users": [
{
"slack_id": "U0MQG83FD"
},
{
"external_id": "54321678",
"display_name": "Kim Possible",
"avatar_url": "https://callmebeepme.com/users/avatar1234.jpg"
}
]
}
}
Note that the success response includes an id
associated with the Call. This ID can be used to post the Call to a channel by using the chat.postMessage
method with the following block:
{
"blocks": [
{
"type": "call",
"call_id": "R0E69JAIF"
}
]
}
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok
params in the response.
Error | Description |
---|---|
not_implemented | This method is not available. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
invalid_start_time | The start time is invalid. |
not_authorized | The specified user is not authorized to create a Call in this channel. |
user_not_found | A specified user wasn't found. |
invalid_created_by | The |
not_authed | No authentication token provided. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
account_inactive | Authentication token is for a deleted user or workspace. |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed. |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
Warnings
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |