Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 3.84 KB

GatherCallback.md

File metadata and controls

55 lines (48 loc) · 3.84 KB

GatherCallback

The gather event is sent after a verb is executed. Its purpose is to report the gathered digits to the calling application.

Properties

Name Type Description Notes
eventType 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] [default to undefined]
eventTime string 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] [default to undefined]
accountId string The user account associated with the call. [optional] [default to undefined]
applicationId string The id of the application associated with the call. [optional] [default to undefined]
from string The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). [optional] [default to undefined]
to string The phone number that received the call, in E.164 format (e.g. +15555555555). [optional] [default to undefined]
direction CallDirectionEnum [optional] [default to undefined]
callId string The call id associated with the event. [optional] [default to undefined]
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] [default to undefined]
callUrl string The URL of the call associated with the event. [optional] [default to undefined]
enqueuedTime string (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. [optional] [default to undefined]
startTime string Time the call was started, in ISO 8601 format. [optional] [default to undefined]
answerTime string Time the call was answered, in ISO 8601 format. [optional] [default to undefined]
parentCallId 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] [default to undefined]
terminatingDigit string (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. [optional] [default to undefined]
transferCallerId string The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). [optional] [default to undefined]
transferTo string The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). [optional] [default to undefined]
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] [default to undefined]

Example

import { GatherCallback } from 'bandwidth-sdk';

const instance: GatherCallback = {
    eventType,
    eventTime,
    accountId,
    applicationId,
    from,
    to,
    direction,
    callId,
    digits,
    callUrl,
    enqueuedTime,
    startTime,
    answerTime,
    parentCallId,
    terminatingDigit,
    transferCallerId,
    transferTo,
    tag,
};

[Back to Model list] [Back to API list] [Back to README]