MessageMedia Messages Ruby SDK
The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.
Table of Contents
:closed_lock_with_key: Authentication
Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
Requests are authenticated using HTTP Basic Auth or HMAC. For Basic Auth, your API key will be basicAuthUserName and API secret will be basicAuthPassword. For HMAC, your API key will be hmacAuthUserName and API secret will be hmacAuthPassword. This is demonstrated in the Send an SMS example below.
:interrobang: Errors
Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The most common status codes are listed below.
HTTP Status Codes
| Code | Title | Description |
|---|---|---|
| 400 | Invalid Request | The request was invalid |
| 401 | Unauthorized | Your API credentials are invalid |
| 403 | Disabled feature | Feature not enabled |
| 404 | Not Found | The resource does not exist |
| 50X | Internal Server Error | An error occurred with our API |
:newspaper: Information
Slack and Mailing List
If you have any questions, comments, or concerns, please join our Slack channel: https://developers.messagemedia.com/collaborate/slack/
Alternatively you can email us at: [email protected]
Bug reports
If you discover a problem with the SDK, we would like to know about it. You can raise an issue or send an email to: [email protected]
Contributing
We welcome your thoughts on how we could best provide you with SDKs that would simplify how you consume our services in your application. You can fork and create pull requests for any features you would like to see or raise an issue. Please be aware that a large share of the files are auto-generated by our backend tool.
:star: Installation
- Run the following command to install the SDK via RubyGems:
gem install messages-ruby-sdk --version "3.0.0" --source "https://rubygems.pkg.github.com/messagemedia"
:clapper: Get Started
It's easy to get started. Simply enter the API Key and secret you obtained from the MessageMedia Developers Portal into the code snippet below and a mobile number you wish to send to.
Send an SMS
Destination (destinationNumber) and source number (sourceNumber) should be in the E.164 format. For example, +61491570156 NOT 0491570156. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over here. Alternatively, you can refer this code snippet with all the parameters in use.
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
= client.
body = SendMessagesRequest.new
body. = []
body.[0] = Message.new
body.[0].content = 'My first message'
body.[0].destination_number = '+61491570156'
begin
result = .(body)
pp result
rescue SendMessages400ResponseException => ex
puts "Caught SendMessages400ResponseException: #{ex.}"
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Send an MMS
Destination (destinationNumber) and source number (sourceNumber) should be in the E.164 format. For example, +61491570156 NOT 0491570156. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over here. Alternatively, you can refer this code snippet with all the parameters in use.
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
= client.
body = SendMessagesRequest.new
body. = []
body.[0] = Message.new
body.[0].content = 'My second message'
body.[0].destination_number = '+61491570158'
body.[0].format = FormatEnum::MMS
body.[0].media = ['https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg']
body.[0].subject = 'This is an MMS message'
begin
result = .(body)
pp result
rescue SendMessages400ResponseException => ex
puts "Caught SendMessages400ResponseException: #{ex.}"
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Get Status of a Message
You can get a messsage ID from a sent message by looking at the message_id from the response of the above example.
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
= client.
= '877c19ef-fa2e-4cec-827a-e1df9b5509f7'
begin
result = .()
pp result
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Get replies to a message
You can check for replies that are sent to your messages
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
replies_controller = client.replies
begin
result = replies_controller.check_replies()
pp replies
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Check Delivery Reports
This endpoint allows you to check for delivery reports to inbound and outbound messages.
require 'message_media_messages'
require 'pp'
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
delivery_reports_controller = client.delivery_reports
begin
result = delivery_reports_controller.check_delivery_reports()
pp result
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Confirm Delivery Reports
This endpoint allows you to mark delivery reports as confirmed so they're no longer returned by the Check Delivery Reports function.
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
delivery_reports_controller = client.delivery_reports
body = ConfirmDeliveryReportsAsReceivedRequest.new
body.delivery_report_ids = ['011dcead-6988-4ad6-a1c7-6b6c68ea628d', '3487b3fa-6586-4979-a233-2d1b095c7718', 'ba28e94b-c83d-4759-98e7-ff9c7edb87a1']
begin
result = delivery_reports_controller.confirm_delivery_reports_as_received(body)
pp result
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
Check credits remaining (Prepaid accounts only)
This endpoint allows you to check for credits remaining on your prepaid account.
require 'message_media_messages'
require 'pp'
include MessageMediaMessages
auth_user_name = 'API_KEY'
auth_password = 'API_SECRET'
use_hmac = false
client = MessageMediaMessages::MessageMediaMessagesClient.new(
auth_user_name: auth_user_name,
auth_password: auth_password,
use_hmac_authentication: use_hmac
)
= client.
begin
result = .check_credits_remaining()
pp result
rescue APIException => ex
puts "Caught APIException: #{ex.}"
end
:closed_book: API Reference Documentation
Check out the full API documentation for more detailed information.
:confused: Need help?
Please contact developer support at [email protected] or check out the developer portal at developers.messagemedia.com
:page_with_curl: License
Apache License. See the LICENSE file.