module Slack::Web::Api::Endpoints::Calls

Public Instance Methods

calls_add(options = {}) click to toggle source

Registers a new Call.

@option options [Object] :external_unique_id

An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.

@option options [Object] :join_url

The URL required for a client to join the Call.

@option options [Object] :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.

@option options [Object] :date_start

Call start time in UTC UNIX timestamp format.

@option options [Object] :desktop_app_join_url

When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

@option options [Object] :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.

@option options [Object] :title

The name of the Call.

@option options [Object] :users

The list of users to register as participants in the Call. Read more on how to specify users here.

@see api.slack.com/methods/calls.add @see github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.add.json

# File lib/slack/web/api/endpoints/calls.rb, line 30
def calls_add(options = {})
  throw ArgumentError.new('Required arguments :external_unique_id missing') if options[:external_unique_id].nil?
  throw ArgumentError.new('Required arguments :join_url missing') if options[:join_url].nil?
  post('calls.add', options)
end
calls_end(options = {}) click to toggle source

Ends a Call.

@option options [Object] :id

id returned when registering the call using the calls.add method.

@option options [Object] :duration

Call duration in seconds.

@see api.slack.com/methods/calls.end @see github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.end.json

# File lib/slack/web/api/endpoints/calls.rb, line 45
def calls_end(options = {})
  throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
  post('calls.end', options)
end
calls_info(options = {}) click to toggle source

Returns information about a Call.

@option options [Object] :id

id of the Call returned by the calls.add method.

@see api.slack.com/methods/calls.info @see github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.info.json

# File lib/slack/web/api/endpoints/calls.rb, line 57
def calls_info(options = {})
  throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
  post('calls.info', options)
end
calls_update(options = {}) click to toggle source

Updates information about a Call.

@option options [Object] :id

id returned by the calls.add method.

@option options [Object] :desktop_app_join_url

When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

@option options [Object] :join_url

The URL required for a client to join the Call.

@option options [Object] :title

The name of the Call.

@see api.slack.com/methods/calls.update @see github.com/slack-ruby/slack-api-ref/blob/master/methods/calls/calls.update.json

# File lib/slack/web/api/endpoints/calls.rb, line 75
def calls_update(options = {})
  throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
  post('calls.update', options)
end