Bitrix API

Queue

AbstractYes

Class Queue

Table of Contents

Constants

MAX_SESSION_RETURN  = 100

Methods

__construct()  : mixed
Queue constructor.
checkFreeSlotOnChatAnswer()  : mixed
OnChatAnswer event handler for filling free slots
checkFreeSlotOnChatFinish()  : void
OnChatSkip/OnChatMarkSpam/OnChatFinish/OnOperatorTransfer event handler for filling free slots
checkFreeSlotOnMessageSend()  : void
OnImopenlineMessageSend event handler for filling free slots
getCountFreeSlots()  : int
Returns the number of sessions an open line can accept.
getMaxInteractionCount()  : int
Returns maximum session number per interaction.
isOperatorActive()  : bool|string
Basic check that the operator is active.
isOperatorsActiveLine()  : bool
Are there any available operators in the line.
returnNotAcceptedSessionsToQueue()  : void
Return to the queue of not accepted or missed sessions.
returnNotDistributedSessionsToQueue()  : void
Return to the queue not distributed sessions
returnSessionsUsersToQueue()  : void
Returns all operator sessions.
returnSessionsUsersToQueueIsStartAbsence()  : void
Return to the session queue the user who went on vacation.
returnUserToQueue()  : void
Send recent messages to operator in current queue when he return to work.

Constants

MAX_SESSION_RETURN

public mixed MAX_SESSION_RETURN = 100

Methods

__construct()

Queue constructor.

public __construct(array<string|int, mixed> $configLine) : mixed
Parameters
$configLine : array<string|int, mixed>

checkFreeSlotOnChatAnswer()

OnChatAnswer event handler for filling free slots

public checkFreeSlotOnChatAnswer() : mixed

checkFreeSlotOnChatFinish()

OnChatSkip/OnChatMarkSpam/OnChatFinish/OnOperatorTransfer event handler for filling free slots

public checkFreeSlotOnChatFinish() : void

checkFreeSlotOnMessageSend()

OnImopenlineMessageSend event handler for filling free slots

public checkFreeSlotOnMessageSend(array<string|int, mixed> $messageData) : void
Parameters
$messageData : array<string|int, mixed>

getCountFreeSlots()

Returns the number of sessions an open line can accept.

public getCountFreeSlots() : int
Return values
int

getMaxInteractionCount()

Returns maximum session number per interaction.

public static getMaxInteractionCount() : int
Return values
int

isOperatorActive()

Basic check that the operator is active.

public isOperatorActive(int $userId[, bool $ignorePause = false ]) : bool|string
Parameters
$userId : int
$ignorePause : bool = false
Return values
bool|string

isOperatorsActiveLine()

Are there any available operators in the line.

public isOperatorsActiveLine([bool $ignorePause = false ]) : bool
Parameters
$ignorePause : bool = false
Return values
bool

returnNotAcceptedSessionsToQueue()

Return to the queue of not accepted or missed sessions.

public returnNotAcceptedSessionsToQueue(int $userId[, string $reasonReturn = ImOpenLinesQueue::REASON_DEFAULT ]) : void
Parameters
$userId : int
$reasonReturn : string = ImOpenLinesQueue::REASON_DEFAULT

returnNotDistributedSessionsToQueue()

Return to the queue not distributed sessions

public returnNotDistributedSessionsToQueue([string $reasonReturn = ImOpenLinesQueue::REASON_DEFAULT ]) : void
Parameters
$reasonReturn : string = ImOpenLinesQueue::REASON_DEFAULT

returnSessionsUsersToQueue()

Returns all operator sessions.

public returnSessionsUsersToQueue(array<string|int, int> $userIds[, string $reasonReturn = ImOpenLinesQueue::REASON_DEFAULT ]) : void
Parameters
$userIds : array<string|int, int>
$reasonReturn : string = ImOpenLinesQueue::REASON_DEFAULT

returnSessionsUsersToQueueIsStartAbsence()

Return to the session queue the user who went on vacation.

public returnSessionsUsersToQueueIsStartAbsence(int $userId, int $durationAbsenceDay[, string $reasonReturn = ImOpenLinesQueue::REASON_DEFAULT ]) : void
Parameters
$userId : int
$durationAbsenceDay : int
$reasonReturn : string = ImOpenLinesQueue::REASON_DEFAULT

returnUserToQueue()

Send recent messages to operator in current queue when he return to work.

public abstract returnUserToQueue(array<string|int, int> $userIds) : void
Parameters
$userIds : array<string|int, int> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results