whatsapp: A Ruby repository from roynasser

A ruby interface to WhatsApp Enterprise API.

Installation

Add this line to your application's Gemfile:

gem "whatsapp"

Usage

Instantiation

Create an instance of the API client passing the base path of your endpoint:

whats = Whats::Api.new("https://my-whatsapp-endpoint.com")

Check Contacts

Take a look here (WhatsApp Check Contacts doc) for more information.

whats.check_contacts(["+5511942424242"])

# output:
{
  "results" => [
    {
      "input" => "+5511942424242",
      "status" => "valid",
      "wa_id" => "5511942424242"
    }
  ]
}

Send Message

Take a look here (WhatsApp Send Message doc) for more information.

The first parameter is the WhatsApp username!

whats.send_message("5511942424242", "Message goes here.")

# output:
{
  "messages" => [{
    "id" => "BAEC4D1D7549842627"
  }]
}

Tests

Running tests

rspec

Debugging specs

You can print all stubs using the environment variable PRINT_STUBS=true like this:

PRINT_STUBS=true rspec

Which results in:

Whats::Actions::SendMessage
  #call
    with valid params
+ ------ STUB ------
+ Request:  POST http://test.local/api/rest_send.php with body "{\"payload\":{\"to\":\"5511944442222\",\"body\":\"Message!\"}}" with headers {'Content-Type'=>'application/json'}
+ Response: {"payload":{"message_id":"ID"},"error":false}
+ ------------------
      returns message_in in the payload
    with unknown contact
+ ------ STUB ------
+ Request:  POST http://test.local/api/rest_send.php with body "{\"payload\":{\"to\":\"123\",\"body\":\"Message!\"}}" with headers {'Content-Type'=>'application/json'}
+ Response: {"payload":null,"error":{"errorcode":404,"errortext":"unknown contact"}}
+ ------------------
      returns error unknown contact

Finished in 0.0077 seconds (files took 0.59843 seconds to load)
2 examples, 0 failures

roynasser/whatsapp

WhatsApp