Messente API Library
- Messente API version: 1.0.1
- Ruby gem version: 1.0.1
Messente is a global provider of messaging and user verification services. Use Messente API library to send and receive SMS, Viber and WhatsApp messages, blacklist phone numbers to make sure you're not sending any unwanted messages, manage contacts and groups. Messente builds tools to help organizations connect their services to people anywhere in the world.
Installation
Install Messente API library with gem install messente_api
.
Features
Messente API has the following features:
- Omnichannel (external docs),
- Phonebook (external docs).
Messente API Library provides the operations described below to access the features.
BlacklistApi
- Adds a phone number to the blacklist.
add_to_blacklist
- Deletes a phone number from the blacklist.
delete_from_blacklist
- Returns all blacklisted phone numbers.
fetch_blacklist
- Checks if a phone number is blacklisted.
is_blacklisted
ContactsApi
- Adds a contact to a group.
add_contact_to_group
- Creates a new contact.
create_contact
- Deletes a contact.
delete_contact
- Lists a contact.
fetch_contact
- Lists groups of a contact.
fetch_contact_groups
- Returns all contacts.
fetch_contacts
- Removes a contact from a group.
remove_contact_from_group
- Updates a contact.
update_contact
DeliveryReportApi
- Retrieves the delivery report for the Omnimessage.
retrieve_delivery_report
GroupsApi
- Creates a new group with the provided name.
create_group
- Deletes a group.
delete_group
- Lists a group.
fetch_group
- Returns all groups.
fetch_groups
- Updates a group with the provided name.
update_group
OmnimessageApi
- Cancels a scheduled Omnimessage.
cancel_scheduled_message
- Sends an Omnimessage.
send_omnimessage
Auth
Type: HTTP basic authentication
Read the external getting-started article which explains API keys and Sender ID logic.
Getting started: sending an omnimessage
```ruby require ‘messente_api’
setup authorization
MessenteApi.configure do |config|
# Configure HTTP basic authorization: basicAuth
config.username = ‘
api_instance = MessenteApi::OmnimessageApi.new
omnimessage = MessenteApi::Omnimessage.new
omnimessage.to = ‘
begin result = api_instance.send_omnimessage(omnimessage) rescue MessenteApi::ApiError => e puts “Exception when calling send_omnimessage: #e” puts e.response_body end
```