on_message_status Event

This event is fired upon receipt of a message.

Syntax

class SMPPMessageStatusEventParams(object):
  @property
  def message_id() -> str: ...
  @property
  def message_state() -> int: ...
  @property
  def message_error() -> int: ...
  @property
  def final_date() -> str: ...

# In class SMPP:
@property
def on_message_status() -> Callable[[SMPPMessageStatusEventParams], None]: ...
@on_message_status.setter
def on_message_status(event_hook: Callable[[SMPPMessageStatusEventParams], None]) -> None: ...

Remarks

When a check_message_status is called, the SMPP class will fetch the status of the message represented by MessageId from the server, parse the response and fire on_message_status.

MessageState represents the last known state the message was left in on the smpp_server. This code is version specific. For v3.4:

1ENROUTE, the message is in enroute state.
2DELIVERED, the message is delivered.
3EXPIRED, the message validity period expired.
4DELETED, the message has been deleted.
5UNDELIVERABLE, the message is undeliverable.
6ACCEPTED, the message has been read on behalf of subscriber by customer service.
7UNKNOWN, the message is in invalid state.
8REJECTED, the message is in a rejected state.

For v5.0:

0SCHEDULED, the message is in scheduled for delivery, but has not yet been delivered.
1ENROUTE, the message is in enroute state.
2DELIVERED, the message is delivered.
3EXPIRED, the message validity period expired.
4DELETED, the message has been deleted.
5UNDELIVERABLE, the message is undeliverable.
6ACCEPTED, the message has been read on behalf of subscriber by customer service.
7UNKNOWN, the message is in invalid state.
8REJECTED, the message is in a rejected state.
9SKIPPED, the message was accepted by not delivered.

MessageError will contain an error code representing any failure encountered during message delivery. This code may be vendor-specific.

FinalDate contains a human-readable string representing the date on which the message was delivered. If the message was not delivered, this parameter will be empty.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]