Bitrix API

SmsManager

Table of Contents

Constants

ON_MESSAGE_SUCCESSFULLY_SENT_EVENT  = 'OnMessageSuccessfullySent'

Methods

canUse()  : bool
createMessage()  : Message
createMessageListByTemplate()  : array<int, Message>
getDefaultSender()  : Base
Get default SMS sender.
getManageUrl()  : string
getMessageStatus()  : mixed
getRegisteredSenderList()  : array<string|int, BaseConfigurable>
getSenderById()  : Base|null
getSenderInfoList()  : array<string|int, mixed>
getSenders()  : array<string|int, Base>
getSenderSelectList()  : array<string|int, mixed>
getUsableSender()  : Base|null
Get first Sender which is ready to use it.
sendMessage()  : Result|AddResult
sendMessageDirectly()  : SendMessage

Constants

ON_MESSAGE_SUCCESSFULLY_SENT_EVENT

public mixed ON_MESSAGE_SUCCESSFULLY_SENT_EVENT = 'OnMessageSuccessfullySent'

Methods

canUse()

public static canUse() : bool
Return values
bool —

Can use SMS transport.

createMessage()

public static createMessage(array<string|int, mixed> $messageFields[, Base|null $sender = null ]) : Message
Parameters
$messageFields : array<string|int, mixed>
$sender : Base|null = null
Tags
throws
ArgumentTypeException
Return values
Message

createMessageListByTemplate()

public static createMessageListByTemplate(string $eventName[, array<string|int, mixed> $fields = [] ]) : array<int, Message>
Parameters
$eventName : string
$fields : array<string|int, mixed> = []
Return values
array<int, Message>

getDefaultSender()

Get default SMS sender.

public static getDefaultSender() : Base
Return values
Base

getManageUrl()

public static getManageUrl() : string
Return values
string —

Manage url

getMessageStatus()

public static getMessageStatus(mixed $messageId) : mixed
Parameters
$messageId : mixed

getSenderById()

public static getSenderById(mixed $id) : Base|null
Parameters
$id : mixed
Return values
Base|null —

Sender instance.

getSenderInfoList()

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

Sender list information.

getSenders()

public static getSenders() : array<string|int, Base>
Return values
array<string|int, Base> —

List of senders.

getSenderSelectList()

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

Simple list of senders, array(id => name)

getUsableSender()

Get first Sender which is ready to use it.

public static getUsableSender() : Base|null
Return values
Base|null —

Sender instance.

sendMessage()

public static sendMessage(array<string|int, mixed> $messageFields[, Base|null $sender = null ]) : Result|AddResult
Parameters
$messageFields : array<string|int, mixed>
$sender : Base|null = null
Tags
throws
ArgumentTypeException
Return values
Result|AddResult

sendMessageDirectly()

public static sendMessageDirectly(array<string|int, mixed> $messageFields[, Base|null $sender = null ]) : SendMessage
Parameters
$messageFields : array<string|int, mixed>
$sender : Base|null = null
Tags
throws
ArgumentTypeException
Return values
SendMessage 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results