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 .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: 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)