Skip to content

Latest commit

 

History

History
52 lines (46 loc) · 3.71 KB

GatherCallback.md

File metadata and controls

52 lines (46 loc) · 3.71 KB
Raw

Bandwidth::GatherCallback

Properties

Name Type Description Notes
event_type String The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. [optional]
event_time Time The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. [optional]
account_id String The user account associated with the call. [optional]
application_id String The id of the application associated with the call. [optional]
from String The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. [optional]
to String The phone number that received the call, in E.164 format (e.g. +15555555555). [optional]
direction CallDirectionEnum [optional]
call_id String The call id associated with the event. [optional]
digits String (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. [optional]
call_url String The URL of the call associated with the event. [optional]
enqueued_time Time (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. [optional]
start_time Time Time the call was started, in ISO 8601 format. [optional]
answer_time Time Time the call was answered, in ISO 8601 format. [optional]
parent_call_id String (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. [optional]
terminating_digit String (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. [optional]
transfer_caller_id String The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. [optional]
transfer_to String The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). [optional]
tag String (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. [optional]

Example

require 'bandwidth-sdk'

instance = Bandwidth::GatherCallback.new(
  event_type: bridgeComplete,
  event_time: 2022-06-17T22:19:40.375Z,
  account_id: 920012,
  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
  from: +15555555555,
  to: +15555555555,
  direction: null,
  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
  digits: 123,
  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
  enqueued_time: 2022-06-17T22:20Z,
  start_time: 2022-06-17T22:19:40.375Z,
  answer_time: 2022-06-17T22:20Z,
  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
  terminating_digit: #,
  transfer_caller_id: +15555555555,
  transfer_to: +15555555555),
  tag: exampleTag
)