Twilio.Calls.Streams (twilio v0.2.0)

Copy Markdown

API calls: create, update.

Summary

Functions

Stop a Stream using either the SID of the Stream resource or the name used when creating the resource

Functions

create(call_sid, params \\ %{}, opts \\ [])

@spec create(String.t(), map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.Stream.t()} | {:error, Infusion.Runtime.Error.t()}

Create a Stream

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams.json

Path parameters

  • call_sid (required) - The SID of the Call the Stream resource is associated with.

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • name - The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream.
  • parameter1_name - Parameter name
  • parameter1_value - Parameter value
  • parameter10_name - Parameter name
  • parameter10_value - Parameter value
  • parameter11_name - Parameter name
  • parameter11_value - Parameter value
  • parameter12_name - Parameter name
  • parameter12_value - Parameter value
  • parameter13_name - Parameter name
  • parameter13_value - Parameter value
  • parameter14_name - Parameter name
  • parameter14_value - Parameter value
  • parameter15_name - Parameter name
  • parameter15_value - Parameter value
  • parameter16_name - Parameter name
  • parameter16_value - Parameter value
  • parameter17_name - Parameter name
  • parameter17_value - Parameter value
  • parameter18_name - Parameter name
  • parameter18_value - Parameter value
  • parameter19_name - Parameter name
  • parameter19_value - Parameter value
  • parameter2_name - Parameter name
  • parameter2_value - Parameter value
  • parameter20_name - Parameter name
  • parameter20_value - Parameter value
  • parameter21_name - Parameter name
  • parameter21_value - Parameter value
  • parameter22_name - Parameter name
  • parameter22_value - Parameter value
  • parameter23_name - Parameter name
  • parameter23_value - Parameter value
  • parameter24_name - Parameter name
  • parameter24_value - Parameter value
  • parameter25_name - Parameter name
  • parameter25_value - Parameter value
  • parameter26_name - Parameter name
  • parameter26_value - Parameter value
  • parameter27_name - Parameter name
  • parameter27_value - Parameter value
  • parameter28_name - Parameter name
  • parameter28_value - Parameter value
  • parameter29_name - Parameter name
  • parameter29_value - Parameter value
  • parameter3_name - Parameter name
  • parameter3_value - Parameter value
  • parameter30_name - Parameter name
  • parameter30_value - Parameter value
  • parameter31_name - Parameter name
  • parameter31_value - Parameter value
  • parameter32_name - Parameter name
  • parameter32_value - Parameter value
  • parameter33_name - Parameter name
  • parameter33_value - Parameter value
  • parameter34_name - Parameter name
  • parameter34_value - Parameter value
  • parameter35_name - Parameter name
  • parameter35_value - Parameter value
  • parameter36_name - Parameter name
  • parameter36_value - Parameter value
  • parameter37_name - Parameter name
  • parameter37_value - Parameter value
  • parameter38_name - Parameter name
  • parameter38_value - Parameter value
  • parameter39_name - Parameter name
  • parameter39_value - Parameter value
  • parameter4_name - Parameter name
  • parameter4_value - Parameter value
  • parameter40_name - Parameter name
  • parameter40_value - Parameter value
  • parameter41_name - Parameter name
  • parameter41_value - Parameter value
  • parameter42_name - Parameter name
  • parameter42_value - Parameter value
  • parameter43_name - Parameter name
  • parameter43_value - Parameter value
  • parameter44_name - Parameter name
  • parameter44_value - Parameter value
  • parameter45_name - Parameter name
  • parameter45_value - Parameter value
  • parameter46_name - Parameter name
  • parameter46_value - Parameter value
  • parameter47_name - Parameter name
  • parameter47_value - Parameter value
  • parameter48_name - Parameter name
  • parameter48_value - Parameter value
  • parameter49_name - Parameter name
  • parameter49_value - Parameter value
  • parameter5_name - Parameter name
  • parameter5_value - Parameter value
  • parameter50_name - Parameter name
  • parameter50_value - Parameter value
  • parameter51_name - Parameter name
  • parameter51_value - Parameter value
  • parameter52_name - Parameter name
  • parameter52_value - Parameter value
  • parameter53_name - Parameter name
  • parameter53_value - Parameter value
  • parameter54_name - Parameter name
  • parameter54_value - Parameter value
  • parameter55_name - Parameter name
  • parameter55_value - Parameter value
  • parameter56_name - Parameter name
  • parameter56_value - Parameter value
  • parameter57_name - Parameter name
  • parameter57_value - Parameter value
  • parameter58_name - Parameter name
  • parameter58_value - Parameter value
  • parameter59_name - Parameter name
  • parameter59_value - Parameter value
  • parameter6_name - Parameter name
  • parameter6_value - Parameter value
  • parameter60_name - Parameter name
  • parameter60_value - Parameter value
  • parameter61_name - Parameter name
  • parameter61_value - Parameter value
  • parameter62_name - Parameter name
  • parameter62_value - Parameter value
  • parameter63_name - Parameter name
  • parameter63_value - Parameter value
  • parameter64_name - Parameter name
  • parameter64_value - Parameter value
  • parameter65_name - Parameter name
  • parameter65_value - Parameter value
  • parameter66_name - Parameter name
  • parameter66_value - Parameter value
  • parameter67_name - Parameter name
  • parameter67_value - Parameter value
  • parameter68_name - Parameter name
  • parameter68_value - Parameter value
  • parameter69_name - Parameter name
  • parameter69_value - Parameter value
  • parameter7_name - Parameter name
  • parameter7_value - Parameter value
  • parameter70_name - Parameter name
  • parameter70_value - Parameter value
  • parameter71_name - Parameter name
  • parameter71_value - Parameter value
  • parameter72_name - Parameter name
  • parameter72_value - Parameter value
  • parameter73_name - Parameter name
  • parameter73_value - Parameter value
  • parameter74_name - Parameter name
  • parameter74_value - Parameter value
  • parameter75_name - Parameter name
  • parameter75_value - Parameter value
  • parameter76_name - Parameter name
  • parameter76_value - Parameter value
  • parameter77_name - Parameter name
  • parameter77_value - Parameter value
  • parameter78_name - Parameter name
  • parameter78_value - Parameter value
  • parameter79_name - Parameter name
  • parameter79_value - Parameter value
  • parameter8_name - Parameter name
  • parameter8_value - Parameter value
  • parameter80_name - Parameter name
  • parameter80_value - Parameter value
  • parameter81_name - Parameter name
  • parameter81_value - Parameter value
  • parameter82_name - Parameter name
  • parameter82_value - Parameter value
  • parameter83_name - Parameter name
  • parameter83_value - Parameter value
  • parameter84_name - Parameter name
  • parameter84_value - Parameter value
  • parameter85_name - Parameter name
  • parameter85_value - Parameter value
  • parameter86_name - Parameter name
  • parameter86_value - Parameter value
  • parameter87_name - Parameter name
  • parameter87_value - Parameter value
  • parameter88_name - Parameter name
  • parameter88_value - Parameter value
  • parameter89_name - Parameter name
  • parameter89_value - Parameter value
  • parameter9_name - Parameter name
  • parameter9_value - Parameter value
  • parameter90_name - Parameter name
  • parameter90_value - Parameter value
  • parameter91_name - Parameter name
  • parameter91_value - Parameter value
  • parameter92_name - Parameter name
  • parameter92_value - Parameter value
  • parameter93_name - Parameter name
  • parameter93_value - Parameter value
  • parameter94_name - Parameter name
  • parameter94_value - Parameter value
  • parameter95_name - Parameter name
  • parameter95_value - Parameter value
  • parameter96_name - Parameter name
  • parameter96_value - Parameter value
  • parameter97_name - Parameter name
  • parameter97_value - Parameter value
  • parameter98_name - Parameter name
  • parameter98_value - Parameter value
  • parameter99_name - Parameter name
  • parameter99_value - Parameter value
  • status_callback - Absolute URL to which Twilio sends status callback HTTP requests.
  • status_callback_method - The HTTP method Twilio uses when sending status_callback requests. Possible values are GET and POST. Default is POST.
  • track
  • url (required) - Relative or absolute URL where WebSocket connection will be established.

create!(call_sid, params \\ %{}, opts \\ [])

@spec create!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Stream.t()

Like create/3, but returns the result or raises Infusion.Runtime.Error.

update(call_sid, sid, params \\ %{}, opts \\ [])

@spec update(String.t(), String.t(), map() | keyword(), keyword()) ::
  {:ok, Twilio.Schemas.Stream.t()} | {:error, Infusion.Runtime.Error.t()}

Stop a Stream using either the SID of the Stream resource or the name used when creating the resource

POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}.json

Path parameters

  • call_sid (required) - The SID of the Call the Stream resource is associated with.
  • sid (required) - The SID or the name of the Stream resource to be stopped

{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.

Parameters

  • status (required)

update!(call_sid, sid, params \\ %{}, opts \\ [])

@spec update!(String.t(), String.t(), map() | keyword(), keyword()) ::
  Twilio.Schemas.Stream.t()

Like update/4, but returns the result or raises Infusion.Runtime.Error.