Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods calls.add.json
Raw

priv/docs/methods/calls.add.json

{
"args": {
"created_by": {
"desc": "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.",
"example": "U1H77",
"required": false,
"type": "string"
},
"date_start": {
"desc": "Unix timestamp of the call start time",
"example": "1562002086",
"required": false,
"type": "integer"
},
"desktop_app_join_url": {
"desc": "When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.",
"example": "callapp://join/1234567890",
"required": false,
"type": "string"
},
"external_display_id": {
"desc": "An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.",
"example": "705-292-868",
"required": false,
"type": "string"
},
"external_unique_id": {
"desc": "An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.",
"example": "025169F6-E37A-4E62-BB54-7F93A0FC4C1F",
"required": true,
"type": "string"
},
"join_url": {
"desc": "The URL required for a client to join the Call.",
"example": "https://example.com/calls/1234567890",
"required": true,
"type": "string"
},
"title": {
"desc": "The name of the Call.",
"example": "Kimpossible sync up",
"required": false,
"type": "string"
},
"users": {
"desc": "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\"}]",
"required": false,
"type": "array"
}
},
"desc": "Registers a new Call.",
"errors": {
"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."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "calls:write",
"url": "https://docs.slack.dev/reference/scopes/calls.write"
}
],
"user": [
{
"name": "calls:write",
"url": "https://docs.slack.dev/reference/scopes/calls.write"
}
]
}
}