2.0.1 • Published 8 years ago

dialmycalls-js-client v2.0.1

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
8 years ago

dialmycalls-js-client

DialmycallsJsClient - JavaScript client for dialmycalls-js-client The DialMyCalls API

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dialmycalls-js-client --save

git

If the library is hosted at a git repository, e.g. https://github.com/dialmycalls/javascript-sdk-v2 then install it via:

    npm install dialmycalls/javascript-sdk-v2 --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var DialmycallsJsClient = require('dialmycalls-js-client');

var defaultClient = DialmycallsJsClient.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"

var api = new DialmycallsJsClient.Accounts()

var createAccessAccountParameters = new DialmycallsJsClient.CreateAccessAccountParameters(); // {CreateAccessAccountParameters} Request body


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAccessAccount(createAccessAccountParameters, callback);

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
DialmycallsJsClient.AccountscreateAccessAccountPOST /accessaccountAdd Access Account
DialmycallsJsClient.AccountsdeleteAccessAccountByIdDELETE /accessaccount/{AccessAccountId}Delete Access Account
DialmycallsJsClient.AccountsgetAccessAccountByIdGET /accessaccount/{AccessAccountId}Get Access Account
DialmycallsJsClient.AccountsgetAccessAccountsGET /accessaccountsList Access Accounts
DialmycallsJsClient.AccountsgetAccountGET /accountGet Account
DialmycallsJsClient.AccountsupdateAccessAccountByIdPUT /accessaccount/{AccessAccountId}Update Access Account
DialmycallsJsClient.CallerIdscreateCallerIdPOST /calleridAdd Caller ID
DialmycallsJsClient.CallerIdscreateUnverifiedCallerIdPOST /verify/calleridAdd Caller ID (Unverified)
DialmycallsJsClient.CallerIdsdeleteCallerIdByIdDELETE /callerid/{CalleridId}Delete Caller ID
DialmycallsJsClient.CallerIdsgetCallerIdByIdGET /callerid/{CalleridId}Get Caller ID
DialmycallsJsClient.CallerIdsgetCallerIdsGET /calleridsList Caller IDs
DialmycallsJsClient.CallerIdsupdateCallerIdByIdPUT /callerid/{CalleridId}Update Caller ID
DialmycallsJsClient.CallerIdsverifyCallerIdByIdPUT /verify/callerid/{CalleridId}Verify Caller ID
DialmycallsJsClient.CallscancelCallByIdDELETE /service/call/{CallId}Cancel Call
DialmycallsJsClient.CallscreateCallPOST /service/callCreate Call
DialmycallsJsClient.CallsgetCallByIdGET /service/call/{CallId}Get Call
DialmycallsJsClient.CallsgetCallRecipientsByCallIdGET /service/call/{CallId}/recipientsGet Call Recipients
DialmycallsJsClient.CallsgetCallsGET /service/callsList Calls
DialmycallsJsClient.ContactscreateContactPOST /contactAdd Contact
DialmycallsJsClient.ContactsdeleteContactByIdDELETE /contact/{ContactId}Delete Contact
DialmycallsJsClient.ContactsgetContactByIdGET /contact/{ContactId}Get Contact
DialmycallsJsClient.ContactsgetContactsGET /contactsList Contacts
DialmycallsJsClient.ContactsgetContactsByGroupIdGET /contacts/{GroupId}List Contacts in Group
DialmycallsJsClient.ContactsupdateContactByIdPUT /contact/{ContactId}Update Contact
DialmycallsJsClient.DoNotContactsgetDoNotContactsGET /donotcontactsList DoNotContacts
DialmycallsJsClient.GroupscreateGroupPOST /groupAdd Group
DialmycallsJsClient.GroupsdeleteGroupByIdDELETE /group/{GroupId}Delete Group
DialmycallsJsClient.GroupsgetGroupByIdGET /group/{GroupId}Get Group
DialmycallsJsClient.GroupsgetGroupsGET /groupsList Groups
DialmycallsJsClient.GroupsupdateGroupByIdPUT /group/{GroupId}Update Group
DialmycallsJsClient.KeywordsdeleteKeywordByIDDELETE /keyword/{KeywordId}Delete Keyword
DialmycallsJsClient.KeywordsgetKeywordByIDGET /keyword/{KeywordId}Get Keyword
DialmycallsJsClient.KeywordsgetKeywordsGET /keywordsList Keywords
DialmycallsJsClient.RecordingscreateRecordingPOST /recording/ttsCreate Recording (Text-to-Speech)
DialmycallsJsClient.RecordingscreateRecordingByPhonePOST /recording/phoneCreate Recording (Phone)
DialmycallsJsClient.RecordingscreateRecordingByUrlPOST /recording/urlCreate Recording (URL)
DialmycallsJsClient.RecordingsdeleteRecordingByIdDELETE /recording/{RecordingId}Delete Recording
DialmycallsJsClient.RecordingsgetRecordingByIdGET /recording/{RecordingId}Get Recording
DialmycallsJsClient.RecordingsgetRecordingsGET /recordingsList Recordings
DialmycallsJsClient.RecordingsupdateRecordingByIdPUT /recording/{RecordingId}Update Recording
DialmycallsJsClient.TextscancelTextByIdDELETE /service/text/{TextId}Cancel Text
DialmycallsJsClient.TextscreateTextPOST /service/textCreate Text
DialmycallsJsClient.TextsdeleteIncomingTextByIdDELETE /incoming/text/{TextId}Delete Incoming Text
DialmycallsJsClient.TextsgetIncomingTextByIdGET /incoming/text/{TextId}Get Incoming Text
DialmycallsJsClient.TextsgetIncomingTextsGET /incoming/textsList Incoming Texts
DialmycallsJsClient.TextsgetShortCodesGET /shortcodesList Shortcodes
DialmycallsJsClient.TextsgetTextByIdGET /service/text/{TextId}Get Text
DialmycallsJsClient.TextsgetTextRecipientsByTextIdGET /service/text/{TextId}/recipientsGet Text Recipients
DialmycallsJsClient.TextsgetTextsGET /service/textsList Texts
DialmycallsJsClient.VanityNumbersdeleteVanityNumberByIdDELETE /vanitynumber/{VanityNumberId}Delete Vanity Number
DialmycallsJsClient.VanityNumbersgetVanityNumberByIdGET /vanitynumber/{VanityNumberId}Get Vanity Number
DialmycallsJsClient.VanityNumbersgetVanityNumbersGET /vanitynumbersList Vanity Numbers
DialmycallsJsClient.VanityNumbersupdateVanityNumberByIdPUT /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