https://github.com/davidesantangelo/apiwha
A tiny ruby wrapper around apiwha whatsapp API (https://apiwha.com)
https://github.com/davidesantangelo/apiwha
gem ruby whatsapp-api
Last synced: about 1 year ago
JSON representation
A tiny ruby wrapper around apiwha whatsapp API (https://apiwha.com)
- Host: GitHub
- URL: https://github.com/davidesantangelo/apiwha
- Owner: davidesantangelo
- License: mit
- Created: 2019-03-12T09:27:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-28T04:25:02.000Z (almost 6 years ago)
- Last Synced: 2025-04-21T03:44:35.397Z (about 1 year ago)
- Topics: gem, ruby, whatsapp-api
- Language: Ruby
- Homepage:
- Size: 27.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apiwha
A tiny ruby wrapper around ApiWha API. If you want know more visit http://www.apiwha.com website.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'apiwha'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install apiwha
## Usage
```ruby
require 'apiwha'
apiwha = Apiwha.new('Your secret API key')
```
Your secret API key. You can generate it in your dashboard from https://panel.apiwha.com/
## Pull Messages
Allows you to pull the messages you received and sent.
### Options
```ruby
options = {
number: nil,
type: nil,
markaspulled: "0",
getnotpulledonly: "0",
limit: 100,
orderdesc: "1"
}
```
number: (Optional). Get IN or OUT messsages to or from this number.
type: (Optional). Type of message to retrieve. Possible values: IN or OUT.
markaspulled: (Optional). If you set this value in 1 you will mark your results as pulled.
getnotpulledonly: (Optional). If you set this value in 1 you will retrieve only results that you don't have marked as pulled.
limit: (Default 100).
orderdesc: (Default most recent). If you set this value in 0 you will retrieve result from oldest to newest.
```ruby
messages = apiwha.pull_messages(params: options)
```
``` ruby
messages = apiwha.pull_messages(params: { limit: 2 })
```
```
[
{
"id":"14409287",
"number":"391112223456",
"from":"391112223456",
"to":"39886677822",
"type":"IN",
"text":"test hello message",
"creation_date":"2019-03-11 14:29:51",
"process_date":"2019-03-11 14:29:51",
"failed_date":null,
"custom_data":null
},
{
"id":"14409219",
"number":"393938491113",
"from":"393891986619",
"to":"393938491113",
"type":"IN",
"text":"test message",
"creation_date":"2019-03-11 14:28:53",
"process_date":"2019-03-11 14:28:53",
"failed_date":null,
"custom_data":null
}
]
```
## Send Message
Allows you to send messages to any destination that wrote to you.
number: Destination number. Enter the number with country code. You can check the number formatting in https://faq.whatsapp.com/en/general/21016748
text: Text of message to send or URL of media to send.
If this text is an URL that begins with "http" and finishes with ".png" or ".jpg" the system will send a picture.
If this text is an URL that begins with "http" and finishes with ".ogg" the system will send an audio.
If this text is an URL that begins with "http" and finishes with ".pdf" the system will send the pdf document.
custom_data: You can add your custom data in each message that you send. Then, you will receive this custom data by webhook events.
```ruby
apiwha.send_message(options)
```
## Get Credit
Allows you to query about your credit
```ruby
credit = apiwha.get_credit
```
```
{
"credit":45
}
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apiwha. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Apiwha project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apiwha/blob/master/CODE_OF_CONDUCT.md).