Bitrix API

Strictly extends Queue

Class Strictly

Table of Contents

Constants

PREFIX_KEY_LOCK  = 'imol_transfer_chat_id_'

Methods

__construct()  : mixed
Queue constructor.
automaticActionAddMessage()  : bool
The automatic action for an incoming message from an external source
createSession()  : array<string|int, mixed>
enableGroupChat()  : self
getAllOperatorsQueue()  : array<string|int, mixed>
getAvailableOperators()  : array<string|int, mixed>
getOperatorsQueue()  : array<string|int, mixed>
getQueueTime()  : int
Returns the default queue time
isActiveCrmUser()  : bool|string
Check the operator responsible for CRM on the possibility of transfer of chat.
isOperatorActive()  : bool|string
Basic check that the operator is active.
isOperatorAvailable()  : bool
Check the ability to send a dialog to the operator.
isOperatorsActiveLine()  : bool
Are there any available operators in the line.
isRemoveSession()  : bool|string
Do I need to remove the session from the operator?
isUndistributedSession()  : bool
Check for unallocated sessions.
sendMessageSkipAlone()  : mixed
setCrmManager()  : self
startLock()  : bool
stopLock()  : bool
transferOperatorNotAvailable()  : void
Directing a conversation to a queue when an operator is not available.
transferOperatorOffline()  : bool
transferToNext()  : bool
Transfer the dialog to the next operator.

Constants

PREFIX_KEY_LOCK

public mixed PREFIX_KEY_LOCK = 'imol_transfer_chat_id_'

Methods

__construct()

Queue constructor.

public __construct(Session $session) : mixed
Parameters
$session : Session

automaticActionAddMessage()

The automatic action for an incoming message from an external source

public automaticActionAddMessage([bool $finish = false ][, bool $vote = false ]) : bool
Parameters
$finish : bool = false
$vote : bool = false
Return values
bool

createSession()

public createSession([int $operatorId = 0 ]) : array<string|int, mixed>
Parameters
$operatorId : int = 0
Return values
array<string|int, mixed>

enableGroupChat()

public enableGroupChat(bool $flag) : self
Parameters
$flag : bool
Return values
self

getAllOperatorsQueue()

public getAllOperatorsQueue([mixed $currentOperator = 0 ]) : array<string|int, mixed>
Parameters
$currentOperator : mixed = 0
Return values
array<string|int, mixed>

getAvailableOperators()

public getAvailableOperators(array<string|int, mixed> $userIds[, mixed $currentOperatorId = 0 ]) : array<string|int, mixed>
Parameters
$userIds : array<string|int, mixed>
$currentOperatorId : mixed = 0
Return values
array<string|int, mixed>

getOperatorsQueue()

public getOperatorsQueue([int $currentOperator = 0 ]) : array<string|int, mixed>
Parameters
$currentOperator : int = 0
Return values
array<string|int, mixed>

getQueueTime()

Returns the default queue time

public getQueueTime() : int
Return values
int

isActiveCrmUser()

Check the operator responsible for CRM on the possibility of transfer of chat.

public isActiveCrmUser(mixed $userId) : bool|string
Parameters
$userId : mixed
Return values
bool|string

isOperatorActive()

Basic check that the operator is active.

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

isOperatorAvailable()

Check the ability to send a dialog to the operator.

public isOperatorAvailable(mixed $userId[, int $currentOperator = 0 ]) : bool
Parameters
$userId : mixed
$currentOperator : int = 0
Return values
bool

isOperatorsActiveLine()

Are there any available operators in the line.

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

isRemoveSession()

Do I need to remove the session from the operator?

public isRemoveSession([bool $finish = false ][, bool $vote = false ][, bool $noCache = false ]) : bool|string
Parameters
$finish : bool = false
$vote : bool = false
$noCache : bool = false
Return values
bool|string

isUndistributedSession()

Check for unallocated sessions.

public isUndistributedSession() : bool
Return values
bool

sendMessageSkipAlone()

public static sendMessageSkipAlone(mixed $chatId) : mixed
Parameters
$chatId : mixed

setCrmManager()

public setCrmManager(Crm $crmManager) : self
Parameters
$crmManager : Crm
Return values
self

startLock()

public startLock() : bool
Return values
bool

stopLock()

public stopLock() : bool
Return values
bool

transferOperatorNotAvailable()

Directing a conversation to a queue when an operator is not available.

public transferOperatorNotAvailable([string $reasonReturn = ImOpenLinesQueue::REASON_OPERATOR_NOT_AVAILABLE ]) : void
Parameters
$reasonReturn : string = ImOpenLinesQueue::REASON_OPERATOR_NOT_AVAILABLE

transferOperatorOffline()

public transferOperatorOffline() : bool
Return values
bool

transferToNext()

Transfer the dialog to the next operator.

public transferToNext([bool $manual = true ]) : bool
Parameters
$manual : bool = true
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results