{"id":22169159,"url":"https://github.com/messente/messente-api-ruby","last_synced_at":"2025-07-26T12:32:31.816Z","repository":{"id":56883360,"uuid":"173302919","full_name":"messente/messente-api-ruby","owner":"messente","description":"Messente API library: https://rubygems.org/gems/messente_api","archived":false,"fork":false,"pushed_at":"2024-10-05T08:14:42.000Z","size":296,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-20T01:04:39.136Z","etag":null,"topics":["number-lookup","omnichannel","phonebook","statistics"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/messente.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-01T13:03:21.000Z","updated_at":"2024-09-16T12:41:57.000Z","dependencies_parsed_at":"2024-06-28T18:46:42.012Z","dependency_job_id":"621a7a9f-0867-4869-8965-5a94f8386e84","html_url":"https://github.com/messente/messente-api-ruby","commit_stats":{"total_commits":12,"total_committers":1,"mean_commits":12.0,"dds":0.0,"last_synced_commit":"36193929fd313e26d876edf7b8ab0b62a5b97a67"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messente%2Fmessente-api-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messente%2Fmessente-api-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messente%2Fmessente-api-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/messente%2Fmessente-api-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/messente","download_url":"https://codeload.github.com/messente/messente-api-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227683834,"owners_count":17803928,"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","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":["number-lookup","omnichannel","phonebook","statistics"],"created_at":"2024-12-02T06:28:59.956Z","updated_at":"2025-07-26T12:32:31.779Z","avatar_url":"https://github.com/messente.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Messente API Library\n\n- Messente API version: 2.0.0\n- Ruby gem version: 2.4.0\n\n[Messente](https://messente.com) is a global provider of messaging and user verification services.  * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you\u0026#39;re not sending any unwanted messages.  Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.\n\n## Installation\n\nInstall Messente API library with `gem install messente_api`.\n\n## Features\n\nMessente API has the following features:\n\n- Omnichannel ([external docs](https://messente.com/documentation/omnichannel-api)),\n- Phonebook ([external docs](https://messente.com/documentation/phonebook-api)).\n\nMessente API Library provides the operations described below to access the features.\n\n### AccountBalanceApi\n\n1. Get account balance [`get_account_balance`](docs/AccountBalanceApi.md#get_account_balance)\n1. Get account balance [`get_account_balance_using_post`](docs/AccountBalanceApi.md#get_account_balance_using_post)\n\n### BlacklistApi\n\n1. Adds a phone number to the blacklist [`add_to_blacklist`](docs/BlacklistApi.md#add_to_blacklist)\n1. Deletes a phone number from the blacklist [`delete_from_blacklist`](docs/BlacklistApi.md#delete_from_blacklist)\n1. Returns all blacklisted phone numbers [`fetch_blacklist`](docs/BlacklistApi.md#fetch_blacklist)\n1. Checks if a phone number is blacklisted [`is_blacklisted`](docs/BlacklistApi.md#is_blacklisted)\n\n### BulkMessagingApi\n\n1. Sends a bulk Omnimessage [`send_bulk_omnimessage`](docs/BulkMessagingApi.md#send_bulk_omnimessage)\n\n### ContactsApi\n\n1. Adds a contact to a group [`add_contact_to_group`](docs/ContactsApi.md#add_contact_to_group)\n1. Creates a new contact [`create_contact`](docs/ContactsApi.md#create_contact)\n1. Deletes a contact [`delete_contact`](docs/ContactsApi.md#delete_contact)\n1. Lists a contact [`fetch_contact`](docs/ContactsApi.md#fetch_contact)\n1. Lists groups of a contact [`fetch_contact_groups`](docs/ContactsApi.md#fetch_contact_groups)\n1. Returns all contacts [`fetch_contacts`](docs/ContactsApi.md#fetch_contacts)\n1. Removes a contact from a group [`remove_contact_from_group`](docs/ContactsApi.md#remove_contact_from_group)\n1. Updates a contact [`update_contact`](docs/ContactsApi.md#update_contact)\n\n### DeliveryReportApi\n\n1. Retrieves the delivery report for the Omnimessage [`retrieve_delivery_report`](docs/DeliveryReportApi.md#retrieve_delivery_report)\n\n### GroupsApi\n\n1. Creates a new group with the provided name [`create_group`](docs/GroupsApi.md#create_group)\n1. Deletes a group [`delete_group`](docs/GroupsApi.md#delete_group)\n1. Lists a group [`fetch_group`](docs/GroupsApi.md#fetch_group)\n1. Returns all groups [`fetch_groups`](docs/GroupsApi.md#fetch_groups)\n1. Updates a group with the provided name [`update_group`](docs/GroupsApi.md#update_group)\n\n### NumberLookupApi\n\n1. Requests info about phone numbers [`fetch_info`](docs/NumberLookupApi.md#fetch_info)\n\n### NumberVerificationApi\n\n1. verify number [`verify_number`](docs/NumberVerificationApi.md#verify_number)\n1. verified the PIN code entered by the user. [`verify_pin`](docs/NumberVerificationApi.md#verify_pin)\n\n### OmnimessageApi\n\n1. Cancels a scheduled Omnimessage [`cancel_scheduled_message`](docs/OmnimessageApi.md#cancel_scheduled_message)\n1. Sends an Omnimessage [`send_omnimessage`](docs/OmnimessageApi.md#send_omnimessage)\n\n### PricingApi\n\n1. Get pricelist for account [`get_pricelist`](docs/PricingApi.md#get_pricelist)\n1. Get pricing for a specific country [`get_prices`](docs/PricingApi.md#get_prices)\n\n### StatisticsApi\n\n1. Requests statistics reports for each country [`create_statistics_report`](docs/StatisticsApi.md#create_statistics_report)\n\n### WhatsAppTemplatesApi\n\n1. Creates a WhatsApp template [`create_whatsapp_template`](docs/WhatsAppTemplatesApi.md#create_whatsapp_template)\n1. Deletes a WhatsApp template [`delete_whatsapp_template`](docs/WhatsAppTemplatesApi.md#delete_whatsapp_template)\n1. Requests a WhatsApp template with the given ID [`get_whatsapp_template_by_id`](docs/WhatsAppTemplatesApi.md#get_whatsapp_template_by_id)\n1. Requests a list of WhatsApp templates [`list_whatsapp_templates`](docs/WhatsAppTemplatesApi.md#list_whatsapp_templates)\n1. Updates a WhatsApp template [`update_whatsapp_template`](docs/WhatsAppTemplatesApi.md#update_whatsapp_template)\n\n## Auth\n\n**Type**: HTTP basic authentication\n\nRead the [external getting-started article](https://messente.com/documentation/getting-started) which explains API keys and Sender ID logic.\n\n## Getting started: sending an omnimessage\n\n```ruby\nrequire 'messente_api'\n\n# setup authorization\nMessenteApi.configure do |config|\n    # Configure HTTP basic authorization: basicAuth\n    config.username = '\u003cMESSENTE_API_USERNAME\u003e'\n    config.password = '\u003cMESSENTE_API_PASSWORD\u003e'\nend\n\napi_instance = MessenteApi::OmnimessageApi.new\nomnimessage = MessenteApi::Omnimessage.new\nomnimessage.to = '\u003crecipient_phone_number\u003e'\n\nsms = MessenteApi::SMS.new(\n    sender: \"\u003csender name (optional)\u003e\",\n    text: \"Hello SMS!\"\n)\n\nviber = MessenteApi::Viber.new(\n    sender: \"\u003csender name (optional)\u003e\",\n    text: \"Hello from Viber!\"\n)\n\nwa_parameters = [\n  MessenteApi::WhatsAppParameter.new(type: 'text', text: 'hello whatsapp'),\n]\nwa_component = MessenteApi::WhatsAppComponent.new(type: 'body', parameters: wa_parameters)\nwa_lang = MessenteApi::WhatsAppLanguage.new(code: '\u003clanguage_code\u003e')\nwa_template = MessenteApi::WhatsAppTemplate.new(name: '\u003ctemplate_name\u003e', language: wa_lang, components: [wa_component])\nwhatsapp = MessenteApi::WhatsApp.new(\n    sender: '\u003csender name (optional)\u003e',\n    template: wa_template,\n)\n\nomnimessage.messages = [sms, viber, whatsapp]\n\nbegin\n  result = api_instance.send_omnimessage(omnimessage)\n  puts result\nrescue MessenteApi::ApiError =\u003e e\n  puts \"Exception when calling send_omnimessage: #{e}\"\n  puts e.response_body\nend\n\n```\n\n## License\n\n[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)\n\n## Terms\n\n[https://messente.com/terms-and-conditions](https://messente.com/terms-and-conditions)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmessente%2Fmessente-api-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmessente%2Fmessente-api-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmessente%2Fmessente-api-ruby/lists"}