| All Verbs | /session/hold/callback |
|---|
"use strict";
export class TwilioRequestBase {
/** @param {{callSid?:string,accountSid?:string,from?:string,to?:string,callStatus?:string,apiVersion?:string,direction?:string,forwardedFrom?:string,callerName?:string,parentCallSid?:string,stirVerstat?:string,called?:string,calledZip?:string,calledCity?:string,calledState?:string,calledCountry?:string,caller?:string,callerCity?:string,callerState?:string,callerZip?:string,callerCountry?:string,fromCity?:string,fromState?:string,fromZip?:string,fromCountry?:string,toCity?:string,toState?:string,toZip?:string,toCountry?:string,messageSid?:string,smsId?:string,messagingServiceSid?:string,body?:string,numMedia?:number,mediaContentType0?:string,mediaUrl0?:string,mediaContentType1?:string,mediaUrl1?:string,mediaContentType2?:string,mediaUrl2?:string,index?:number,instanceSid?:string,eventType?:string,channelSid?:string,attributes?:string,clientIdentity?:string,mediaContentType?:string,mediaSid?:string,identity?:string,digits?:string,speechResult?:string,confidence?:number,callDuration?:number,recordingUrl?:string,recordingSid?:string,recordingDuration?:number,recordingStatus?:string,transcriptionSid?:string,transcriptionText?:string,transcriptionUrl?:string,transcriptionStatus?:string,dialCallStatus?:string,dialCallSid?:string,dialCallDuration?:number,dialBridged?:boolean,queueResult?:string,queueSid?:string,queueTime?:number,conferenceSid?:string,friendlyName?:string,statusCallbackEvent?:string,muted?:boolean,hold?:boolean,endConferenceOnExit?:boolean,startConferenceOnEnter?:boolean,eventName?:string,assistantSid?:string,dialogueSid?:string,userIdentifier?:string,currentInput?:string,currentTask?:string,dialoguePayloadUrl?:string,memory?:string,channel?:string,faxSid?:string,faxStatus?:string,numPages?:number,mediaUrl?:string,errorCode?:string,errorMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
callSid;
/** @type {string} */
accountSid;
/** @type {string} */
from;
/** @type {string} */
to;
/** @type {string} */
callStatus;
/** @type {string} */
apiVersion;
/** @type {string} */
direction;
/** @type {string} */
forwardedFrom;
/** @type {string} */
callerName;
/** @type {string} */
parentCallSid;
/** @type {string} */
stirVerstat;
/** @type {string} */
called;
/** @type {string} */
calledZip;
/** @type {string} */
calledCity;
/** @type {string} */
calledState;
/** @type {string} */
calledCountry;
/** @type {string} */
caller;
/** @type {string} */
callerCity;
/** @type {string} */
callerState;
/** @type {string} */
callerZip;
/** @type {string} */
callerCountry;
/** @type {string} */
fromCity;
/** @type {string} */
fromState;
/** @type {string} */
fromZip;
/** @type {string} */
fromCountry;
/** @type {string} */
toCity;
/** @type {string} */
toState;
/** @type {string} */
toZip;
/** @type {string} */
toCountry;
/** @type {string} */
messageSid;
/** @type {string} */
smsId;
/** @type {string} */
messagingServiceSid;
/** @type {string} */
body;
/** @type {number} */
numMedia;
/** @type {string} */
mediaContentType0;
/** @type {string} */
mediaUrl0;
/** @type {string} */
mediaContentType1;
/** @type {string} */
mediaUrl1;
/** @type {string} */
mediaContentType2;
/** @type {string} */
mediaUrl2;
/** @type {number} */
index;
/** @type {string} */
instanceSid;
/** @type {string} */
eventType;
/** @type {string} */
channelSid;
/** @type {string} */
attributes;
/** @type {string} */
clientIdentity;
/** @type {string} */
mediaContentType;
/** @type {string} */
mediaSid;
/** @type {string} */
identity;
/** @type {string} */
digits;
/** @type {string} */
speechResult;
/** @type {number} */
confidence;
/** @type {number} */
callDuration;
/** @type {string} */
recordingUrl;
/** @type {string} */
recordingSid;
/** @type {number} */
recordingDuration;
/** @type {string} */
recordingStatus;
/** @type {string} */
transcriptionSid;
/** @type {string} */
transcriptionText;
/** @type {string} */
transcriptionUrl;
/** @type {string} */
transcriptionStatus;
/** @type {string} */
dialCallStatus;
/** @type {string} */
dialCallSid;
/** @type {number} */
dialCallDuration;
/** @type {boolean} */
dialBridged;
/** @type {string} */
queueResult;
/** @type {string} */
queueSid;
/** @type {number} */
queueTime;
/** @type {string} */
conferenceSid;
/** @type {string} */
friendlyName;
/** @type {string} */
statusCallbackEvent;
/** @type {boolean} */
muted;
/** @type {boolean} */
hold;
/** @type {boolean} */
endConferenceOnExit;
/** @type {boolean} */
startConferenceOnEnter;
/** @type {string} */
eventName;
/** @type {string} */
assistantSid;
/** @type {string} */
dialogueSid;
/** @type {string} */
userIdentifier;
/** @type {string} */
currentInput;
/** @type {string} */
currentTask;
/** @type {string} */
dialoguePayloadUrl;
/** @type {string} */
memory;
/** @type {string} */
channel;
/** @type {string} */
faxSid;
/** @type {string} */
faxStatus;
/** @type {number} */
numPages;
/** @type {string} */
mediaUrl;
/** @type {string} */
errorCode;
/** @type {string} */
errorMessage;
}
export class SessionHoldCallback extends TwilioRequestBase {
/** @param {{sessionId?:string,holdingCallSid?:string,callSid?:string,accountSid?:string,from?:string,to?:string,callStatus?:string,apiVersion?:string,direction?:string,forwardedFrom?:string,callerName?:string,parentCallSid?:string,stirVerstat?:string,called?:string,calledZip?:string,calledCity?:string,calledState?:string,calledCountry?:string,caller?:string,callerCity?:string,callerState?:string,callerZip?:string,callerCountry?:string,fromCity?:string,fromState?:string,fromZip?:string,fromCountry?:string,toCity?:string,toState?:string,toZip?:string,toCountry?:string,messageSid?:string,smsId?:string,messagingServiceSid?:string,body?:string,numMedia?:number,mediaContentType0?:string,mediaUrl0?:string,mediaContentType1?:string,mediaUrl1?:string,mediaContentType2?:string,mediaUrl2?:string,index?:number,instanceSid?:string,eventType?:string,channelSid?:string,attributes?:string,clientIdentity?:string,mediaContentType?:string,mediaSid?:string,identity?:string,digits?:string,speechResult?:string,confidence?:number,callDuration?:number,recordingUrl?:string,recordingSid?:string,recordingDuration?:number,recordingStatus?:string,transcriptionSid?:string,transcriptionText?:string,transcriptionUrl?:string,transcriptionStatus?:string,dialCallStatus?:string,dialCallSid?:string,dialCallDuration?:number,dialBridged?:boolean,queueResult?:string,queueSid?:string,queueTime?:number,conferenceSid?:string,friendlyName?:string,statusCallbackEvent?:string,muted?:boolean,hold?:boolean,endConferenceOnExit?:boolean,startConferenceOnEnter?:boolean,eventName?:string,assistantSid?:string,dialogueSid?:string,userIdentifier?:string,currentInput?:string,currentTask?:string,dialoguePayloadUrl?:string,memory?:string,channel?:string,faxSid?:string,faxStatus?:string,numPages?:number,mediaUrl?:string,errorCode?:string,errorMessage?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
sessionId;
/** @type {string} */
holdingCallSid;
}
JavaScript SessionHoldCallback DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /session/hold/callback HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
sessionId: String,
holdingCallSid: String,
callSid: String,
accountSid: String,
from: String,
to: String,
callStatus: String,
apiVersion: String,
direction: String,
forwardedFrom: String,
callerName: String,
parentCallSid: String,
stirVerstat: String,
called: String,
calledZip: String,
calledCity: String,
calledState: String,
calledCountry: String,
caller: String,
callerCity: String,
callerState: String,
callerZip: String,
callerCountry: String,
fromCity: String,
fromState: String,
fromZip: String,
fromCountry: String,
toCity: String,
toState: String,
toZip: String,
toCountry: String,
messageSid: String,
smsId: String,
messagingServiceSid: String,
body: String,
numMedia: 0,
mediaContentType0: String,
mediaUrl0: String,
mediaContentType1: String,
mediaUrl1: String,
mediaContentType2: String,
mediaUrl2: String,
index: 0,
instanceSid: String,
eventType: String,
channelSid: String,
attributes: String,
clientIdentity: String,
mediaContentType: String,
mediaSid: String,
identity: String,
digits: String,
speechResult: String,
confidence: 0,
callDuration: 0,
recordingUrl: String,
recordingSid: String,
recordingDuration: 0,
recordingStatus: String,
transcriptionSid: String,
transcriptionText: String,
transcriptionUrl: String,
transcriptionStatus: String,
dialCallStatus: String,
dialCallSid: String,
dialCallDuration: 0,
dialBridged: False,
queueResult: String,
queueSid: String,
queueTime: 0,
conferenceSid: String,
friendlyName: String,
statusCallbackEvent: String,
muted: False,
hold: False,
endConferenceOnExit: False,
startConferenceOnEnter: False,
eventName: String,
assistantSid: String,
dialogueSid: String,
userIdentifier: String,
currentInput: String,
currentTask: String,
dialoguePayloadUrl: String,
memory: String,
channel: String,
faxSid: String,
faxStatus: String,
numPages: 0,
mediaUrl: String,
errorCode: String,
errorMessage: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length (string)