Bitrix API

SmsEdnaru extends BaseConfigurable uses RussianProvider

Table of Contents

Constants

ID  = 'smsednaru'

Methods

__construct()  : mixed
addRefreshFromListAgent()  : void
Adds agent for execution.
canUse()  : bool
Check can use state of sender.
className()  : mixed
clearOptions()  : bool
confirmRegistration()  : Result
disableDemo()  : $this
Disable demo mode.
enableDemo()  : $this
Enable demo mode.
getCallbackUrl()  : string
getConfigComponentTemplatePageName()  : string
getDefaultFrom()  : null|string
Get default From.
getExternalId()  : string
getExternalManageUrl()  : string
getFirstFromList()  : mixed|null
getFromList()  : array<string|int, array{id: int, name: string, channelPhone: string}>
getId()  : string
getManageUrl()  : string
getMessageStatus()  : MessageStatus
getMessageTemplates()  : Result
getName()  : string
getOwnerInfo()  : array<string|int, mixed>
getRegistrationUrl()  : string
getSentTemplateMessage()  : string
getShortName()  : string
getTemplatesList()  : array<string|int, mixed>
List of available templates for templates-based senders Should return array of templates like this:
getType()  : string
isConfigurable()  : mixed
isConfirmed()  : bool
Check is registration confirmed.
isCorrectFrom()  : bool
isDemo()  : bool
Check demo status.
isMigratedToNewAPI()  : bool
isRegistered()  : bool
Check registration state.
isSupported()  : bool
isTemplatesBased()  : bool
Can message be created from template only
migrateToNewApi()  : void
prepareMessageBodyForSave()  : string
Prepares text for message body.
prepareTemplate()  : mixed
Prepare template for save in message headers
refreshFromList()  : void
The agent's goal is regular refreshing FromList.
refreshFromListAgent()  : string
The agent's goal is regular refreshing FromList cache.
register()  : Result
resolveStatus()  : int
Converts service status to internal status
sendConfirmationCode()  : Result
sendMessage()  : SendMessage
sendTemplate()  : Result
setDefaultFrom()  : $this
Set default From.
setNewApi()  : void
setSocketTimeout()  : Base
setStreamTimeout()  : Base
sync()  : $this
Sync remote state (load From list etc.)

Constants

Methods

addRefreshFromListAgent()

Adds agent for execution.

public addRefreshFromListAgent() : void
Tags
see
refreshFromListAgent

canUse()

Check can use state of sender.

public canUse() : bool
Return values
bool

className()

public static className() : mixed

confirmRegistration()

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

disableDemo()

Disable demo mode.

public disableDemo() : $this
Return values
$this

enableDemo()

Enable demo mode.

public enableDemo() : $this
Return values
$this

getCallbackUrl()

public getCallbackUrl() : string
Return values
string

getConfigComponentTemplatePageName()

public getConfigComponentTemplatePageName() : string
Return values
string

getDefaultFrom()

Get default From.

public getDefaultFrom() : null|string
Return values
null|string

getExternalId()

public getExternalId() : string
Return values
string

getExternalManageUrl()

public getExternalManageUrl() : string
Return values
string

getFirstFromList()

public getFirstFromList() : mixed|null
Return values
mixed|null

getFromList()

public getFromList() : array<string|int, array{id: int, name: string, channelPhone: string}>
Return values
array<string|int, array{id: int, name: string, channelPhone: string}>

getId()

public getId() : string
Return values
string

getManageUrl()

public getManageUrl() : string
Return values
string

getMessageStatus()

public getMessageStatus(array<string|int, mixed> $messageFields) : MessageStatus
Parameters
$messageFields : array<string|int, mixed>
Return values
MessageStatus

getMessageTemplates()

public getMessageTemplates([string $subject = '' ]) : Result
Parameters
$subject : string = ''
Return values
Result

getName()

public getName() : string
Return values
string

getOwnerInfo()

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

getRegistrationUrl()

public getRegistrationUrl() : string
Return values
string

getSentTemplateMessage()

public getSentTemplateMessage(string $from, string $to) : string
Parameters
$from : string
$to : string
Return values
string

getShortName()

public getShortName() : string
Return values
string

getTemplatesList()

List of available templates for templates-based senders Should return array of templates like this:

public getTemplatesList([array<string|int, mixed>|null $context = null ]) : array<string|int, mixed>

[ ['ID' => '1', 'TITLE' => 'Template 1', 'PREVIEW' => 'Message created from template 1'], ['ID' => '2', 'TITLE' => 'Template 2', 'PREVIEW' => 'Message created from template 2'], ]

Parameters
$context : array<string|int, mixed>|null = null

Context for context-dependant templates

Return values
array<string|int, mixed>

getType()

public getType() : string
Return values
string

isConfirmed()

Check is registration confirmed.

public isConfirmed() : bool
Return values
bool

isCorrectFrom()

public isCorrectFrom(mixed $from) : bool
Parameters
$from : mixed
Return values
bool

isMigratedToNewAPI()

public isMigratedToNewAPI() : bool
Return values
bool

isRegistered()

Check registration state.

public isRegistered() : bool
Return values
bool

isTemplatesBased()

Can message be created from template only

public isTemplatesBased() : bool
Return values
bool

migrateToNewApi()

public migrateToNewApi() : void

prepareMessageBodyForSave()

Prepares text for message body.

public prepareMessageBodyForSave(string $text) : string
Parameters
$text : string
Return values
string

prepareTemplate()

Prepare template for save in message headers

public prepareTemplate(mixed $templateData) : mixed
Parameters
$templateData : mixed

refreshFromList()

The agent's goal is regular refreshing FromList.

public refreshFromList() : void

refreshFromListAgent()

The agent's goal is regular refreshing FromList cache.

public static refreshFromListAgent() : string
Return values
string

register()

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

resolveStatus()

Converts service status to internal status

public static resolveStatus(mixed $serviceStatus) : int
Parameters
$serviceStatus : mixed
Return values
int

sendConfirmationCode()

public sendConfirmationCode() : Result
Return values
Result

sendMessage()

public sendMessage(array<string|int, mixed> $messageFields) : SendMessage
Parameters
$messageFields : array<string|int, mixed>
Return values
SendMessage —

Send operation result.

sendTemplate()

public sendTemplate(string $name, string $text[, array<string|int, mixed> $examples = [] ][, string|null $langCode = null ]) : Result
Parameters
$name : string
$text : string
$examples : array<string|int, mixed> = []
$langCode : string|null = null
Return values
Result

setDefaultFrom()

Set default From.

public setDefaultFrom(string $from) : $this
Parameters
$from : string

From.

Return values
$this

setNewApi()

public setNewApi(bool $mode) : void
Parameters
$mode : bool

setSocketTimeout()

public setSocketTimeout(int $socketTimeout) : Base
Parameters
$socketTimeout : int
Return values
Base

setStreamTimeout()

public setStreamTimeout(int $streamTimeout) : Base
Parameters
$streamTimeout : int
Return values
Base

sync()

Sync remote state (load From list etc.)

public sync() : $this
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results