Project

direct7

0.0
The project is in a healthy, maintained state
direct7d7networks/direct7-ruby-sdkHomepageDocumentationSource CodeBug TrackerWiki
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.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,269
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.0.18
Total releases
12
First release
2023-11-02
Latest release
2024-11-13
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-02-05
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rspec
>= 0

Runtime

http
>= 0
json
>= 0
net-http-persistent
~> 4.0
rake
~> 13.1.0
 Project Readme

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.18'

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.send_message(
        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.send_message(
        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.send_viber_message(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.send_slack_message(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 (Location Details)

require 'direct7'

client = Direct7::Client.new('Your API token')

client.whatsapp.send_whatsapp_freeform_message(
    originator='{originator}',
    recipient='{recipient}',
    message_type='LOCATION',
    body=nil, first_name=nil, last_name=nil, formatted_name=nil, middle_name=nil, suffix=nil, prefix=nil, birthday=nil, phones=nil, emails=nil, urls=nil, 
    latitude='12.93803129081362', 
    longitude='77.61088653615994', 
    name='Mobile Pvt Ltd', 
    address='Bengaluru, Karnataka 56009'
)

Send Whatsapp Templated Message.

require 'direct7'

client = Direct7::Client.new('Your API token')

client.whatsapp.send_whatsapp_templated_message(
    originator='{originator}', 
    recipient='{recipient}',
    template_id="{template_id}", 
    language="en",
    body_parameter_values=nil,
    media_type="image",
    text_header_title=nil,
    media_url='https://miro.medium.com/max/780/1*9Wdo1PuiJTZo0Du2A9JLQQ.jpeg'
)

Send Whatsapp Interactive Message: CTA.

require 'direct7'

client = Direct7::Client.new('Your API token')
parameters = {
          "display_text": "Visit Us",
          "url": "https://www.luckyshrub.com?clickID=kqDGWd24Q5TRwoEQTICY7W1JKoXvaZOXWAS7h1P76s0R7Paec4"
        }
client.whatsapp.send_whatsapp_templated_message(
    originator='{originator}', 
    recipient='{recipient}',
    interactive_type= "cta_url",
    header_type= "text",
    header_text= "Payment$ for D7 Whatsapp Service",
    header_link=nil, header_file_name=nil,
    body_text= "Direct7 Networks is a messaging service provider that specializes in helping organizations efficiently communicate with their customers.",
    footer_text= "Thank You",
    parameters= parameters
)

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")

Read Receipt

require 'direct7'

client = Direct7::Client.new('Your API token')

# message_id is the id shown in the api reports
client.whatsapp.read_receipt(message_id="9612c7f5-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 support@d7networks.com

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.