{"id":25097239,"url":"https://github.com/messagemedia/messages-ruby-sdk","last_synced_at":"2025-08-01T17:05:28.330Z","repository":{"id":28789117,"uuid":"111404970","full_name":"messagemedia/messages-ruby-sdk","owner":"messagemedia","description":"MessageMedia Ruby SDK for sending and receiving messages","archived":false,"fork":false,"pushed_at":"2025-07-13T09:34:00.000Z","size":251,"stargazers_count":8,"open_issues_count":8,"forks_count":20,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-07-13T11:34:38.501Z","etag":null,"topics":["messagemedia","messaging","ruby","sms","sms-api","sms-client","sms-gateway","sms-messages"],"latest_commit_sha":null,"homepage":"https://developers.messagemedia.com/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/messagemedia.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-20T12:00:58.000Z","updated_at":"2025-07-13T09:34:04.000Z","dependencies_parsed_at":"2023-01-14T09:35:26.770Z","dependency_job_id":"f32583ab-f54e-48ba-8dfa-b481bbcf955b","html_url":"https://github.com/messagemedia/messages-ruby-sdk","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/messagemedia/messages-ruby-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messagemedia%2Fmessages-ruby-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messagemedia%2Fmessages-ruby-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messagemedia%2Fmessages-ruby-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messagemedia%2Fmessages-ruby-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/messagemedia","download_url":"https://codeload.github.com/messagemedia/messages-ruby-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messagemedia%2Fmessages-ruby-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268265631,"owners_count":24222519,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["messagemedia","messaging","ruby","sms","sms-api","sms-client","sms-gateway","sms-messages"],"created_at":"2025-02-07T17:30:49.813Z","updated_at":"2025-08-01T17:05:28.319Z","avatar_url":"https://github.com/messagemedia.png","language":"Ruby","readme":"## 🚨 Repository Deprecated – No Longer Maintained\n\n\u003e **Important:** This SDK is no longer maintained.\n\nThis repository (`Messages Ruby SDK`) has not been actively maintained for several years and is now officially **deprecated**. No further updates, bug fixes, or support will be provided.\n\nIf you're building applications that integrate with the Sinch MessageMedia Messaging API, we recommend using direct REST API calls instead. You can find the complete and up-to-date API documentation here:  \n👉 [MessageMedia Messaging REST API Docs](https://messagemedia.github.io/documentation/#tag/Messages)\n\nThe source code remains available under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). Feel free to fork and update it to suit your needs.\n\n\n\n# MessageMedia Messages Ruby SDK\n[![Build Status](https://github.com/messagemedia/messages-ruby-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/messagemedia/messages-ruby-sdk/actions/workflows/ci.yml)\n[![gem](https://badge.fury.io/rb/messagemedia_messages_sdk.svg)](https://rubygems.org/gems/messagemedia_messages_sdk)\n\nThe MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.\n\n![Isometric](https://i.imgur.com/jJeHwf5.png)\n\n## Table of Contents\n* [Authentication](#closed_lock_with_key-authentication)\n* [Errors](#interrobang-errors)\n* [Information](#newspaper-information)\n  * [Slack and Mailing List](#slack-and-mailing-list)\n  * [Bug Reports](#bug-reports)\n  * [Contributing](#contributing)\n* [Installation](#star-installation)\n* [Get Started](#clapper-get-started)\n* [API Documentation](#closed_book-api-documentation)\n* [Need help?](#confused-need-help)\n* [License](#page_with_curl-license)\n\n## :closed_lock_with_key: Authentication\n\nAuthentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.\n\nRequests 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](https://github.com/messagemedia/messages-ruby-sdk/blob/master/README.md#send-an-sms) below.\n\n## :interrobang: Errors\n\nOur 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.\n\n#### HTTP Status Codes\n\n| Code      | Title       | Description |\n|-----------|-------------|-------------|\n| 400 | Invalid Request | The request was invalid |\n| 401 | Unauthorized | Your API credentials are invalid |\n| 403 | Disabled feature | Feature not enabled |\n| 404 | Not Found |\tThe resource does not exist |\n| 50X | Internal Server Error | An error occurred with our API |\n\n## :newspaper: Information\n\n#### Slack and Mailing List\n\nIf you have any questions, comments, or concerns, please join our Slack channel:\nhttps://developers.messagemedia.com/collaborate/slack/\n\nAlternatively you can email us at:\ndevelopers@messagemedia.com\n\n#### Bug reports\n\nIf you discover a problem with the SDK, we would like to know about it. You can raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues) or send an email to: developers@messagemedia.com\n\n#### Contributing\n\nWe 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](https://github.com/messagemedia/messages-nodejs-sdk/issues). Please be aware that a large share of the files are auto-generated by our backend tool.\n\n## :star: Installation\n* Run the following command to install the SDK via RubyGems registry:\n```\ngem install messages-ruby-sdk --version \"3.0.0\" --source \"https://rubygems.pkg.github.com/messagemedia\"\n```\n* Run the following command to install the SDK via RubyGems:\n```\ngem install messagemedia_messages_sdk\n```\n\n## :clapper: Get Started\nIt's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.\n\n### Send an SMS\nDestination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/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](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.\n\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\nmessages_controller = client.messages\nbody = SendMessagesRequest.new\nbody.messages = []\n\nbody.messages[0] = Message.new\nbody.messages[0].content = 'My first message'\nbody.messages[0].destination_number = '+61491570156'\n\nbegin\n  result = messages_controller.send_messages(body)\n  pp result\nrescue SendMessages400ResponseException =\u003e ex\n  puts \"Caught SendMessages400ResponseException: #{ex.message}\"\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n## Send an MMS\nDestination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/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](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.\n\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\nmessages_controller = client.messages\nbody = SendMessagesRequest.new\nbody.messages = []\n\nbody.messages[0] = Message.new\nbody.messages[0].content = 'My second message'\nbody.messages[0].destination_number = '+61491570158'\nbody.messages[0].format = FormatEnum::MMS\nbody.messages[0].media = ['https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb\u0026dl=architecture-buildings-city-1018350.jpg']\nbody.messages[0].subject = 'This is an MMS message'\n\nbegin\n  result = messages_controller.send_messages(body)\n  pp result\nrescue SendMessages400ResponseException =\u003e ex\n  puts \"Caught SendMessages400ResponseException: #{ex.message}\"\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n### Get Status of a Message\nYou can get a messsage ID from a sent message by looking at the `message_id` from the response of the above example.\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\nmessages_controller = client.messages\nmessage_id = '877c19ef-fa2e-4cec-827a-e1df9b5509f7'\n\nbegin\n  result = messages_controller.get_message_status(message_id)\n  pp result\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n### Get replies to a message\nYou can check for replies that are sent to your messages\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\nreplies_controller = client.replies\nbegin\n  result = replies_controller.check_replies()\n  pp replies\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n### Check Delivery Reports\nThis endpoint allows you to check for delivery reports to inbound and outbound messages.\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\ndelivery_reports_controller = client.delivery_reports\nbegin\n  result = delivery_reports_controller.check_delivery_reports()\n  pp result\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n### Confirm Delivery Reports\nThis endpoint allows you to mark delivery reports as confirmed so they're no longer returned by the Check Delivery Reports function.\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\ndelivery_reports_controller = client.delivery_reports\nbody = ConfirmDeliveryReportsAsReceivedRequest.new\nbody.delivery_report_ids = ['011dcead-6988-4ad6-a1c7-6b6c68ea628d', '3487b3fa-6586-4979-a233-2d1b095c7718', 'ba28e94b-c83d-4759-98e7-ff9c7edb87a1']\n\nbegin\n  result = delivery_reports_controller.confirm_delivery_reports_as_received(body)\n  pp result\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n###  Check credits remaining (Prepaid accounts only)\nThis endpoint allows you to check for credits remaining on your prepaid account.\n```ruby\nrequire 'message_media_messages'\nrequire 'pp'\n\ninclude MessageMediaMessages\n\nauth_user_name = 'API_KEY'\nauth_password = 'API_SECRET'\nuse_hmac = false\n\nclient = MessageMediaMessages::MessageMediaMessagesClient.new(\n    auth_user_name: auth_user_name,\n    auth_password: auth_password,\n    use_hmac_authentication: use_hmac\n)\n\nmessages_controller = client.messages\nbegin\n  result = messages_controller.check_credits_remaining()\n  pp result\nrescue APIException =\u003e ex\n  puts \"Caught APIException: #{ex.message}\"\nend\n```\n\n## :closed_book: API Reference Documentation\nCheck out the [full API documentation](https://developers.messagemedia.com/code/messages-api-documentation/) for more detailed information.\n\n## :confused: Need help?\nPlease contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)\n\n## :page_with_curl: License\nApache License. See the [LICENSE](LICENSE) file.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmessagemedia%2Fmessages-ruby-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmessagemedia%2Fmessages-ruby-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmessagemedia%2Fmessages-ruby-sdk/lists"}