messagemedia-simple 1.0.1

Simple MessageMedia module for sending SMS messages.

Simple MessageMedia API wrapper

Simple and easy to use module for sending SMS and MMS messages through MessageMedia API.

Installation

The easiest way is to install the package from Python Package Index:

pip3 install messagemedia-simple

Note that messagemedia-simple is only available for Python 3.6 and newer. Installation for older Python versions will fail.

Usage - sending a SMS message

The module interface pretty much mirrors the MessageMedia Mesages API. Refer to the API documentation for details about all the possible settings.

from messagemedia_simple import MessagesAPI

API_KEY = "ABCDEFGH1234567890XX"
API_SECRET = "1234567890asdfghjkl1234567890x"

# MessageMedia API object
mm = MessagesAPI(API_KEY, API_SECRET, hmac_auth=True)

# Send a SMS message and print `message_id`
send_response = mm.send_message("Some content", "[phone]")
print(f"message_id: {send_response['message_id']})

Now we can check the message delivery status as it progresses from enroute through submitted to delivered:

status_response = mm.get_message_status(send_response["message_id"])
print(f"status: {status_response['status']})

And finally we can retrieve Message Replies. Unfortunately through the API we can only retrieve all queued, unconfirmed replies rather than just those for a given message_id. The filtering has to be done locally after all the replies are retrieved.

# Retrieve all replies from MessageMedia
replies_response = mm.get_replies()

# Filter only the relevant replies
my_replies = [r for r in replies_response["replies"] if r["message_id"]==send_response["message_id"]]

# Process the replies
for reply in my_replies:
  print(f"{reply['content']}")

MessageMedia API has a concept of confirming a reply - as soon as a reply is confirmed it is no longer returned from get_replies() call. That means only confirm a reply after it's successfully processed, for example written to a local database. Multiple replies can be confirmed at once if needed.

for reply in my_replies:
  print(f"{reply['content']}")
  mm.confirm_replies(reply["reply_id"])

Likewise we can retrieve and confirm the delivery reports using get_delivery_reports() and confirm_delivery_reports(). The logic of the operation is the same as with replies.

Sending a MMS and specifying additional parameters

For MMS messages we can specify a few more options, for example Subject, embedded images, links, etc.

The send_message() function doesn't have named parameters for all the possible options. However we can pass any valid option as documented in the Send Message API. The extra parameters are not validated in any way and it's the caller responsibility to ensure that they are valid for the API.

response = mm.send_message(
    format = "MMS",
    subject = "Happy new year!",
    content = "All the best in 2020",
    media = [
        "https://images.pexels.com/photos/2526105/pexels-photo-2526105.jpeg?cs=srgb&dl=fireworks-display-2526105.jpg&h=853&w=1280"
    ],
    destination_number = "[phone]",
    scheduled = "2020-01-01T00:00:00.000Z",
    message_expiry_timestamp = "2020-01-01T01:23:45.678Z",
    metadata = { "new_year": 2020 },
)

Note that MMS sending has to be enabled first by MessageMedia support.

Author

Michael Ludvig @ enterprise IT