Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Official Zavu SDK for Ruby. Send SMS, WhatsApp, Email and Voice messages from Rails or any Ruby app with idiomatic helpers, retries and idempotency.
gem install zavudev
# or add to your Gemfile
gem "zavudev"
require "zavudev"
client = Zavudev::Client.new(
api_key: ENV["ZAVUDEV_API_KEY"]
)
result = client.messages.send(
to: "+14155551234",
text: "Hello from Zavu!"
)
puts "Message sent: #{result.message.id}"
require "zavudev"
# Basic initialization
client = Zavudev::Client.new(
api_key: ENV["ZAVUDEV_API_KEY"]
)
# With custom base URL
client = Zavudev::Client.new(
api_key: "zv_live_xxx",
base_url: "https://api.zavu.dev"
)
client = Zavudev::Client.new(
api_key: ENV["ZAVUDEV_API_KEY"]
)
.with_raw_response to access the full HTTP response including headers (useful for rate limiting):
response = client.messages.send.with_raw_response(
to: "+14155551234",
text: "Hello!"
)
remaining = response.headers["X-RateLimit-Remaining"]
puts "Remaining requests: #{remaining}"
result = response.parse
puts "Message ID: #{result.message.id}"
require "zavudev"
client = Zavudev::Client.new(
api_key: ENV["ZAVUDEV_API_KEY"]
)
begin
client.messages.send(to: "invalid-number", text: "Hello")
rescue Zavudev::APIError => e
puts "Status: #{e.status}"
puts "Message: #{e.message}"
rescue Zavudev::ZavudevError => e
puts "Error: #{e.message}"
end
| Error Code | Description |
|---|---|
400 | Invalid request parameters |
401 | Invalid or missing API key |
403 | Insufficient permissions |
404 | Resource not found |
429 | Rate limit exceeded |
client = Zavudev::Client.new(
api_key: "zv_live_xxx",
max_retries: 3
)
result = client.messages.send(
to: "+14155551234",
text: "Hello!"
)
# Create a single client instance
$zavu = Zavudev::Client.new(
api_key: ENV["ZAVUDEV_API_KEY"]
)
# Safe to use from multiple threads
threads = 10.times.map do |i|
Thread.new do
$zavu.messages.send(
to: "+14155551234",
text: "Message #{i}"
)
end
end
threads.each(&:join)
# config/initializers/zavu.rb
require "zavudev"
ZAVU_CLIENT = Zavudev::Client.new(
api_key: Rails.application.credentials.dig(:zavu, :api_key)
)
# app/services/notification_service.rb
class NotificationService
def send_sms(phone_number, message)
ZAVU_CLIENT.messages.send(
to: phone_number,
text: message
)
end
end