Bitrix API

TelegramBot extends Base implements MessengerUrl

Class TelegramBot

Table of Contents

Interfaces

MessengerUrl

Constants

REF_PREFIX  = 'btrx'
The prefix for start parameter.

Methods

__construct()  : mixed
Connector constructor.
deleteMessageProcessing()  : array<string|int, mixed>
getMessengerUrl()  : array{web: string, mob: string}
Generate url to redirect into messenger app.
getUserByUserCode()  : Result
isEnableSendSystemMessage()  : bool
markMessageUndelivered()  : void
Updates message with undelivered mark.
preparationNewUserFields()  : array<string|int, mixed>
Preparation of new user fields before saving or adding.
preparationUserFields()  : array<string|int, mixed>
Preparation of user fields before saving or adding.
processingInputCommand()  : Result
Command handler for message like /start /start smth /start btrxSmth
processingInputCommandKeyboard()  : Result
processingInputDelMessage()  : Result
processingInputNewMessage()  : Result
processingInputNewPost()  : Result
processingInputSessionVote()  : Result
processingInputTypingStatus()  : Result
processingInputUpdateMessage()  : Result
processingInputUpdatePost()  : Result
processingInputWelcomeMessage()  : Result
receivedError()  : bool
removeMessageDeliveryMark()  : void
Unsets waiting delidery mark.
saveFile()  : false|int|string
Save file
sendAutomaticMessage()  : int|null
sendMessageProcessing()  : array<string|int, mixed>
updateMessageProcessing()  : array<string|int, mixed>

Constants

REF_PREFIX

The prefix for start parameter.

public mixed REF_PREFIX = 'btrx'

Methods

__construct()

Connector constructor.

public __construct() : mixed

deleteMessageProcessing()

public deleteMessageProcessing(array<string|int, mixed> $message, mixed $line) : array<string|int, mixed>
Parameters
$message : array<string|int, mixed>
$line : mixed
Return values
array<string|int, mixed>

getMessengerUrl()

Generate url to redirect into messenger app.

public getMessengerUrl(int $lineId[, array<string|int, mixed>|string|null $additional = null ]) : array{web: string, mob: string}
Parameters
$lineId : int
$additional : array<string|int, mixed>|string|null = null
Tags
see
https://core.telegram.org/api/links#bot-links
Return values
array{web: string, mob: string}

getUserByUserCode()

public getUserByUserCode(array<string|int, mixed> $user) : Result
Parameters
$user : array<string|int, mixed>
Return values
Result

isEnableSendSystemMessage()

public isEnableSendSystemMessage(Session $session) : bool
Parameters
$session : Session
Return values
bool

markMessageUndelivered()

Updates message with undelivered mark.

public markMessageUndelivered(int $messageId) : void
Parameters
$messageId : int

Message Id.

preparationNewUserFields()

Preparation of new user fields before saving or adding.

public preparationNewUserFields(array<string|int, mixed> $user) : array<string|int, mixed>
Parameters
$user : array<string|int, mixed>

An array describing the user.

Return values
array<string|int, mixed> —

Given the right format array description user.

preparationUserFields()

Preparation of user fields before saving or adding.

public preparationUserFields(array<string|int, mixed> $user[, mixed $userId = 0 ]) : array<string|int, mixed>
Parameters
$user : array<string|int, mixed>

An array describing the user.

$userId : mixed = 0
Return values
array<string|int, mixed> —

Given the right format array description user.

processingInputCommand()

Command handler for message like /start /start smth /start btrxSmth

public processingInputCommand(string $command, array<string|int, mixed> $message, int $line) : Result
Parameters
$command : string
$message : array<string|int, mixed>
$line : int
Return values
Result

processingInputCommandKeyboard()

public processingInputCommandKeyboard(mixed $params, mixed $line) : Result
Parameters
$params : mixed
$line : mixed
Return values
Result

processingInputDelMessage()

public processingInputDelMessage(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputNewMessage()

public processingInputNewMessage(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputNewPost()

public processingInputNewPost(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputSessionVote()

public processingInputSessionVote(mixed $params, mixed $line) : Result
Parameters
$params : mixed
$line : mixed
Return values
Result

processingInputTypingStatus()

public processingInputTypingStatus(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputUpdateMessage()

public processingInputUpdateMessage(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputUpdatePost()

public processingInputUpdatePost(mixed $message, mixed $line) : Result
Parameters
$message : mixed
$line : mixed
Return values
Result

processingInputWelcomeMessage()

public processingInputWelcomeMessage(array<string|int, mixed> $message, int $line) : Result
Parameters
$message : array<string|int, mixed>
$line : int
Return values
Result

receivedError()

public receivedError(mixed $paramsError) : bool
Parameters
$paramsError : mixed
Tags
see
Input::receivingError
Return values
bool

removeMessageDeliveryMark()

Unsets waiting delidery mark.

public removeMessageDeliveryMark(int $messageId, int $chatId) : void
Parameters
$messageId : int
$chatId : int

saveFile()

Save file

public saveFile(mixed $file) : false|int|string
Parameters
$file : mixed
Return values
false|int|string

sendAutomaticMessage()

public sendAutomaticMessage(string $messageText, string $crmEntityType, int $crmEntityId) : int|null
Parameters
$messageText : string
$crmEntityType : string
$crmEntityId : int
Return values
int|null

sendMessageProcessing()

public sendMessageProcessing(array<string|int, mixed> $message, mixed $line) : array<string|int, mixed>
Parameters
$message : array<string|int, mixed>
$line : mixed
Return values
array<string|int, mixed>

updateMessageProcessing()

public updateMessageProcessing(array<string|int, mixed> $message, mixed $line) : array<string|int, mixed>
Parameters
$message : array<string|int, mixed>
$line : mixed
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results