Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 2.02 KB

UpdateCall.md

File metadata and controls

36 lines (30 loc) · 2.02 KB
Raw

Bandwidth::UpdateCall

Properties

Name Type Description Notes
state CallStateEnum [optional][default to 'active']
redirect_url String The URL to send the Redirect event to which will provide new BXML. Required if `state` is `active`. Not allowed if `state` is `completed`. [optional]
redirect_method RedirectMethodEnum [optional][default to 'POST']
username String Basic auth username. [optional]
password String Basic auth password. [optional]
redirect_fallback_url String A fallback url which, if provided, will be used to retry the redirect callback delivery in case `redirectUrl` fails to respond. [optional]
redirect_fallback_method RedirectMethodEnum [optional][default to 'POST']
fallback_username String Basic auth username. [optional]
fallback_password String Basic auth password. [optional]
tag String A custom string that will be sent with this and all future callbacks unless overwritten by a future `tag` attribute or `<Tag>` verb, or cleared. May be cleared by setting `tag=&quot;&quot;`. Max length 256 characters. Not allowed if `state` is `completed`. [optional]

Example

require 'bandwidth-sdk'

instance = Bandwidth::UpdateCall.new(
  state: null,
  redirect_url: https://myServer.example/bandwidth/webhooks/redirect,
  redirect_method: null,
  username: mySecretUsername,
  password: mySecretPassword1!,
  redirect_fallback_url: https://myFallbackServer.example/bandwidth/webhooks/redirect,
  redirect_fallback_method: null,
  fallback_username: mySecretUsername,
  fallback_password: mySecretPassword1!,
  tag: My Custom Tag
)