Evo Voice

<back to all web services

QueueNodeWaitCallback

The following routes are available for this service:
All Verbs/nodes/queue/wait-callback


export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


export class TwilioRequestBase implements IPost
{
    public callSid: string;
    public accountSid: string;
    public from: string;
    public to: string;
    public callStatus: string;
    public apiVersion: string;
    public direction: string;
    public forwardedFrom: string;
    public callerName: string;
    public parentCallSid: string;
    public stirVerstat: string;
    public called: string;
    public calledZip: string;
    public calledCity: string;
    public calledState: string;
    public calledCountry: string;
    public caller: string;
    public callerCity: string;
    public callerState: string;
    public callerZip: string;
    public callerCountry: string;
    public fromCity: string;
    public fromState: string;
    public fromZip: string;
    public fromCountry: string;
    public toCity: string;
    public toState: string;
    public toZip: string;
    public toCountry: string;
    public messageSid: string;
    public smsId: string;
    public messagingServiceSid: string;
    public body: string;
    public numMedia: number;
    public mediaContentType0: string;
    public mediaUrl0: string;
    public mediaContentType1: string;
    public mediaUrl1: string;
    public mediaContentType2: string;
    public mediaUrl2: string;
    public index: number;
    public instanceSid: string;
    public eventType: string;
    public channelSid: string;
    public attributes: string;
    public clientIdentity: string;
    public mediaContentType: string;
    public mediaSid: string;
    public identity: string;
    public digits: string;
    public speechResult: string;
    public confidence: number;
    public callDuration: number;
    public recordingUrl: string;
    public recordingSid: string;
    public recordingDuration: number;
    public recordingStatus: string;
    public transcriptionSid: string;
    public transcriptionText: string;
    public transcriptionUrl: string;
    public transcriptionStatus: string;
    public dialCallStatus: string;
    public dialCallSid: string;
    public dialCallDuration: number;
    public dialBridged: boolean;
    public queueResult: string;
    public queueSid: string;
    public queueTime: number;
    public conferenceSid: string;
    public friendlyName: string;
    public statusCallbackEvent: string;
    public muted: boolean;
    public hold: boolean;
    public endConferenceOnExit: boolean;
    public startConferenceOnEnter: boolean;
    public eventName: string;
    public assistantSid: string;
    public dialogueSid: string;
    public userIdentifier: string;
    public currentInput: string;
    public currentTask: string;
    public dialoguePayloadUrl: string;
    public memory: string;
    public channel: string;
    public faxSid: string;
    public faxStatus: string;
    public numPages: number;
    public mediaUrl: string;
    public errorCode: string;
    public errorMessage: string;

    public constructor(init?: Partial<TwilioRequestBase>) { (Object as any).assign(this, init); }
}

export enum QueueWaitMusicModes
{
    Audio = 'Audio',
    Text = 'Text',
}

export enum SayVoices
{
    Man = 'Man',
    Woman = 'Woman',
    Polly_Mads_Danish_Male = 'Polly_Mads_Danish_Male',
    Polly_Naja_Danish_Female = 'Polly_Naja_Danish_Female',
    Polly_Lotte_Dutch_Female = 'Polly_Lotte_Dutch_Female',
    Polly_Ruben_Dutch_Male = 'Polly_Ruben_Dutch_Male',
    Polly_Nicole_Australian_Female = 'Polly_Nicole_Australian_Female',
    Polly_Russell_Australian_Male = 'Polly_Russell_Australian_Male',
    Polly_Amy_British_Female = 'Polly_Amy_British_Female',
    Polly_Brian_British_Male = 'Polly_Brian_British_Male',
    Polly_Emma_British_Female = 'Polly_Emma_British_Female',
    Polly_Raveena_Indian_Female = 'Polly_Raveena_Indian_Female',
    Polly_Ivy_US_Female = 'Polly_Ivy_US_Female',
    Polly_Joanna_US_Female = 'Polly_Joanna_US_Female',
    Polly_Joey_US_Male = 'Polly_Joey_US_Male',
    Polly_Justin_US_Male = 'Polly_Justin_US_Male',
    Polly_Kendra_US_Female = 'Polly_Kendra_US_Female',
    Polly_Kimberly_US_Female = 'Polly_Kimberly_US_Female',
    Polly_Matthew_US_Male = 'Polly_Matthew_US_Male',
    Polly_Salli_US_Female = 'Polly_Salli_US_Female',
    Polly_Geraint_Welsh_Male = 'Polly_Geraint_Welsh_Male',
    Polly_Celine_French_Female = 'Polly_Celine_French_Female',
    Polly_Mathieu_French_Male = 'Polly_Mathieu_French_Male',
    Polly_Chantal_French_Canadian_Female = 'Polly_Chantal_French_Canadian_Female',
    Polly_Hans_German_Male = 'Polly_Hans_German_Male',
    Polly_Marlene_German_Female = 'Polly_Marlene_German_Female',
    Polly_Vicki_German_Female = 'Polly_Vicki_German_Female',
    Polly_Dora_Iceland_Female = 'Polly_Dora_Iceland_Female',
    Polly_Karl_Iceland_Male = 'Polly_Karl_Iceland_Male',
    Polly_Carla_Italian_Female = 'Polly_Carla_Italian_Female',
    Polly_Giorgio_Italian_Male = 'Polly_Giorgio_Italian_Male',
    Polly_Mizuki_Japanese_Female = 'Polly_Mizuki_Japanese_Female',
    Polly_Takumi_Japanese_Male = 'Polly_Takumi_Japanese_Male',
    Polly_Liv_Norwegian_Female = 'Polly_Liv_Norwegian_Female',
    Polly_Jacek_Polish_Male = 'Polly_Jacek_Polish_Male',
    Polly_Jan_Polish_Female = 'Polly_Jan_Polish_Female',
    Polly_Ewa_Polish_Female = 'Polly_Ewa_Polish_Female',
    Polly_Maja_Polish_Female = 'Polly_Maja_Polish_Female',
    Polly_Ricardo_Portuguese_Male = 'Polly_Ricardo_Portuguese_Male',
    Polly_Vitoria_Portuguese_Female = 'Polly_Vitoria_Portuguese_Female',
    Polly_Cristiano_Portuguese_Male = 'Polly_Cristiano_Portuguese_Male',
    Polly_Inese_Portuguese_Female = 'Polly_Inese_Portuguese_Female',
    Polly_Carmen_Romanian_Female = 'Polly_Carmen_Romanian_Female',
    Polly_Maxim_Russian_Male = 'Polly_Maxim_Russian_Male',
    Polly_Tatyana_Russian_Female = 'Polly_Tatyana_Russian_Female',
    Polly_Conchita_Spanish_Female = 'Polly_Conchita_Spanish_Female',
    Polly_Enrique_Spanish_Male = 'Polly_Enrique_Spanish_Male',
    Polly_Miguel_Latin_American_Male = 'Polly_Miguel_Latin_American_Male',
    Polly_Penelope_Latina_American_Female = 'Polly_Penelope_Latina_American_Female',
    Polly_Astrid_Swedish_Female = 'Polly_Astrid_Swedish_Female',
    Polly_Filiz_Turkish_Male = 'Polly_Filiz_Turkish_Male',
    Polly_Gwyneth_Welsh_Female = 'Polly_Gwyneth_Welsh_Female',
}

export class QueueWaitMusic
{
    public mode: QueueWaitMusicModes;
    public audioFile: string;
    public text: string;
    public textVoice: SayVoices;
    public numTimes: number;

    public constructor(init?: Partial<QueueWaitMusic>) { (Object as any).assign(this, init); }
}

export class QueueNodeWaitCallback extends TwilioRequestBase
{
    public waitMusic: QueueWaitMusic[];
    public queueName: string;
    public accountId: string;
    public sessionId: string;
    public recordingReady: string;
    public recordCall: boolean;
    public recordedFile: string;
    public recordedFileUrl: string;

    public constructor(init?: Partial<QueueNodeWaitCallback>) { super(init); (Object as any).assign(this, init); }
}

TypeScript QueueNodeWaitCallback DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<QueueNodeWaitCallback xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Nodes.CallCenter">
  <AccountSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</AccountSid>
  <ApiVersion xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ApiVersion>
  <AssistantSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</AssistantSid>
  <Attributes xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Attributes>
  <Body xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Body>
  <CallDuration xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</CallDuration>
  <CallSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallSid>
  <CallStatus xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallStatus>
  <Called xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Called>
  <CalledCity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CalledCity>
  <CalledCountry xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CalledCountry>
  <CalledState xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CalledState>
  <CalledZip xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CalledZip>
  <Caller xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Caller>
  <CallerCity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallerCity>
  <CallerCountry xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallerCountry>
  <CallerName xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallerName>
  <CallerState xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallerState>
  <CallerZip xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CallerZip>
  <Channel xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Channel>
  <ChannelSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ChannelSid>
  <ClientIdentity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ClientIdentity>
  <ConferenceSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ConferenceSid>
  <Confidence xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</Confidence>
  <CurrentInput xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CurrentInput>
  <CurrentTask xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</CurrentTask>
  <DialBridged xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">false</DialBridged>
  <DialCallDuration xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</DialCallDuration>
  <DialCallSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</DialCallSid>
  <DialCallStatus xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</DialCallStatus>
  <DialoguePayloadUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</DialoguePayloadUrl>
  <DialogueSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</DialogueSid>
  <Digits xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Digits>
  <Direction xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Direction>
  <EndConferenceOnExit xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">false</EndConferenceOnExit>
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ErrorMessage>
  <EventName xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</EventName>
  <EventType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</EventType>
  <FaxSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FaxSid>
  <FaxStatus xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FaxStatus>
  <ForwardedFrom xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ForwardedFrom>
  <FriendlyName xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FriendlyName>
  <From xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</From>
  <FromCity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FromCity>
  <FromCountry xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FromCountry>
  <FromState xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FromState>
  <FromZip xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</FromZip>
  <Hold xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">false</Hold>
  <Identity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Identity>
  <Index xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</Index>
  <InstanceSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</InstanceSid>
  <MediaContentType xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaContentType>
  <MediaContentType0 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaContentType0>
  <MediaContentType1 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaContentType1>
  <MediaContentType2 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaContentType2>
  <MediaSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaSid>
  <MediaUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaUrl>
  <MediaUrl0 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaUrl0>
  <MediaUrl1 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaUrl1>
  <MediaUrl2 xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MediaUrl2>
  <Memory xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</Memory>
  <MessageSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MessageSid>
  <MessagingServiceSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</MessagingServiceSid>
  <Muted xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">false</Muted>
  <NumMedia xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</NumMedia>
  <NumPages xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</NumPages>
  <ParentCallSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ParentCallSid>
  <QueueResult xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</QueueResult>
  <QueueSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</QueueSid>
  <QueueTime xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</QueueTime>
  <RecordingDuration xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">0</RecordingDuration>
  <RecordingSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</RecordingSid>
  <RecordingStatus xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</RecordingStatus>
  <RecordingUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</RecordingUrl>
  <SmsId xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</SmsId>
  <SpeechResult xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</SpeechResult>
  <StartConferenceOnEnter xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">false</StartConferenceOnEnter>
  <StatusCallbackEvent xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</StatusCallbackEvent>
  <StirVerstat xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</StirVerstat>
  <To xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</To>
  <ToCity xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ToCity>
  <ToCountry xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ToCountry>
  <ToState xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ToState>
  <ToZip xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</ToZip>
  <TranscriptionSid xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</TranscriptionSid>
  <TranscriptionStatus xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</TranscriptionStatus>
  <TranscriptionText xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</TranscriptionText>
  <TranscriptionUrl xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</TranscriptionUrl>
  <UserIdentifier xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Twilio">String</UserIdentifier>
  <AccountId>String</AccountId>
  <QueueName>String</QueueName>
  <RecordCall>false</RecordCall>
  <RecordedFile>String</RecordedFile>
  <RecordedFileUrl>String</RecordedFileUrl>
  <RecordingReady>String</RecordingReady>
  <SessionId>String</SessionId>
  <WaitMusic>
    <QueueWaitMusic>
      <AudioFile>String</AudioFile>
      <Mode>Audio</Mode>
      <NumTimes>0</NumTimes>
      <Text>String</Text>
      <TextVoice>Man</TextVoice>
    </QueueWaitMusic>
  </WaitMusic>
</QueueNodeWaitCallback>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

(string)