PAMI\Message\Event\VgsmSmsRxEvent

On reception of an inbound SMS (SMS-DELIVERY) the message will also be reported as a manager event, however, acknowledgment still relies on SMS spooler to handle the message. This event is generated starting from 0.21.0

PHP Version 5

Constants

EOL

const EOL = "\r\n"

EOM

const EOM = "\r\n\r\n"

Properties

$rawContent

protected string $rawContent

Holds original message.

  • Visibility: protected

$channelVariables

protected array<mixed,string> $channelVariables

Metadata. Specific channel variables.

  • Visibility: protected

$lines

protected array<mixed,string> $lines

Message content, line by line. This is what it gets sent or received literally.

  • Visibility: protected

$variables

protected array<mixed,string> $variables

Metadata. Message variables (key/value).

  • Visibility: protected

$keys

protected array<mixed,string> $keys

Metadata. Message "keys" i.e: Action: login

  • Visibility: protected

$createdDate

protected integer $createdDate

Created date (unix timestamp).

  • Visibility: protected

Methods

getPrivilege

string PAMI\Message\Event\VgsmSmsRxEvent::getPrivilege()

Returns key: 'Privilege'.

  • Visibility: public

getReceived

string PAMI\Message\Event\VgsmSmsRxEvent::getReceived()

Returns key: 'Received'.

  • Visibility: public

getFrom

string PAMI\Message\Event\VgsmSmsRxEvent::getFrom()

Returns key: 'From'.

  • Visibility: public

getSubject

string PAMI\Message\Event\VgsmSmsRxEvent::getSubject()

Returns key: 'Subject'.

  • Visibility: public

getMimeVersion

string PAMI\Message\Event\VgsmSmsRxEvent::getMimeVersion()

Returns key: 'MIME-Version'.

  • Visibility: public

getContentType

string PAMI\Message\Event\VgsmSmsRxEvent::getContentType()

Returns key: 'Content-Type'.

  • Visibility: public

getContentEncoding

string PAMI\Message\Event\VgsmSmsRxEvent::getContentEncoding()

Returns key: 'Content-Transfer-Encoding'.

  • Visibility: public

getDate

string PAMI\Message\Event\VgsmSmsRxEvent::getDate()

Returns key: 'Date'.

  • Visibility: public

getContent

string PAMI\Message\Event\VgsmSmsRxEvent::getContent()

Returns key: 'Content'.

  • Visibility: public

getMessageType

string PAMI\Message\Event\VgsmSmsRxEvent::getMessageType()

Returns key: 'X-SMS-Message-Type:'.

  • Visibility: public

getSenderNP

string PAMI\Message\Event\VgsmSmsRxEvent::getSenderNP()

Returns key: 'X-SMS-Sender-NP'.

  • Visibility: public

getSenderTON

string PAMI\Message\Event\VgsmSmsRxEvent::getSenderTON()

Returns key: 'X-SMS-Sender-TON'.

  • Visibility: public

getSenderNumber

string PAMI\Message\Event\VgsmSmsRxEvent::getSenderNumber()

Returns key: 'X-SMS-Sender-Number'.

  • Visibility: public

getSMCCNP

string PAMI\Message\Event\VgsmSmsRxEvent::getSMCCNP()

Returns key: 'X-SMS-SMCC-NP'.

  • Visibility: public

getSMCCTON

string PAMI\Message\Event\VgsmSmsRxEvent::getSMCCTON()

Returns key: 'X-SMS-SMCC-TON'.

  • Visibility: public

getSMCCNumber

string PAMI\Message\Event\VgsmSmsRxEvent::getSMCCNumber()

Returns key: 'X-SMS-SMCC-Number'.

  • Visibility: public

getMoreMessagesToSend

string PAMI\Message\Event\VgsmSmsRxEvent::getMoreMessagesToSend()

Returns key: 'X-SMS-More-Messages-To-Send'.

  • Visibility: public

getReplyPath

string PAMI\Message\Event\VgsmSmsRxEvent::getReplyPath()

Returns key: 'X-SMS-Reply-Path'.

  • Visibility: public

getDataHeaderIndicator

string PAMI\Message\Event\VgsmSmsRxEvent::getDataHeaderIndicator()

Returns key: 'XX-SMS-User-Data-Header-Indicator'.

  • Visibility: public

getStatusReportIndication

string PAMI\Message\Event\VgsmSmsRxEvent::getStatusReportIndication()

Returns key: 'X-SMS-Status-Report-Indication'.

  • Visibility: public

getName

string PAMI\Message\Event\EventMessage::getName()

Returns key 'Event'.

__sleep

array<mixed,string> PAMI\Message\Message::__sleep()

Serialize function.

getEventList

string PAMI\Message\IncomingMessage::getEventList()

Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".

getRawContent

string PAMI\Message\IncomingMessage::getRawContent()

Returns the original message content without parsing.

getAllChannelVariables

array PAMI\Message\IncomingMessage::getAllChannelVariables()

Returns the channel variables for all reported channels.

https://github.com/marcelog/PAMI/issues/85

The channel names will be lowercased.

getChannelVariables

array PAMI\Message\IncomingMessage::getChannelVariables(string $channel)

Returns the channel variables for the given channel.

https://github.com/marcelog/PAMI/issues/85

Arguments

  • $channel string - <p>Channel name. If not given, will return variables for the "current" channel.</p>

__construct

void PAMI\Message\Message::__construct()

Constructor.

getCreatedDate

integer PAMI\Message\Message::getCreatedDate()

Returns created date.

setVariable

void PAMI\Message\Message::setVariable(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Variable name.</p>
  • $value string - <p>Variable value.</p>

getVariable

string PAMI\Message\Message::getVariable(string $key)

Returns a variable by name.

Arguments

  • $key string - <p>Variable name.</p>

setKey

void PAMI\Message\Message::setKey(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>
  • $value string - <p>Key value.</p>

getKey

string PAMI\Message\Message::getKey(string $key)

Returns a key by name.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>

getKeys

array<mixed,string> PAMI\Message\Message::getKeys()

Returns all keys for this message.

getVariables

array<mixed,string> PAMI\Message\Message::getVariables()

Returns all variabels for this message.

finishMessage

string PAMI\Message\Message::finishMessage($message)

Returns the end of message token appended to the end of a given message.

Arguments

  • $message mixed

serializeVariable

string PAMI\Message\Message::serializeVariable(string $key, string $value)

Returns the string representation for an ami action variable.

Arguments

  • $key string
  • $value string

serialize

string PAMI\Message\Message::serialize()

Gives a string representation for this message, ready to be sent to ami.

getActionID

string PAMI\Message\Message::getActionID()

Returns key: 'ActionID'.