phonespeak_api v2.0.259

phonespeak_api

PhonespeakApi - JavaScript client for phonespeak_api PhoneSpeak API v2 This SDK is automatically generated by the Swagger Codegen project:

• API version: v2
• Package version: v2
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 phonespeak_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your phonespeak_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('phonespeak_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var PhonespeakApi = require('phonespeak_api');

var defaultClient = PhonespeakApi.ApiClient.instance;

// Configure API key authorization: Authorization
var Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix['Authorization'] = "Token"

var api = new PhonespeakApi.AccountApi()

var id = "id_example"; // {String} account id

var startDate = new Date("2013-10-20T19:20:30+01:00"); // {Date} start date

var endDate = new Date("2013-10-20T19:20:30+01:00"); // {Date} end date

var opts = { 
  'type': 56, // {Number} call type
  'size': 56, // {Number} page size
  'pageNum': 56 // {Number} page number
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountCallUsage(id, startDate, endDate, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://api-dev.phonespeak.com

Documentation for Models

• PhonespeakApi.Account
• PhonespeakApi.AccountCurrentExtension
• PhonespeakApi.AccountSetting
• PhonespeakApi.AddCompanyNumberInfo
• PhonespeakApi.AddTeammateInfo
• PhonespeakApi.Address
• PhonespeakApi.Authentication
• PhonespeakApi.AvailableNumber
• PhonespeakApi.BandwidthPortin
• PhonespeakApi.BandwidthPortinSearch
• PhonespeakApi.BillingAddress
• PhonespeakApi.BillingContact
• PhonespeakApi.BusinessHour
• PhonespeakApi.CallHandlingClosedHour
• PhonespeakApi.CallHandlingOpenHour
• PhonespeakApi.CallLog
• PhonespeakApi.CallQueue
• PhonespeakApi.CallRecording
• PhonespeakApi.CallTarget
• PhonespeakApi.Cart
• PhonespeakApi.Cdr
• PhonespeakApi.Charges
• PhonespeakApi.ChatFile
• PhonespeakApi.CompanyNumber
• PhonespeakApi.Contact
• PhonespeakApi.Conversation
• PhonespeakApi.Country
• PhonespeakApi.CouponDetail
• PhonespeakApi.CreateConversation
• PhonespeakApi.CreditCard
• PhonespeakApi.CspFetchMessageRequest
• PhonespeakApi.CspPushToken
• PhonespeakApi.CspSendMessage
• PhonespeakApi.CsrAccount
• PhonespeakApi.CsrUser
• PhonespeakApi.DeskphoneMacAddress
• PhonespeakApi.E911
• PhonespeakApi.E911Address
• PhonespeakApi.EmailTemplate
• PhonespeakApi.GLog
• PhonespeakApi.GetNumber
• PhonespeakApi.Greeting
• PhonespeakApi.IncomingMessage
• PhonespeakApi.InlineResponse200
• PhonespeakApi.InteliquentSMSInbound
• PhonespeakApi.Invoice
• PhonespeakApi.InvoiceItem
• PhonespeakApi.Item
• PhonespeakApi.Ivr
• PhonespeakApi.IvrKey
• PhonespeakApi.IvrTimeOut
• PhonespeakApi.LastLogin
• PhonespeakApi.Message
• PhonespeakApi.MessageDetail
• PhonespeakApi.MissedCallHandling
• PhonespeakApi.ModelPackage
• PhonespeakApi.MusicOnHold
• PhonespeakApi.Order
• PhonespeakApi.OrderPaymentInfo
• PhonespeakApi.PbxCallStatus
• PhonespeakApi.PhoneNumber
• PhonespeakApi.Product
• PhonespeakApi.ProfileImage
• PhonespeakApi.RateDeck
• PhonespeakApi.ReserveNumber
• PhonespeakApi.ResetPasswordOption
• PhonespeakApi.RingGroup
• PhonespeakApi.SMSHandling
• PhonespeakApi.ShippingInfo
• PhonespeakApi.SignupInfo
• PhonespeakApi.SmsInbound
• PhonespeakApi.StripeCharge
• PhonespeakApi.StripeInfo
• PhonespeakApi.SupportEmail
• PhonespeakApi.Team
• PhonespeakApi.Teammate
• PhonespeakApi.TextToSpeechInfo
• PhonespeakApi.TrackingRequest
• PhonespeakApi.Url
• PhonespeakApi.Voicemail

Documentation for Authorization

Authorization

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header