Bitrix API

Transferor

Table of Contents

Methods

cancelTransfer()  : bool
Finishes and removes transfer sub-call.
completePhoneTransfer()  : mixed
Handler for the transfer completion event, when the transfer was performed using SIP phone.
completeTransfer()  : Result
Performs actions when call transfer is complete: - update call responsible - update lead responsible - inform new responsible's browser - remove temporary call
createCallerId()  : string
Returns caller id for the transfer sub-call.
createCallId()  : string
Return id for the transfer sub-call.
initiateTransfer()  : Result
Creates child call, which will be used for the call transfer procedure.
startBlindTransfer()  : mixed

Methods

cancelTransfer()

Finishes and removes transfer sub-call.

public static cancelTransfer(string $callId, string $code, string $reason) : bool
Parameters
$callId : string

Id of the transfer sub-call.

$code : string

SIP code of the call completion.

$reason : string

Text description of the code of the call completion.

Return values
bool

completePhoneTransfer()

Handler for the transfer completion event, when the transfer was performed using SIP phone.

public static completePhoneTransfer(string $firstCallId, string $secondCallId, int $initiatorUserId) : mixed
Parameters
$firstCallId : string

Id of the transfer initiator call.

$secondCallId : string

Id of the transfer target call.

$initiatorUserId : int

Id of the user, who initiated call transfer.

Tags
throws
Exception

completeTransfer()

Performs actions when call transfer is complete: - update call responsible - update lead responsible - inform new responsible's browser - remove temporary call

public static completeTransfer(string $callId, int $newUserId, mixed $device) : Result
Parameters
$callId : string

Id of the transfer sub-call.

$newUserId : int

Id of the user, accepted the call.

$device : mixed
Tags
params

string $device Device type of the connected user.

throws
Exception
Return values
Result

createCallerId()

Returns caller id for the transfer sub-call.

public static createCallerId(string $targetType, string $targetId) : string
Parameters
$targetType : string

Transfer target type (@see Target).

$targetId : string

Transfer target id.

Tags
throws
ArgumentException
Return values
string

createCallId()

Return id for the transfer sub-call.

public static createCallId() : string
Return values
string

initiateTransfer()

Creates child call, which will be used for the call transfer procedure.

public static initiateTransfer(string $parentCallId, int $userId, string $targetType, string $targetId) : Result
Parameters
$parentCallId : string

Id of the parent call.

$userId : int

Id of the user, who requested call transfer.

$targetType : string

Transfer target type (@see Target).

$targetId : string

Transfer target id.

Return values
Result

startBlindTransfer()

public static startBlindTransfer(mixed $callId, mixed $userId) : mixed
Parameters
$callId : mixed
$userId : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results