Evo Voice

<back to all web services

QueueNodeWaitCallback

The following routes are available for this service:
All Verbs/nodes/queue/wait-callback
namespace Voice.Api.Nodes.CallCenter

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TwilioRequestBase() = 
        interface IPost
        member val CallSid:String = null with get,set
        member val AccountSid:String = null with get,set
        member val From:String = null with get,set
        member val To:String = null with get,set
        member val CallStatus:String = null with get,set
        member val ApiVersion:String = null with get,set
        member val Direction:String = null with get,set
        member val ForwardedFrom:String = null with get,set
        member val CallerName:String = null with get,set
        member val ParentCallSid:String = null with get,set
        member val StirVerstat:String = null with get,set
        member val Called:String = null with get,set
        member val CalledZip:String = null with get,set
        member val CalledCity:String = null with get,set
        member val CalledState:String = null with get,set
        member val CalledCountry:String = null with get,set
        member val Caller:String = null with get,set
        member val CallerCity:String = null with get,set
        member val CallerState:String = null with get,set
        member val CallerZip:String = null with get,set
        member val CallerCountry:String = null with get,set
        member val FromCity:String = null with get,set
        member val FromState:String = null with get,set
        member val FromZip:String = null with get,set
        member val FromCountry:String = null with get,set
        member val ToCity:String = null with get,set
        member val ToState:String = null with get,set
        member val ToZip:String = null with get,set
        member val ToCountry:String = null with get,set
        member val MessageSid:String = null with get,set
        member val SmsId:String = null with get,set
        member val MessagingServiceSid:String = null with get,set
        member val Body:String = null with get,set
        member val NumMedia:Int32 = new Int32() with get,set
        member val MediaContentType0:String = null with get,set
        member val MediaUrl0:String = null with get,set
        member val MediaContentType1:String = null with get,set
        member val MediaUrl1:String = null with get,set
        member val MediaContentType2:String = null with get,set
        member val MediaUrl2:String = null with get,set
        member val Index:Int32 = new Int32() with get,set
        member val InstanceSid:String = null with get,set
        member val EventType:String = null with get,set
        member val ChannelSid:String = null with get,set
        member val Attributes:String = null with get,set
        member val ClientIdentity:String = null with get,set
        member val MediaContentType:String = null with get,set
        member val MediaSid:String = null with get,set
        member val Identity:String = null with get,set
        member val Digits:String = null with get,set
        member val SpeechResult:String = null with get,set
        member val Confidence:Double = new Double() with get,set
        member val CallDuration:Int32 = new Int32() with get,set
        member val RecordingUrl:String = null with get,set
        member val RecordingSid:String = null with get,set
        member val RecordingDuration:Int32 = new Int32() with get,set
        member val RecordingStatus:String = null with get,set
        member val TranscriptionSid:String = null with get,set
        member val TranscriptionText:String = null with get,set
        member val TranscriptionUrl:String = null with get,set
        member val TranscriptionStatus:String = null with get,set
        member val DialCallStatus:String = null with get,set
        member val DialCallSid:String = null with get,set
        member val DialCallDuration:Double = new Double() with get,set
        member val DialBridged:Boolean = new Boolean() with get,set
        member val QueueResult:String = null with get,set
        member val QueueSid:String = null with get,set
        member val QueueTime:Int32 = new Int32() with get,set
        member val ConferenceSid:String = null with get,set
        member val FriendlyName:String = null with get,set
        member val StatusCallbackEvent:String = null with get,set
        member val Muted:Boolean = new Boolean() with get,set
        member val Hold:Boolean = new Boolean() with get,set
        member val EndConferenceOnExit:Boolean = new Boolean() with get,set
        member val StartConferenceOnEnter:Boolean = new Boolean() with get,set
        member val EventName:String = null with get,set
        member val AssistantSid:String = null with get,set
        member val DialogueSid:String = null with get,set
        member val UserIdentifier:String = null with get,set
        member val CurrentInput:String = null with get,set
        member val CurrentTask:String = null with get,set
        member val DialoguePayloadUrl:String = null with get,set
        member val Memory:String = null with get,set
        member val Channel:String = null with get,set
        member val FaxSid:String = null with get,set
        member val FaxStatus:String = null with get,set
        member val NumPages:Int32 = new Int32() with get,set
        member val MediaUrl:String = null with get,set
        member val ErrorCode:String = null with get,set
        member val ErrorMessage:String = null with get,set

    type QueueWaitMusicModes =
        | Audio = 0
        | Text = 1

    type SayVoices =
        | Man = 0
        | Woman = 1
        | Polly_Mads_Danish_Male = 2
        | Polly_Naja_Danish_Female = 3
        | Polly_Lotte_Dutch_Female = 4
        | Polly_Ruben_Dutch_Male = 5
        | Polly_Nicole_Australian_Female = 6
        | Polly_Russell_Australian_Male = 7
        | Polly_Amy_British_Female = 8
        | Polly_Brian_British_Male = 9
        | Polly_Emma_British_Female = 10
        | Polly_Raveena_Indian_Female = 11
        | Polly_Ivy_US_Female = 12
        | Polly_Joanna_US_Female = 13
        | Polly_Joey_US_Male = 14
        | Polly_Justin_US_Male = 15
        | Polly_Kendra_US_Female = 16
        | Polly_Kimberly_US_Female = 17
        | Polly_Matthew_US_Male = 18
        | Polly_Salli_US_Female = 19
        | Polly_Geraint_Welsh_Male = 20
        | Polly_Celine_French_Female = 21
        | Polly_Mathieu_French_Male = 22
        | Polly_Chantal_French_Canadian_Female = 23
        | Polly_Hans_German_Male = 24
        | Polly_Marlene_German_Female = 25
        | Polly_Vicki_German_Female = 26
        | Polly_Dora_Iceland_Female = 27
        | Polly_Karl_Iceland_Male = 28
        | Polly_Carla_Italian_Female = 29
        | Polly_Giorgio_Italian_Male = 30
        | Polly_Mizuki_Japanese_Female = 31
        | Polly_Takumi_Japanese_Male = 32
        | Polly_Liv_Norwegian_Female = 33
        | Polly_Jacek_Polish_Male = 34
        | Polly_Jan_Polish_Female = 35
        | Polly_Ewa_Polish_Female = 36
        | Polly_Maja_Polish_Female = 37
        | Polly_Ricardo_Portuguese_Male = 38
        | Polly_Vitoria_Portuguese_Female = 39
        | Polly_Cristiano_Portuguese_Male = 40
        | Polly_Inese_Portuguese_Female = 41
        | Polly_Carmen_Romanian_Female = 42
        | Polly_Maxim_Russian_Male = 43
        | Polly_Tatyana_Russian_Female = 44
        | Polly_Conchita_Spanish_Female = 45
        | Polly_Enrique_Spanish_Male = 46
        | Polly_Miguel_Latin_American_Male = 47
        | Polly_Penelope_Latina_American_Female = 48
        | Polly_Astrid_Swedish_Female = 49
        | Polly_Filiz_Turkish_Male = 50
        | Polly_Gwyneth_Welsh_Female = 51

    [<AllowNullLiteral>]
    type QueueWaitMusic() = 
        member val Mode:QueueWaitMusicModes = new QueueWaitMusicModes() with get,set
        member val AudioFile:String = null with get,set
        member val Text:String = null with get,set
        member val TextVoice:SayVoices = new SayVoices() with get,set
        member val NumTimes:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type QueueNodeWaitCallback() = 
        inherit TwilioRequestBase()
        member val WaitMusic:ResizeArray<QueueWaitMusic> = new ResizeArray<QueueWaitMusic>() with get,set
        member val QueueName:String = null with get,set
        member val AccountId:String = null with get,set
        member val SessionId:String = null with get,set
        member val RecordingReady:String = null with get,set
        member val RecordCall:Boolean = new Boolean() with get,set
        member val RecordedFile:String = null with get,set
        member val RecordedFileUrl:String = null with get,set

F# 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: 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)