Skip to content

dialmycalls/python-sdk-v2

BranchesTags

Repository files navigation

dialmycalls_client

The DialMyCalls API

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/dialmycalls/python-sdk-v2.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/dialmycalls/python-sdk-v2.git)

Then import the package:

import dialmycalls_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import dialmycalls_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = dialmycalls_client.AccountsApi
create_access_account_parameters = dialmycalls_client.CreateAccessAccountParameters() # CreateAccessAccountParameters | Request body

try:
    # Add Access Account
    api_response = api_instance.create_access_account(create_access_account_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling AccountsApi->create_access_account: %s\n" % e

Documentation for API Endpoints

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

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

Documentation For Models

Documentation For Authorization

api_key

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

Author

support@dialmycalls.com

About

DialMyCalls Voice & Text Broadcasting

www.dialmycalls.com

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

3 stars

Watchers

3 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages