Evo Voice

<back to all web services

QueueNodeWaitCallback

The following routes are available for this service:
All Verbs/nodes/queue/wait-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;
}
/** @typedef {'Audio'|'Text'} */
export var QueueWaitMusicModes;
(function (QueueWaitMusicModes) {
    QueueWaitMusicModes["Audio"] = "Audio"
    QueueWaitMusicModes["Text"] = "Text"
})(QueueWaitMusicModes || (QueueWaitMusicModes = {}));
/** @typedef {'Man'|'Woman'|'Polly_Mads_Danish_Male'|'Polly_Naja_Danish_Female'|'Polly_Lotte_Dutch_Female'|'Polly_Ruben_Dutch_Male'|'Polly_Nicole_Australian_Female'|'Polly_Russell_Australian_Male'|'Polly_Amy_British_Female'|'Polly_Brian_British_Male'|'Polly_Emma_British_Female'|'Polly_Raveena_Indian_Female'|'Polly_Ivy_US_Female'|'Polly_Joanna_US_Female'|'Polly_Joey_US_Male'|'Polly_Justin_US_Male'|'Polly_Kendra_US_Female'|'Polly_Kimberly_US_Female'|'Polly_Matthew_US_Male'|'Polly_Salli_US_Female'|'Polly_Geraint_Welsh_Male'|'Polly_Celine_French_Female'|'Polly_Mathieu_French_Male'|'Polly_Chantal_French_Canadian_Female'|'Polly_Hans_German_Male'|'Polly_Marlene_German_Female'|'Polly_Vicki_German_Female'|'Polly_Dora_Iceland_Female'|'Polly_Karl_Iceland_Male'|'Polly_Carla_Italian_Female'|'Polly_Giorgio_Italian_Male'|'Polly_Mizuki_Japanese_Female'|'Polly_Takumi_Japanese_Male'|'Polly_Liv_Norwegian_Female'|'Polly_Jacek_Polish_Male'|'Polly_Jan_Polish_Female'|'Polly_Ewa_Polish_Female'|'Polly_Maja_Polish_Female'|'Polly_Ricardo_Portuguese_Male'|'Polly_Vitoria_Portuguese_Female'|'Polly_Cristiano_Portuguese_Male'|'Polly_Inese_Portuguese_Female'|'Polly_Carmen_Romanian_Female'|'Polly_Maxim_Russian_Male'|'Polly_Tatyana_Russian_Female'|'Polly_Conchita_Spanish_Female'|'Polly_Enrique_Spanish_Male'|'Polly_Miguel_Latin_American_Male'|'Polly_Penelope_Latina_American_Female'|'Polly_Astrid_Swedish_Female'|'Polly_Filiz_Turkish_Male'|'Polly_Gwyneth_Welsh_Female'} */
export var SayVoices;
(function (SayVoices) {
    SayVoices["Man"] = "Man"
    SayVoices["Woman"] = "Woman"
    SayVoices["Polly_Mads_Danish_Male"] = "Polly_Mads_Danish_Male"
    SayVoices["Polly_Naja_Danish_Female"] = "Polly_Naja_Danish_Female"
    SayVoices["Polly_Lotte_Dutch_Female"] = "Polly_Lotte_Dutch_Female"
    SayVoices["Polly_Ruben_Dutch_Male"] = "Polly_Ruben_Dutch_Male"
    SayVoices["Polly_Nicole_Australian_Female"] = "Polly_Nicole_Australian_Female"
    SayVoices["Polly_Russell_Australian_Male"] = "Polly_Russell_Australian_Male"
    SayVoices["Polly_Amy_British_Female"] = "Polly_Amy_British_Female"
    SayVoices["Polly_Brian_British_Male"] = "Polly_Brian_British_Male"
    SayVoices["Polly_Emma_British_Female"] = "Polly_Emma_British_Female"
    SayVoices["Polly_Raveena_Indian_Female"] = "Polly_Raveena_Indian_Female"
    SayVoices["Polly_Ivy_US_Female"] = "Polly_Ivy_US_Female"
    SayVoices["Polly_Joanna_US_Female"] = "Polly_Joanna_US_Female"
    SayVoices["Polly_Joey_US_Male"] = "Polly_Joey_US_Male"
    SayVoices["Polly_Justin_US_Male"] = "Polly_Justin_US_Male"
    SayVoices["Polly_Kendra_US_Female"] = "Polly_Kendra_US_Female"
    SayVoices["Polly_Kimberly_US_Female"] = "Polly_Kimberly_US_Female"
    SayVoices["Polly_Matthew_US_Male"] = "Polly_Matthew_US_Male"
    SayVoices["Polly_Salli_US_Female"] = "Polly_Salli_US_Female"
    SayVoices["Polly_Geraint_Welsh_Male"] = "Polly_Geraint_Welsh_Male"
    SayVoices["Polly_Celine_French_Female"] = "Polly_Celine_French_Female"
    SayVoices["Polly_Mathieu_French_Male"] = "Polly_Mathieu_French_Male"
    SayVoices["Polly_Chantal_French_Canadian_Female"] = "Polly_Chantal_French_Canadian_Female"
    SayVoices["Polly_Hans_German_Male"] = "Polly_Hans_German_Male"
    SayVoices["Polly_Marlene_German_Female"] = "Polly_Marlene_German_Female"
    SayVoices["Polly_Vicki_German_Female"] = "Polly_Vicki_German_Female"
    SayVoices["Polly_Dora_Iceland_Female"] = "Polly_Dora_Iceland_Female"
    SayVoices["Polly_Karl_Iceland_Male"] = "Polly_Karl_Iceland_Male"
    SayVoices["Polly_Carla_Italian_Female"] = "Polly_Carla_Italian_Female"
    SayVoices["Polly_Giorgio_Italian_Male"] = "Polly_Giorgio_Italian_Male"
    SayVoices["Polly_Mizuki_Japanese_Female"] = "Polly_Mizuki_Japanese_Female"
    SayVoices["Polly_Takumi_Japanese_Male"] = "Polly_Takumi_Japanese_Male"
    SayVoices["Polly_Liv_Norwegian_Female"] = "Polly_Liv_Norwegian_Female"
    SayVoices["Polly_Jacek_Polish_Male"] = "Polly_Jacek_Polish_Male"
    SayVoices["Polly_Jan_Polish_Female"] = "Polly_Jan_Polish_Female"
    SayVoices["Polly_Ewa_Polish_Female"] = "Polly_Ewa_Polish_Female"
    SayVoices["Polly_Maja_Polish_Female"] = "Polly_Maja_Polish_Female"
    SayVoices["Polly_Ricardo_Portuguese_Male"] = "Polly_Ricardo_Portuguese_Male"
    SayVoices["Polly_Vitoria_Portuguese_Female"] = "Polly_Vitoria_Portuguese_Female"
    SayVoices["Polly_Cristiano_Portuguese_Male"] = "Polly_Cristiano_Portuguese_Male"
    SayVoices["Polly_Inese_Portuguese_Female"] = "Polly_Inese_Portuguese_Female"
    SayVoices["Polly_Carmen_Romanian_Female"] = "Polly_Carmen_Romanian_Female"
    SayVoices["Polly_Maxim_Russian_Male"] = "Polly_Maxim_Russian_Male"
    SayVoices["Polly_Tatyana_Russian_Female"] = "Polly_Tatyana_Russian_Female"
    SayVoices["Polly_Conchita_Spanish_Female"] = "Polly_Conchita_Spanish_Female"
    SayVoices["Polly_Enrique_Spanish_Male"] = "Polly_Enrique_Spanish_Male"
    SayVoices["Polly_Miguel_Latin_American_Male"] = "Polly_Miguel_Latin_American_Male"
    SayVoices["Polly_Penelope_Latina_American_Female"] = "Polly_Penelope_Latina_American_Female"
    SayVoices["Polly_Astrid_Swedish_Female"] = "Polly_Astrid_Swedish_Female"
    SayVoices["Polly_Filiz_Turkish_Male"] = "Polly_Filiz_Turkish_Male"
    SayVoices["Polly_Gwyneth_Welsh_Female"] = "Polly_Gwyneth_Welsh_Female"
})(SayVoices || (SayVoices = {}));
export class QueueWaitMusic {
    /** @param {{mode?:QueueWaitMusicModes,audioFile?:string,text?:string,textVoice?:SayVoices,numTimes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {QueueWaitMusicModes} */
    mode;
    /** @type {string} */
    audioFile;
    /** @type {string} */
    text;
    /** @type {SayVoices} */
    textVoice;
    /** @type {number} */
    numTimes;
}
export class QueueNodeWaitCallback extends TwilioRequestBase {
    /** @param {{waitMusic?:QueueWaitMusic[],queueName?:string,accountId?:string,sessionId?:string,recordingReady?:string,recordCall?:boolean,recordedFile?:string,recordedFileUrl?: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 {QueueWaitMusic[]} */
    waitMusic;
    /** @type {string} */
    queueName;
    /** @type {string} */
    accountId;
    /** @type {string} */
    sessionId;
    /** @type {string} */
    recordingReady;
    /** @type {boolean} */
    recordCall;
    /** @type {string} */
    recordedFile;
    /** @type {string} */
    recordedFileUrl;
}

JavaScript QueueNodeWaitCallback DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /nodes/queue/wait-callback HTTP/1.1 
Host: team.evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"waitMusic":[{"mode":"Audio","audioFile":"String","text":"String","textVoice":"Man","numTimes":0}],"queueName":"String","accountId":"String","sessionId":"String","recordingReady":"String","recordCall":false,"recordedFile":"String","recordedFileUrl":"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: application/json
Content-Length: length

(string)