Bitrix API

ImOpenLinesManager extends Base

Table of Contents

Constants

META_PARAM  = 'scm'

Methods

createImMessageByCompilationLink()  : string
getAllImMessagePreviews()  : array<string|int, mixed>
getClientInfo()  : array<string|int, mixed>
Get client info.
getCompilationPreviewData()  : array<string|int, mixed>
getCrmInfo()  : array<string|int, mixed>|bool
getDialogId()  : false|string
getDialogIdsByUserId()  : array<string|int, mixed>
getImMessagePreview()  : string|null
getInstance()  : static
getOrderPreviewData()  : array<string|int, mixed>
getPaymentPreviewData()  : array<string|int, mixed>
getPublicUrlInfoForOrder()  : array<string|int, mixed>|false
getPublicUrlInfoForPayment()  : array<string|int, mixed>|false
getSessionIdsByUserId()  : array<string|int, mixed>
getSessionInfo()  : array<string|int, mixed>|false
getUserId()  : false|int
isEnabled()  : bool
sendActivityNotify()  : Result
sendCompilationMessage()  : Result
sendDealNotify()  : Result
Sends system message to the manager about the deal.
sendNewOrderNotification()  : Result
Send system notification in dialog about new created order from client
sendOrderCheckWarning()  : Result
sendOrderMessage()  : Result
Sends text messages to the client and the manager about the order with public url.
sendOrderNotify()  : Result
Sends system message to the manager about the order and its current payment status.
sendPage()  : Result
Sending a landing page or CRM form
sendPaymentCheckNotify()  : Result
Send message with check public url after printing. In case such url is available.
sendPaymentCheckNotifyError()  : Result
Send system notify about check printing error.
sendPaymentMessage()  : Result
sendPaymentNotify()  : mixed
sendPaymentPayNotify()  : Result
Sends system message about the order to the operator and payment status to the client and the manager.
sendReorderNotification()  : Result
Send system notification to the dialog about reorder
setSessionId()  : $this
updateDealAfterCreation()  : void

Constants

Methods

createImMessageByCompilationLink()

public createImMessageByCompilationLink(string $compilationLink) : string
Parameters
$compilationLink : string
Return values
string

getAllImMessagePreviews()

public getAllImMessagePreviews() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientInfo()

Get client info.

public getClientInfo() : array<string|int, mixed>

About deals: If a deal is not linked to the OpenLine, but a lead is linked that has an active (not finished) deal, then the deal of the lead will be returned as OWNER_*.

Return values
array<string|int, mixed> —

with OWNER_ID, OWNER_TYPE_ID, COMPANY_ID, CONTACT_IDS, USER_ID

getCompilationPreviewData()

public getCompilationPreviewData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCrmInfo()

public getCrmInfo() : array<string|int, mixed>|bool
Tags
throws
LoaderException
Return values
array<string|int, mixed>|bool

getDialogIdsByUserId()

public getDialogIdsByUserId(mixed $userId) : array<string|int, mixed>
Parameters
$userId : mixed
Return values
array<string|int, mixed>

getImMessagePreview()

public getImMessagePreview([mixed $mode = CrmManager::SMS_MODE_PAYMENT ]) : string|null
Parameters
$mode : mixed = CrmManager::SMS_MODE_PAYMENT
Return values
string|null

getInstance()

public static getInstance() : static
Return values
static

getOrderPreviewData()

public getOrderPreviewData(Order $order) : array<string|int, mixed>
Parameters
$order : Order
Return values
array<string|int, mixed>

getPaymentPreviewData()

public getPaymentPreviewData(Payment $payment) : array<string|int, mixed>
Parameters
$payment : Payment
Return values
array<string|int, mixed>

getPublicUrlInfoForOrder()

public getPublicUrlInfoForOrder(Order $order) : array<string|int, mixed>|false
Parameters
$order : Order
Return values
array<string|int, mixed>|false

getPublicUrlInfoForPayment()

public getPublicUrlInfoForPayment(Payment $payment) : array<string|int, mixed>|false
Parameters
$payment : Payment
Return values
array<string|int, mixed>|false

getSessionIdsByUserId()

public getSessionIdsByUserId(mixed $userId) : array<string|int, mixed>
Parameters
$userId : mixed
Return values
array<string|int, mixed>

getSessionInfo()

public getSessionInfo() : array<string|int, mixed>|false
Return values
array<string|int, mixed>|false

isEnabled()

public isEnabled() : bool
Return values
bool

sendActivityNotify()

public sendActivityNotify(array<string|int, mixed> $activity, mixed $sessionId) : Result
Parameters
$activity : array<string|int, mixed>
$sessionId : mixed
Return values
Result

sendCompilationMessage()

public sendCompilationMessage(mixed $compilationLink, mixed $dialogId, mixed $dealId) : Result
Parameters
$compilationLink : mixed
$dialogId : mixed
$dealId : mixed
Return values
Result

sendDealNotify()

Sends system message to the manager about the deal.

public sendDealNotify(int $dealId, mixed $dialogId) : Result
Parameters
$dealId : int
$dialogId : mixed
Return values
Result

sendNewOrderNotification()

Send system notification in dialog about new created order from client

public sendNewOrderNotification(mixed $dialogId, mixed $order) : Result
Parameters
$dialogId : mixed
$order : mixed
Return values
Result

sendOrderCheckWarning()

public sendOrderCheckWarning(Order $order, mixed $dialogId) : Result
Parameters
$order : Order
$dialogId : mixed
Tags
throws
ObjectPropertyException
throws
SystemException
Return values
Result

sendOrderMessage()

Sends text messages to the client and the manager about the order with public url.

public sendOrderMessage(Order $order, mixed $dialogId[, array<string|int, mixed> $paymentData = [] ]) : Result
Parameters
$order : Order
$dialogId : mixed
$paymentData : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

sendOrderNotify()

Sends system message to the manager about the order and its current payment status.

public sendOrderNotify(Order $order, mixed $dialogId[, bool $isNew = true ]) : Result
Parameters
$order : Order
$dialogId : mixed
$isNew : bool = true
Return values
Result

sendPage()

Sending a landing page or CRM form

public sendPage(Page $page, mixed $dialogId) : Result
Parameters
$page : Page
$dialogId : mixed
Tags
throws
ArgumentException
throws
LoaderException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

sendPaymentCheckNotify()

Send message with check public url after printing. In case such url is available.

public sendPaymentCheckNotify(int $checkId, Payment $payment) : Result
Parameters
$checkId : int
$payment : Payment
Return values
Result

sendPaymentCheckNotifyError()

Send system notify about check printing error.

public sendPaymentCheckNotifyError(int $checkId, Payment $payment, string $message) : Result
Parameters
$checkId : int
$payment : Payment
$message : string

Error message.

Return values
Result

sendPaymentMessage()

public sendPaymentMessage(Payment $payment, mixed $dialogId[, array<string|int, mixed> $paymentData = [] ]) : Result
Parameters
$payment : Payment
$dialogId : mixed
$paymentData : array<string|int, mixed> = []
Return values
Result

sendPaymentNotify()

public sendPaymentNotify(Payment $payment, mixed $dialogId[, bool $isNew = true ]) : mixed
Parameters
$payment : Payment
$dialogId : mixed
$isNew : bool = true

sendPaymentPayNotify()

Sends system message about the order to the operator and payment status to the client and the manager.

public sendPaymentPayNotify(Payment $payment) : Result
Parameters
$payment : Payment
Return values
Result

sendReorderNotification()

Send system notification to the dialog about reorder

public sendReorderNotification(mixed $dialogId) : Result
Parameters
$dialogId : mixed
Return values
Result

setSessionId()

public setSessionId(mixed $sessionId) : $this
Parameters
$sessionId : mixed
Return values
$this

updateDealAfterCreation()

public updateDealAfterCreation(int $dealId, int $sessionId) : void
Parameters
$dealId : int
$sessionId : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results