Rate this page:

SmartQueueTaskParameters

Settings of a certain SmartQueueTask. Can be passed as arguments to the VoxEngine.enqueueTask method.

Props

call
Optional
Copy URL
call: 

Call

Optional. Current task's Call object.

customData
Optional
Copy URL
customData: 

string

Optional. Custom data text string for the current task. After you specify the data in this field, you can find it in the SmartQueueState_Task object for this task. To get this object, call the GetSQState method.

extraHeaders
Optional
Copy URL
extraHeaders: 

{[header: string]: string}

Optional. Custom parameters (SIP headers) to be passed with the task. Custom header names have to begin with the 'X-' prefix. The "X-" headers can be handled by a SIP phone or WEB SDK (e.g. see the incomingCall event). Example: {'X-header':'value'}

maxVideoBitrate
Optional
Copy URL
maxVideoBitrate: 

number

Optional. Maximum possible video bitrate for the customer device in kbps.

operatorSettings
Optional
Copy URL
operatorSettings: 

SmartQueueOperatorSettings

Optional. Task's operator settings.

priority
Optional
Copy URL
priority: 

number

Optional. The task's priority. Accept values from 1 to 100. The default value is 50.

queue
Copy URL
queue: 

SmartQueue

Queue for the current task.

scheme
Optional
Copy URL
scheme: 

Scheme

Optional. Internal information about codecs. Pass the value received from a call event as-is. Do not inspect or modify the object. Reconstructing or mutating the payload can break codec negotiation.

skills
Optional
Copy URL
skills: 

SmartQueueSkill[]

Optional. Skills required for the task.

timeout
Optional
Copy URL
timeout: 

number

Optional. A timeout in seconds for the task to be accepted by an agent.

video
Optional
Copy URL
video: 

boolean

Optional. Whether the call has video support. Please note that prices for audio only and video calls are different.

Rate this page: