Module: EventMachine::Smsified::ReportingModule

Included in:
OneAPI, Reporting
Defined in:
lib/em-smsified/reporting.rb

Instance Method Summary collapse

Instance Method Details

#delivery_status(options, &blk) ⇒ Object

Get the delivery status of an outstanding SMS request

Examples:

one_api.delivery_status :request_id => 'f359193765f6a3149ca76a4508e21234', :sender_address => '14155551212'

Parameters:

  • params (required, Hash) —

    to get the delivery status

Returns:

  • (Object) —

    A Response Object with http and data instance methods

Raises:

  • (ArgumentError) —

    of :sender_address is not passed here when not passed on instantiating the object



14
15
16
17
18
19
20
21
 
# File 'lib/em-smsified/reporting.rb', line 14

def delivery_status(options, &blk)
  raise ArgumentError, 'an options Hash is required' if !options.instance_of?(Hash)
  raise ArgumentError, ':sender_address is required' if options[:sender_address].nil? && @sender_address.nil?
  
  options[:sender_address] = options[:sender_address] || @sender_address

  get("/smsmessaging/outbound/#{options[:sender_address]}/requests/#{options[:request_id]}/deliveryInfos", SMSIFIED_HTTP_HEADERS, &blk)
end

#retrieve_sms(message_id, &blk) ⇒ Object

Retrieve a single SMS

Examples:

reporting.retrieve_sms '74ae6147f915eabf87b35b9ea30c5916'

Parameters:

  • message_id (required, String) —

    of the message to retrieve

Returns:

  • (Object) —

    A Response Object with http and data instance methods



30
31
32
 
# File 'lib/em-smsified/reporting.rb', line 30

def retrieve_sms(message_id, &blk)
  get("/messages/#{message_id}", SMSIFIED_HTTP_HEADERS, &blk)
end

#search_sms(query_string, &blk) ⇒ Object

Retrieve multiple SMS messages based on a query string

Examples:

reporting.search_sms 'start=2011-02-14&end=2011-02-15'

Parameters:

  • query_string (required, String) —

    to search SMS messages for

Returns:

  • (Object) —

    A Response Object with http and data instance methods



41
42
43
 
# File 'lib/em-smsified/reporting.rb', line 41

def search_sms(query_string, &blk)
  get("/messages?#{query_string}", SMSIFIED_HTTP_HEADERS, &blk)
end