marchex 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c89ee89614fab1b6a985eb37b971f989954f7b9
-  data.tar.gz: 27589ec7b0eab51744ee03a5a3c28f77c449500c
+  metadata.gz: 0dd04c01da60af405506c24cc747523fdb9a8808
+  data.tar.gz: 4fedaf92eb9ffa1a8db6fd9e063587d191e60030
 SHA512:
-  metadata.gz: de612b0b18a0d8c1049ce6c5c2eedcc69cb225851cfc1eb47ebb72b4d8bc518ce4926790999fa5ac9d5a62d8a72a4f73f87b6c0ef03f03222997e40633b67655
-  data.tar.gz: c83e15c394dea30e47bb84d4ebea7102639feafb88809d224a5a3ba4dedc4cb123c24cbdc9cd110f0be392a0c0c861f342b507431fa3f2245e2db13696ef90e9
+  metadata.gz: 6ce053b434135452bbf8a474e9ae5d0d23ca53a3b1b8b85388892181cd6efa5ec86408c687907e3277d0b5d182cbffa76703db5619e30e4c845f74dc7cd6190c
+  data.tar.gz: 54f5ac131288ea78fbca2b9251f027cf1bb99043ef722948fd7f3fa8c08b58a56cf5ec50c837d85bcf243dbe2876c81034c4c8936912b99d49cd64209e323685

data/README.md

@@ -44,9 +44,61 @@ Create a connection using your Marchex account email address and password:
 # @testcon.ad_custom_define(acc_id,field_number, field_name, field_type, field_values)
     Define a custom field for an ad 
 
-# @ad_custom_set(acc_id, campaign_id, field_name, field_value)   
+# @testcon.ad_custom_set(acc_id, campaign_id, field_name, field_value)   
     Set the value of a custom field. For boolean, use yes/no
 
+# @testcon.call_search(search_options)
+        search_options = {}
+        search_options[:acct_id] Required string. The unique, system-generated account ID of the specified account.
+
+        search_options[:start] Optional (but recommended) strings. The start and end date/time of the search.
+        search_options[:end] 
+
+        search_options[:assto] Optional string. The unique, system-generated user ID of the user assigned to the call.
+
+        search_options[:call_boundary] Optional string. Indicates whether to use the start date and time or the end date and time of the call to determine if
+        the call is within the dates and times specified in the start and end parameters.
+
+        search_options[:callerid] Optional string. The caller ID.
+
+        search_options[:cmpid] Optional string. The unique, system-generated campaign ID.
+
+        search_options[:dispo] Optional string. A tag added to call(s) in the call log
+
+        search_options[:dna_class] Optional string. The Call DNA classification of the call. (Conversation, Voicemail, Wrong Number, Hold-Time Abandon, IVR/Voicemail Abandon, Ring Transfer Abandon, Unknown)
+        
+        search_options[:exact_times] Optional boolean. Indicates that the start and end parameters contain a datetime value.
+        
+        search_options[:extended] Optional string. If not included or false, the response includes only basic information about each call
+
+        search_options[:grpid] Optional string, which can contain up to 16 characters. The unique, system-generated group ID of the ad group
+        for the call.
+
+        search_options[:include_dna] Optional boolean. If not included or false, Call DNA information is not returned in the results
+
+        search_options[:include_spotted_keywords] Optional boolean. If not included or false, the "spotted" keywords are not returned in the results.
+
+        search_options[:keyword] Optional string. The keyword or the Custom URL Parameter (if specified in the dynamic tracking rewrite) asso-
+        ciated with the call.
+
+        search_options[:min_duration_secs] Optional integer. The minimum number of seconds of the call duration
+
+        search_options[:status] Optional string. The status of the call. ANswer, BUSY, CANCEL or HANGUP, CONGESTION, NOANSWER, NOFORWARDS, VOICEMAIL, WINDDOWN
+
+        search_options[:spotted_keywords] Optional object. If specified, only calls containing one or more of the specified call transcription keywords are
+        returned. The spotted_keywords parameter is independent of include_spotted_keywords. agent - Filter the calls based on keywords spoken by the agent. caller - Filter the calls based on keywords spoken by the caller.
+            Example:    spotted_keywords =  {}
+                        spotted_keywords[:agent] = ['keyword1', 'keyword2', 'keyword3'] 
+                        spotted_keywords[:caller] = ['keyword1', 'keyword2', 'keyword']
+
+        search_options[:subacct] Optional boolean. true to search all calls in all client accounts of the specified parent account.
+
+# @testcon.get_call(call_id)
+    Return details for a single call
+
+# @testcon.get_call_audio(call_id, audio_format)
+    Gets a Base64-encoded string that contains the audio data of the specified call, in the specified format. (mp3 or wav)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -55,7 +107,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/marchex.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mhoskiso/marchex.
 
 
 ## License

data/lib/marchex.rb

@@ -10,7 +10,8 @@ require 'rest-client'
 
 module Marchex
   class Marchexapi
-  
+
+      #RestClient.log = 'stdout' #Debugging API calls
 
       def initialize(u, p)
         @url = 'https://userapi.voicestar.com/api/jsonrpc/1'
@@ -62,9 +63,40 @@ module Marchex
         return response.body["result"]
       end 
 
-  end
-end
-
+      def call_search ( opts = {})
+        search_options = {}
+        search_options[:start] = opts[:start] if opts[:start] 
+        search_options[:end] = opts[:end] if opts[:end]
+        search_options[:assto] = opts[:assto] if opts[:assto]
+        search_options[:call_boundary] = opts[:call_boundary] if opts[:call_boundary]
+        search_options[:callerid] = opts[:callerid] if opts[:callerid]
+        search_options[:cmpid] = opts[:cmpid] if opts[:cmpid]
+        search_options[:dispo] = opts[:dispo] if opts[:dispo]
+        search_options[:dna_class] = opts[:dna_class] if opts[:dna_class]
+        search_options[:exact_times] = opts[:exact_times] if opts[:exact_times]
+        search_options[:extended] = opts[:extended] if opts[:extended]
+        search_options[:exact_times] = true if opts[:extended] == true
+        search_options[:grpid] = opts[:grpid] if opts[:grpid]
+        search_options[:include_dna] = opts[:include_dna] if opts[:include_dna]
+        search_options[:include_spotted_keywords] = opts[:include_spotted_keywords] if opts[:include_spotted_keywords]
+        search_options[:keyword] = opts[:keyword] if opts[:keyword]
+        search_options[:min_duration_secs] = opts[:min_duration_secs] if opts[:min_duration_secs]
+        search_options[:status] = opts[:status] if opts[:status]
+        search_options[:spotted_keywords] = opts[:spotted_keywords] if opts[:spotted_keywords]
+        search_options[:subacct] = opts[:subacct] if opts[:subacct]
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.search', 'params' => [opts[:acct_id], search_options ]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        return response.body["result"]
+      end
 
+      def get_call (call_id)      
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.get', 'params' => [call_id]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        return response.body["result"]
+      end
 
+      def get_call_audio(call_id, audio_format)
+        response = parse_json(RestClient.post(@url, {'jsonrpc' => '2.0', 'id' => '1', 'method' => 'call.audio', 'params' => [call_id, audio_format]}.to_json, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth))
+        return response.body["result"]
+      end
 
+  end
+end

data/lib/marchex/version.rb

@@ -1,3 +1,3 @@
 module Marchex
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marchex
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Michael Hoskison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler