Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

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

priv/docs/methods/calls.update.json

{
"args": {
"desktop_app_join_url": {
"desc": "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`.",
"example": "callapp://join/0987654321",
"required": false,
"type": "string"
},
"id": {
"desc": "`id` returned by the `calls.add` method.",
"example": "R0E69JAIF",
"required": true,
"type": "string"
},
"join_url": {
"desc": "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`.",
"example": "https://example.com/calls/0987654321",
"required": false,
"type": "string"
},
"title": {
"desc": "The name of the Call. The Call fields that may be updated are the Call's `title`, `join_url`, and `desktop_app_join_url`.",
"example": "Kimpossible sync up call",
"required": false,
"type": "string"
}
},
"desc": "Updates information about a Call.",
"errors": {
"invalid_call_id": "The Call's `id` was invalid.",
"not_implemented": "This method is not available."
},
"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"
}
]
}
}