Direct7 Ruby SDK
This Ruby SDK provides a convenient and easy-to-use interface to the Direct7 REST API. The SDK allows you to perform all the operations that are available through the REST API.
Installation
The SDK is available on RubyGems and can be installed using two methods: Add this line to your application's Gemfile:
gem 'direct7', '~> 0.0.14'
And then execute:
bundle install
Or install it yourself as:
gem install direct7
Usage
The SDK is designed to be easy to use. The library needs to be configured with your account's secret key, which is available in your Direct7 Dashboard. To get started, create a client instance by providing the key. If you haven't already, you can Login here to access your dashboard.
Send SMS
require 'direct7'
client = Direct7::Client.new('Your API token')
client.sms.(
originator='SignOTP',
report_url='https://the_url_to_recieve_delivery_report.com',
schedule_time=nil,
{ recipients: ['+919999XXXXXX'], content: 'Greetings from D7 API', unicode: false }
)
Send SMS (Unicode)
require 'direct7'
client = Direct7::Client.new('Your API token')
client.sms.(
originator='SignOTP',
report_url='https://the_url_to_recieve_delivery_report.com',
schedule_time=nil,
{ recipients: ['+919999XXXXXX'], content: "مرحبا بالعالم!", unicode: true }
)
Get Request Status
require 'direct7'
client = Direct7::Client.new('Your API token')
# request_id is the id returned in the response of send_message
client.sms.get_status(request_id= '001a1a4e-0221-4cb7-a524-a2a5b337cbe8')
Send OTP
require 'direct7'
client = Direct7::Client.new('Your API token')
client.verify.send_otp(originator="SignOTP", recipient="+97150900XXXX", content = "Greetings from D7 API, your mobile verification code is: {}", expiry = 600, data_coding = "text")
Re-Send OTP
require 'direct7'
client = Direct7::Client.new('Your API token')
client.verify.resend_otp(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Verify OTP
require 'direct7'
client = Direct7::Client.new('Your API token')
client.verify.verify_otp(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1", otp_code="1425")
Get Request Status
require 'direct7'
client = Direct7::Client.new('Your API token')
# otp_id is the id returned in the response of send_otp
client.verify.get_status(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Send Viber Message
require 'direct7'
client = Direct7::Client.new('Your API token')
client.viber.(recipients=["+97150900XXXX","+97845900XXX"], content="Greetings from D7 API", label="PROMOTION", originator="INFO2WAY", call_back_url="https://the_url_to_recieve_delivery_report.com")
Get Request Status
require 'direct7'
client = Direct7::Client.new('Your API token')
# request_id is the id returned in the response of send_viber_message
client.viber.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Send Slack Message
require 'direct7'
client = Direct7::Client.new('Your API token')
client.slack.(content="Greetings from D7 API", work_space_name="WorkspaceName", channel_name="ChannelName", report_url="https://the_url_to_recieve_delivery_report.com")
Get Request Status
require 'direct7'
client = Direct7::Client.new('Your API token')
# request_id is the id returned in the response of send_slack_message
client.slack.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Search Your Number details
require 'direct7'
client = Direct7::Client.new('Your API token')
client.number_lookup.search_number_details(recipient="+914257845XXXX")
Send Whatsapp Free-form Message (Contact Details)
require 'direct7'
client = Direct7::Client.new('Your API token')
client.whatsapp.(originator="91906152XXXX", recipient="91906152XXXX", ="CONTACTS", first_name="Amal", last_name="Anu", formatted_name="Amal Anu", phones=["91906152XXXX", "91906152XXXX"], emails = ["[email protected]", "[email protected]"])
Send Whatsapp Templated Message.
require 'direct7'
client = Direct7::Client.new('Your API token')
client.whatsapp.(originator="91906152XXXX", recipient="91906152XXXX", ="TEMPLATE", template_id="monthly_promotion", body_parameter_values={"0": "promotion"})
Get Request Status
require 'direct7'
client = Direct7::Client.new('Your API token')
# request_id is the id returned in the response of send_message
client.whatsapp.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
FAQ
How do I get my API token?
You can get your API token from the Direct7 dashboard. If you don't have an account yet, you can create one for free.
Supported ruby versions
The SDK supports ruby 3.0 and higher.
Supported APIs
As of now, the SDK supports the following APIs:
| API | Supported? |
|---|---|
| SMS API | ✅ |
| Verify API | ✅ |
| Whatsapp API | ✅ |
| Number Lookup API | ✅ |
| Viber API | ✅ |
| Slack API | ✅ |
How do I get started?
You can find the platform documentation @ Direct7 Docs.
How do I get help?
If you need help using the SDK, you can create an issue on GitHub or email to [email protected]
Contributing
We welcome contributions to the Direct7 ruby SDK. If you have any ideas for improvements or bug fixes, please feel free to create an issue on GitHub.