dialmycalls_client

dialmycalls_client

DialMyCalls - the Ruby gem for the DialMyCalls API

The DialMyCalls API

For more information, please visit https://www.dialmycalls.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build dialmycalls_client.gemspec

Then either install the gem locally:

gem install ./dialmycalls_client-2.0.1.gem

(for development, run gem install --dev ./dialmycalls_client-2.0.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'dialmycalls_client', '~> 2.0.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/dialmycalls/ruby-sdk-v2, then add the following in the Gemfile:

gem 'dialmycalls_client', :git => 'https://github.com/dialmycalls/ruby-sdk-v2.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'dialmycalls_client'

# Setup authorization
DialMyCalls.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['X-Auth-ApiKey'] = 'YOUR API KEY'
end

api_instance = DialMyCalls::AccountsApi.new

create_access_account_parameters = DialMyCalls::CreateAccessAccountParameters.new # CreateAccessAccountParameters | Request body


begin
  #Add Access Account
  result = api_instance.create_access_account(create_access_account_parameters)
  p result
rescue DialMyCalls::ApiError => e
  puts "Exception when calling AccountsApi->create_access_account: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.dialmycalls.com/2.0

Class	Method	HTTP request	Description
DialMyCalls::AccountsApi	create_access_account	POST /accessaccount	Add Access Account
DialMyCalls::AccountsApi	delete_access_account_by_id	DELETE /accessaccount/{AccessAccountId}	Delete Access Account
DialMyCalls::AccountsApi	get_access_account_by_id	GET /accessaccount/{AccessAccountId}	Get Access Account
DialMyCalls::AccountsApi	get_access_accounts	GET /accessaccounts	List Access Accounts
DialMyCalls::AccountsApi	get_account	GET /account	Get Account
DialMyCalls::AccountsApi	update_access_account_by_id	PUT /accessaccount/{AccessAccountId}	Update Access Account
DialMyCalls::CallerIdsApi	create_caller_id	POST /callerid	Add Caller ID
DialMyCalls::CallerIdsApi	create_unverified_caller_id	POST /verify/callerid	Add Caller ID (Unverified)
DialMyCalls::CallerIdsApi	delete_caller_id_by_id	DELETE /callerid/{CalleridId}	Delete Caller ID
DialMyCalls::CallerIdsApi	get_caller_id_by_id	GET /callerid/{CalleridId}	Get Caller ID
DialMyCalls::CallerIdsApi	get_caller_ids	GET /callerids	List Caller IDs
DialMyCalls::CallerIdsApi	update_caller_id_by_id	PUT /callerid/{CalleridId}	Update Caller ID
DialMyCalls::CallerIdsApi	verify_caller_id_by_id	PUT /verify/callerid/{CalleridId}	Verify Caller ID
DialMyCalls::CallsApi	cancel_call_by_id	DELETE /service/call/{CallId}	Cancel Call
DialMyCalls::CallsApi	create_call	POST /service/call	Create Call
DialMyCalls::CallsApi	get_call_by_id	GET /service/call/{CallId}	Get Call
DialMyCalls::CallsApi	get_call_recipients_by_call_id	GET /service/call/{CallId}/recipients	Get Call Recipients
DialMyCalls::CallsApi	get_calls	GET /service/calls	List Calls
DialMyCalls::ContactsApi	create_contact	POST /contact	Add Contact
DialMyCalls::ContactsApi	delete_contact_by_id	DELETE /contact/{ContactId}	Delete Contact
DialMyCalls::ContactsApi	get_contact_by_id	GET /contact/{ContactId}	Get Contact
DialMyCalls::ContactsApi	get_contacts	GET /contacts	List Contacts
DialMyCalls::ContactsApi	get_contacts_by_group_id	GET /contacts/{GroupId}	List Contacts in Group
DialMyCalls::ContactsApi	update_contact_by_id	PUT /contact/{ContactId}	Update Contact
DialMyCalls::DoNotContactsApi	get_do_not_contacts	GET /donotcontacts	List DoNotContacts
DialMyCalls::GroupsApi	create_group	POST /group	Add Group
DialMyCalls::GroupsApi	delete_group_by_id	DELETE /group/{GroupId}	Delete Group
DialMyCalls::GroupsApi	get_group_by_id	GET /group/{GroupId}	Get Group
DialMyCalls::GroupsApi	get_groups	GET /groups	List Groups
DialMyCalls::GroupsApi	update_group_by_id	PUT /group/{GroupId}	Update Group
DialMyCalls::KeywordsApi	delete_keyword_by_id	DELETE /keyword/{KeywordId}	Delete Keyword
DialMyCalls::KeywordsApi	get_keyword_by_id	GET /keyword/{KeywordId}	Get Keyword
DialMyCalls::KeywordsApi	get_keywords	GET /keywords	List Keywords
DialMyCalls::RecordingsApi	create_recording	POST /recording/tts	Create Recording (Text-to-Speech)
DialMyCalls::RecordingsApi	create_recording_by_phone	POST /recording/phone	Create Recording (Phone)
DialMyCalls::RecordingsApi	create_recording_by_url	POST /recording/url	Create Recording (URL)
DialMyCalls::RecordingsApi	delete_recording_by_id	DELETE /recording/{RecordingId}	Delete Recording
DialMyCalls::RecordingsApi	get_recording_by_id	GET /recording/{RecordingId}	Get Recording
DialMyCalls::RecordingsApi	get_recordings	GET /recordings	List Recordings
DialMyCalls::RecordingsApi	update_recording_by_id	PUT /recording/{RecordingId}	Update Recording
DialMyCalls::TextsApi	cancel_text_by_id	DELETE /service/text/{TextId}	Cancel Text
DialMyCalls::TextsApi	create_text	POST /service/text	Create Text
DialMyCalls::TextsApi	delete_incoming_text_by_id	DELETE /incoming/text/{TextId}	Delete Incoming Text
DialMyCalls::TextsApi	get_incoming_text_by_id	GET /incoming/text/{TextId}	Get Incoming Text
DialMyCalls::TextsApi	get_incoming_texts	GET /incoming/texts	List Incoming Texts
DialMyCalls::TextsApi	get_short_codes	GET /shortcodes	List Shortcodes
DialMyCalls::TextsApi	get_text_by_id	GET /service/text/{TextId}	Get Text
DialMyCalls::TextsApi	get_text_recipients_by_text_id	GET /service/text/{TextId}/recipients	Get Text Recipients
DialMyCalls::TextsApi	get_texts	GET /service/texts	List Texts
DialMyCalls::VanityNumbersApi	delete_vanity_number_by_id	DELETE /vanitynumber/{VanityNumberId}	Delete Vanity Number
DialMyCalls::VanityNumbersApi	get_vanity_number_by_id	GET /vanitynumber/{VanityNumberId}	Get Vanity Number
DialMyCalls::VanityNumbersApi	get_vanity_numbers	GET /vanitynumbers	List Vanity Numbers
DialMyCalls::VanityNumbersApi	update_vanity_number_by_id	PUT /vanitynumber/{VanityNumberId}	Update Vanity Number

Documentation for Models

• DialMyCalls::Accessaccount
• DialMyCalls::Account
• DialMyCalls::CallRecipient
• DialMyCalls::Callerid
• DialMyCalls::Callservice
• DialMyCalls::Contact
• DialMyCalls::ContactAttributes
• DialMyCalls::CreateAccessAccountParameters
• DialMyCalls::CreateCallParameters
• DialMyCalls::CreateCallerIdParameters
• DialMyCalls::CreateContactParameters
• DialMyCalls::CreateGroupParameters
• DialMyCalls::CreateRecordingByPhoneParameters
• DialMyCalls::CreateRecordingByUrlParameters
• DialMyCalls::CreateRecordingParameters
• DialMyCalls::CreateTextParameters
• DialMyCalls::CreateUnverifiedCallerIdParameters
• DialMyCalls::Donotcontact
• DialMyCalls::Group
• DialMyCalls::Identifier
• DialMyCalls::Incomingtext
• DialMyCalls::Keyword
• DialMyCalls::Polling
• DialMyCalls::PushToListenAgain
• DialMyCalls::PushToOptOut
• DialMyCalls::PushToRecord
• DialMyCalls::PushToTalk
• DialMyCalls::Recording
• DialMyCalls::Service
• DialMyCalls::Shortcode
• DialMyCalls::TextRecipient
• DialMyCalls::UpdateAccessAccountByIdParameters
• DialMyCalls::UpdateCallerIdByIdParameters
• DialMyCalls::UpdateContactByIdParameters
• DialMyCalls::UpdateGroupByIdParameters
• DialMyCalls::UpdateRecordingByIdParameters
• DialMyCalls::UpdateVanityNumberByIdParameters
• DialMyCalls::Vanitynumber
• DialMyCalls::VerifyCallerIdByIdParameters

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: X-Auth-ApiKey
• Location: HTTP header