Bitrix API

CrmManager extends Base

Table of Contents

Constants

SMS_MODE_COMPILATION  = 'compilation'
SMS_MODE_PAYMENT  = 'payment'

Methods

addTimelineEntryOnOrderSend()  : void
addTimelineEntryOnPaymentSend()  : void
getActivityViewUrl()  : bool|string
getAllSmsTemplates()  : array<string|int, mixed>
getClientAddressList()  : array<string|int, int>
getClientInfo()  : array<string|int, mixed>
getContactPhoneFormat()  : string
Does not actually format the phone; the function's name is kept for backwards compatibility
getContactsLink()  : false|string
getDealContactPhoneFormat()  : mixed|string
getDealsLink()  : false|string
getDefaultMyCompanyPhoneId()  : int
getDefaultSmsTemplate()  : mixed
getDefaultWrappedSmsTemplate()  : mixed
getFormattedContactPhone()  : string
getInstance()  : static
getItemContactEditorUrl()  : mixed|string
getItemContactFields()  : mixed
getItemContactPhoneFormatted()  : mixed|string
getLeadActiveDeal()  : Deal|null
Get active (not finished) deal that has been converted from the lead.
getMyCompanyAddressList()  : array<string|int, int>
getOrderIdByEntity()  : int|null
getOrderLimitSliderId()  : mixed
getPublishedCompanyEmail()  : array<string|int, mixed>
getPublishedCompanyName()  : string
getPublishedCompanyPhone()  : array<string|int, mixed>
getSaleAdminPages()  : array<string|int, mixed>
getSmsTemplate()  : mixed
getStageList()  : array<string|int, mixed>
getStageWithDeliveryFinishedTrigger()  : mixed|string
getStageWithOrderPaidTrigger()  : mixed|string
getTerminalPaymentRuntimeReferenceField()  : ReferenceField|null
getUsableSmsSendersList()  : array<string|int, mixed>
getWebForms()  : array<string|int, mixed>
isEnabled()  : bool
isOrderLimitReached()  : mixed
isOwnerEntityExists()  : bool
isOwnerEntityInFinalStage()  : bool
isPaymentFromTerminal()  : bool
isShowSmsTile()  : bool
isTerminalAvailable()  : bool
onSendCompilation()  : void
onSendPaymentByControlCenter()  : mixed
onSendPaymentBySms()  : void
saveSmsTemplate()  : mixed
saveTriggerOnDeliveryFinished()  : int|mixed
saveTriggerOnOrderPaid()  : int|mixed
sendApplicationLinkBySms()  : bool
sendCompilationBySms()  : bool
sendPaymentBySms()  : mixed
sendPaymentSlipBySms()  : bool
Send link to payment check (slip) after success payment
setDefaultMyCompanyPhoneId()  : void

Constants

SMS_MODE_COMPILATION

public mixed SMS_MODE_COMPILATION = 'compilation'

SMS_MODE_PAYMENT

public mixed SMS_MODE_PAYMENT = 'payment'

Methods

addTimelineEntryOnOrderSend()

public addTimelineEntryOnOrderSend(Order $order, array<string|int, mixed> $options) : void
Parameters
$order : Order
$options : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
SystemException

addTimelineEntryOnPaymentSend()

public static addTimelineEntryOnPaymentSend(Payment $payment, array<string|int, mixed> $options) : void
Parameters
$payment : Payment
$options : array<string|int, mixed>
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
SystemException

getActivityViewUrl()

public getActivityViewUrl(int $activityId) : bool|string
Parameters
$activityId : int
Return values
bool|string

getAllSmsTemplates()

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

getClientAddressList()

public getClientAddressList(int $contactId) : array<string|int, int>
Parameters
$contactId : int
Return values
array<string|int, int>

getClientInfo()

public getClientInfo(mixed $ownerTypeId, mixed $ownerId) : array<string|int, mixed>
Parameters
$ownerTypeId : mixed
$ownerId : mixed
Return values
array<string|int, mixed>

getContactPhoneFormat()

Does not actually format the phone; the function's name is kept for backwards compatibility

public static getContactPhoneFormat(int $contactId) : string
Parameters
$contactId : int
Tags
see
CrmManager::getFormattedContactPhone()

if you need a formatted phone

Return values
string

getContactsLink()

public getContactsLink([bool $fromSettings = false ]) : false|string
Parameters
$fromSettings : bool = false
Return values
false|string

getDealContactPhoneFormat()

public getDealContactPhoneFormat(int $dealId) : mixed|string
Parameters
$dealId : int
Return values
mixed|string

getDealsLink()

public getDealsLink([bool $fromSettings = false ]) : false|string
Parameters
$fromSettings : bool = false
Return values
false|string

getDefaultMyCompanyPhoneId()

public static getDefaultMyCompanyPhoneId() : int
Return values
int

getDefaultSmsTemplate()

public getDefaultSmsTemplate([mixed $mode = self::SMS_MODE_PAYMENT ]) : mixed
Parameters
$mode : mixed = self::SMS_MODE_PAYMENT

getDefaultWrappedSmsTemplate()

public getDefaultWrappedSmsTemplate([mixed $mode = self::SMS_MODE_PAYMENT ]) : mixed
Parameters
$mode : mixed = self::SMS_MODE_PAYMENT

getFormattedContactPhone()

public static getFormattedContactPhone(int $contactId) : string
Parameters
$contactId : int
Return values
string

getInstance()

public static getInstance() : static
Return values
static

getItemContactEditorUrl()

public getItemContactEditorUrl(Item $item) : mixed|string
Parameters
$item : Item
Return values
mixed|string

getItemContactFields()

public getItemContactFields(Item $item) : mixed
Parameters
$item : Item

getItemContactPhoneFormatted()

public getItemContactPhoneFormatted(Item $item) : mixed|string
Parameters
$item : Item
Return values
mixed|string

getLeadActiveDeal()

Get active (not finished) deal that has been converted from the lead.

public getLeadActiveDeal(int $leadId) : Deal|null
Parameters
$leadId : int
Return values
Deal|null

getMyCompanyAddressList()

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

getOrderIdByEntity()

public static getOrderIdByEntity(Item $entity) : int|null
Parameters
$entity : Item
Return values
int|null

getOrderLimitSliderId()

public getOrderLimitSliderId() : mixed

getPublishedCompanyEmail()

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

getPublishedCompanyName()

public static getPublishedCompanyName() : string
Return values
string

getPublishedCompanyPhone()

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

getSaleAdminPages()

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

getSmsTemplate()

public getSmsTemplate([mixed $mode = self::SMS_MODE_PAYMENT ]) : mixed
Parameters
$mode : mixed = self::SMS_MODE_PAYMENT

getStageList()

public getStageList(int $entityId, int $entityTypeId) : array<string|int, mixed>
Parameters
$entityId : int
$entityTypeId : int
Return values
array<string|int, mixed>

getStageWithDeliveryFinishedTrigger()

public getStageWithDeliveryFinishedTrigger(mixed $entityId, mixed $entityTypeId) : mixed|string
Parameters
$entityId : mixed
$entityTypeId : mixed
Return values
mixed|string

getStageWithOrderPaidTrigger()

public getStageWithOrderPaidTrigger(mixed $entityId, mixed $entityTypeId) : mixed|string
Parameters
$entityId : mixed
$entityTypeId : mixed
Return values
mixed|string

getTerminalPaymentRuntimeReferenceField()

public getTerminalPaymentRuntimeReferenceField() : ReferenceField|null
Return values
ReferenceField|null

getUsableSmsSendersList()

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

getWebForms()

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

isEnabled()

public isEnabled() : bool
Return values
bool

isOrderLimitReached()

public isOrderLimitReached() : mixed

isOwnerEntityExists()

public isOwnerEntityExists(int $ownerId, int $ownerTypeId) : bool
Parameters
$ownerId : int
$ownerTypeId : int
Return values
bool

isOwnerEntityInFinalStage()

public isOwnerEntityInFinalStage(int $ownerId, int $ownerTypeId) : bool
Parameters
$ownerId : int
$ownerTypeId : int
Return values
bool

isPaymentFromTerminal()

public isPaymentFromTerminal(Payment $payment) : bool
Parameters
$payment : Payment
Return values
bool

isShowSmsTile()

public isShowSmsTile() : bool
Return values
bool

isTerminalAvailable()

public isTerminalAvailable() : bool
Return values
bool

onSendCompilation()

public static onSendCompilation(Event $event) : void
Parameters
$event : Event

onSendPaymentByControlCenter()

public static onSendPaymentByControlCenter(Event $event) : mixed
Parameters
$event : Event

onSendPaymentBySms()

public static onSendPaymentBySms(Event $event) : void
Parameters
$event : Event

saveSmsTemplate()

public saveSmsTemplate(mixed $template[, mixed $mode = self::SMS_MODE_PAYMENT ]) : mixed
Parameters
$template : mixed
$mode : mixed = self::SMS_MODE_PAYMENT

saveTriggerOnDeliveryFinished()

public saveTriggerOnDeliveryFinished(mixed $entityId, mixed $entityTypeId, mixed $stageId) : int|mixed
Parameters
$entityId : mixed
$entityTypeId : mixed
$stageId : mixed
Return values
int|mixed

saveTriggerOnOrderPaid()

public saveTriggerOnOrderPaid(mixed $entityId, mixed $entityTypeId, mixed $stageId) : int|mixed
Parameters
$entityId : mixed
$entityTypeId : mixed
$stageId : mixed
Return values
int|mixed

sendApplicationLinkBySms()

public sendApplicationLinkBySms(string $phone, string $senderId, int $responsibleId, ItemIdentifier $entity) : bool
Parameters
$phone : string
$senderId : string
$responsibleId : int
$entity : ItemIdentifier
Return values
bool

sendCompilationBySms()

public sendCompilationBySms(int $compilationId, int $dealId, array<string|int, mixed> $compilationLink, array<string|int, mixed> $sendingInfo) : bool
Parameters
$compilationId : int
$dealId : int
$compilationLink : array<string|int, mixed>
$sendingInfo : array<string|int, mixed>
Return values
bool

sendPaymentBySms()

public sendPaymentBySms(Payment $payment, array<string|int, mixed> $sendingInfo[, Shipment $shipment = null ]) : mixed
Parameters
$payment : Payment
$sendingInfo : array<string|int, mixed>
$shipment : Shipment = null

sendPaymentSlipBySms()

Send link to payment check (slip) after success payment

public sendPaymentSlipBySms(Payment $payment) : bool
Parameters
$payment : Payment
Return values
bool

setDefaultMyCompanyPhoneId()

public static setDefaultMyCompanyPhoneId(mixed $id) : void
Parameters
$id : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results