lib/twilio-ruby/rest/api/v2010/account/call.rb in twilio-ruby-5.40.3 vs lib/twilio-ruby/rest/api/v2010/account/call.rb in twilio-ruby-5.40.4
- old
+ new
@@ -14,11 +14,11 @@
class CallList < ListResource
##
# Initialize the CallList
# @param [Version] version Version that contains the resource
# @param [String] account_sid The SID of the
- # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
# resource.
# @return [CallList] CallList
def initialize(version, account_sid: nil)
super(version)
@@ -32,12 +32,12 @@
##
# Create the CallInstance
# @param [String] to The phone number, SIP address, or client identifier to call.
# @param [String] from The phone number or client identifier to use as the caller
- # id. If using a phone number, it must be a Twilio number or a Verified [outgoing
- # caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your
+ # id. If using a phone number, it must be a Twilio number or a Verified {outgoing
+ # caller id}[https://www.twilio.com/docs/voice/api/outgoing-caller-ids] for your
# account. If the `to` parameter is a phone number, `From` must also be a phone
# number.
# @param [String] method The HTTP method we should use when calling the `url`
# parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an
# `application_sid` parameter is present, this parameter is ignored.
@@ -54,12 +54,12 @@
# contain a valid hostname (underscores are not permitted).
# @param [String] status_callback_event The call progress events that we will send
# to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and
# `completed`. If no event is specified, we send the `completed` status. If you
# want to receive multiple events, specify each one in a separate
- # `status_callback_event` parameter. See the code sample for [monitoring call
- # progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json).
+ # `status_callback_event` parameter. See the code sample for {monitoring call
+ # progress}[https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json].
# If an `application_sid` is present, this parameter is ignored.
# @param [String] status_callback_method The HTTP method we should use when
# calling the `status_callback` URL. Can be: `GET` or `POST` and the default is
# `POST`. If an `application_sid` parameter is present, this parameter is ignored.
# @param [String] send_digits A string of keys to dial after connecting to the
@@ -99,12 +99,12 @@
# @param [String] machine_detection Whether to detect if a human, answering
# machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`.
# Use `Enable` if you would like us to return `AnsweredBy` as soon as the called
# party is identified. Use `DetectMessageEnd`, if you would like to leave a
# message on an answering machine. If `send_digits` is provided, this parameter is
- # ignored. For more information, see [Answering Machine
- # Detection](https://www.twilio.com/docs/voice/answering-machine-detection).
+ # ignored. For more information, see {Answering Machine
+ # Detection}[https://www.twilio.com/docs/voice/answering-machine-detection].
# @param [String] machine_detection_timeout The number of seconds that we should
# attempt to detect an answering machine before timing out and sending a voice
# request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.
# @param [String] recording_status_callback_event The recording status events that
# will trigger calls to the URL specified in `recording_status_callback`. Can be:
@@ -112,12 +112,12 @@
# multiple values with a space.
# @param [String] trim Whether to trim any leading and trailing silence from the
# recording. Can be: `trim-silence` or `do-not-trim` and the default is
# `trim-silence`.
# @param [String] caller_id The phone number, SIP address, or Client identifier
- # that made this call. Phone numbers are in [E.164
- # format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212).
+ # that made this call. Phone numbers are in {E.164
+ # format}[https://wwnw.twilio.com/docs/glossary/what-e164] (e.g., +16175551212).
# SIP addresses are formatted as `name@company.com`.
# @param [String] machine_detection_speech_threshold The number of milliseconds
# that is used as the measuring stick for the length of the speech activity, where
# durations lower than this value will be interpreted as a human and longer than
# this value as a machine. Possible Values: 1000-6000. Default: 2400.
@@ -142,13 +142,13 @@
# @param [String] call_reason The Reason for the outgoing call. Use it to specify
# the purpose of the call that is presented on the called party's phone. (Branded
# Calls Beta)
# @param [String] url The absolute URL that returns the TwiML instructions for the
# call. We will call this URL using the `method` when the call connects. For more
- # information, see the [Url
- # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
- # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+ # information, see the {Url
+ # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+ # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
# @param [String] twiml TwiML instructions for the call Twilio will use without
# fetching Twiml from url parameter. If both `twiml` and `url` are provided then
# `twiml` parameter will be ignored.
# @param [String] application_sid The SID of the Application resource that will
# handle the call, if the call will be handled by an application.
@@ -409,11 +409,11 @@
class CallContext < InstanceContext
##
# Initialize the CallContext
# @param [Version] version Version that contains the resource
# @param [String] account_sid The SID of the
- # [Account](https://www.twilio.com/docs/iam/api/account) that created the Call
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created the Call
# resource(s) to fetch.
# @param [String] sid The SID of the Call resource to fetch.
# @return [CallContext] CallContext
def initialize(version, account_sid, sid)
super(version)
@@ -447,13 +447,13 @@
##
# Update the CallInstance
# @param [String] url The absolute URL that returns the TwiML instructions for the
# call. We will call this URL using the `method` when the call connects. For more
- # information, see the [Url
- # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
- # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+ # information, see the {Url
+ # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+ # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
# @param [String] method The HTTP method we should use when calling the `url`. Can
# be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter
# is present, this parameter is ignored.
# @param [call.UpdateStatus] status The new status of the resource. Can be:
# `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls
@@ -587,11 +587,11 @@
##
# Initialize the CallInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] account_sid The SID of the
- # [Account](https://www.twilio.com/docs/iam/api/account) that created this Call
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
# resource.
# @param [String] sid The SID of the Call resource to fetch.
# @return [CallInstance] CallInstance
def initialize(version, payload, account_sid: nil, sid: nil)
super(version)
@@ -821,12 +821,12 @@
##
# Update the CallInstance
# @param [String] url The absolute URL that returns the TwiML instructions for the
# call. We will call this URL using the `method` when the call connects. For more
- # information, see the [Url
- # Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter)
- # section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).
+ # information, see the {Url
+ # Parameter}[https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter]
+ # section in {Making Calls}[https://www.twilio.com/docs/voice/make-calls].
# @param [String] method The HTTP method we should use when calling the `url`. Can
# be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter
# is present, this parameter is ignored.
# @param [call.UpdateStatus] status The new status of the resource. Can be:
# `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls
\ No newline at end of file