Rate this page:

SmartQueueTask

Methods

addEventListener

Copy URL
addEventListener(event: 

SmartQueueEvents

,
callback:

Function

):

void

Subscribes to a smart queue event.

Parameters

  • A smart queue event to subscribe

  • callback:

    Function

    A callback function

Returns

  • type:

    void

end

Copy URL
end(description: 

string

):

void

Ends the current activity.

Parameters

  • description:

    string

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 

SmartQueueEvents

,
callback:

Function

):

void

Removes an smart queue event subscription.

Parameters

  • A smart queue event to unsubscribe

  • callback:

    Function

    A callback function

Returns

  • type:

    void

Props

id

Copy URL
id: 

string

A Smart queue activity's ID.

operatorCall

Copy URL
operatorCall: 

Call

|

null

The operator's Call object.

settings

Copy URL
settings: 

SmartQueueTaskSettings

Specifies the smart queue activity's settings, such as required skills, priority, queue and more.

status

Copy URL
status: 

SmartQueueTaskStatus

Specifies the current status of the activity, whether it is distributing, connecting, connected, ended or failed.

taskCall

Copy URL
taskCall: 

Call

The activity's Call object.

terminationStatus

Copy URL
terminationStatus: 

SmartQueueEndStatus

|

null

Specifies the reason of activity's termination.