| All Verbs | /nodes/queue/wait-callback |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WaitMusic | query | List<QueueWaitMusic> | No | |
| QueueName | query | string | No | |
| AccountId | query | string | No | |
| SessionId | query | string | No | |
| RecordingReady | query | string | No | |
| RecordCall | query | bool | No | |
| RecordedFile | query | string | No | |
| RecordedFileUrl | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CallSid | form | string | No | |
| AccountSid | form | string | No | |
| From | form | string | No | |
| To | form | string | No | |
| CallStatus | form | string | No | |
| ApiVersion | form | string | No | |
| Direction | form | string | No | |
| ForwardedFrom | form | string | No | |
| CallerName | form | string | No | |
| ParentCallSid | form | string | No | |
| StirVerstat | form | string | No | |
| Called | form | string | No | |
| CalledZip | form | string | No | |
| CalledCity | form | string | No | |
| CalledState | form | string | No | |
| CalledCountry | form | string | No | |
| Caller | form | string | No | |
| CallerCity | form | string | No | |
| CallerState | form | string | No | |
| CallerZip | form | string | No | |
| CallerCountry | form | string | No | |
| FromCity | form | string | No | |
| FromState | form | string | No | |
| FromZip | form | string | No | |
| FromCountry | form | string | No | |
| ToCity | form | string | No | |
| ToState | form | string | No | |
| ToZip | form | string | No | |
| ToCountry | form | string | No | |
| MessageSid | form | string | No | |
| SmsId | form | string | No | |
| MessagingServiceSid | form | string | No | |
| Body | form | string | No | |
| NumMedia | form | int | No | |
| MediaContentType0 | form | string | No | |
| MediaUrl0 | form | string | No | |
| MediaContentType1 | form | string | No | |
| MediaUrl1 | form | string | No | |
| MediaContentType2 | form | string | No | |
| MediaUrl2 | form | string | No | |
| Index | form | int | No | |
| InstanceSid | form | string | No | |
| EventType | form | string | No | |
| ChannelSid | form | string | No | |
| Attributes | form | string | No | |
| ClientIdentity | form | string | No | |
| MediaContentType | form | string | No | |
| MediaSid | form | string | No | |
| Identity | form | string | No | |
| Digits | form | string | No | |
| SpeechResult | form | string | No | |
| Confidence | form | double | No | |
| CallDuration | form | int | No | |
| RecordingUrl | form | string | No | |
| RecordingSid | form | string | No | |
| RecordingDuration | form | int | No | |
| RecordingStatus | form | string | No | |
| TranscriptionSid | form | string | No | |
| TranscriptionText | form | string | No | |
| TranscriptionUrl | form | string | No | |
| TranscriptionStatus | form | string | No | |
| DialCallStatus | form | string | No | |
| DialCallSid | form | string | No | |
| DialCallDuration | form | double | No | |
| DialBridged | form | bool | No | |
| QueueResult | form | string | No | |
| QueueSid | form | string | No | |
| QueueTime | form | int | No | |
| ConferenceSid | form | string | No | |
| FriendlyName | form | string | No | |
| StatusCallbackEvent | form | string | No | |
| Muted | form | bool | No | |
| Hold | form | bool | No | |
| EndConferenceOnExit | form | bool | No | |
| StartConferenceOnEnter | form | bool | No | |
| EventName | form | string | No | |
| AssistantSid | form | string | No | |
| DialogueSid | form | string | No | |
| UserIdentifier | form | string | No | |
| CurrentInput | form | string | No | |
| CurrentTask | form | string | No | |
| DialoguePayloadUrl | form | string | No | |
| Memory | form | string | No | |
| Channel | form | string | No | |
| FaxSid | form | string | No | |
| FaxStatus | form | string | No | |
| NumPages | form | int | No | |
| MediaUrl | form | string | No | |
| ErrorCode | form | string | No | |
| ErrorMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Mode | form | QueueWaitMusicModes | No | |
| AudioFile | form | string | No | |
| Text | form | string | No | |
| TextVoice | form | SayVoices | No | |
| NumTimes | form | int | No |
| Audio | |
| Text |
| 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 |
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 /nodes/queue/wait-callback HTTP/1.1
Host: evovoice.io
Accept: text/jsv
Content-Type: text/jsv
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: text/jsv Content-Length: length (string)