phonespeakv2_api

2.1.501 • Public • Published

phonespeakv2_api

ps.module - JavaScript client for phonespeakv2_api API Service for Internal use only This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 2.1.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 phonespeakv2_api --save

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):

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 ps.module = require('phonespeakv2_api');
var defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new ps.module.BalanceApi()
var version = "version_example"; // {String} 
var opts = { 
  'tenantId': "tenantId_example", // {String} 
  'startDate': new Date("2013-10-20T19:20:30+01:00"), // {Date} 
  'endDate': new Date("2013-10-20T19:20:30+01:00"), // {Date} 
  'transactionType': new ps.module.PhoneSpeakEntitiesEnumsTransactionType(), // {PhoneSpeakEntitiesEnumsTransactionType} 
  'status': true, // {Boolean} 
  'sortBy': "sortBy_example", // {String} 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // {PhoneSpeakEntitiesEnumsListDirection} 
  'search': "search_example", // {String} 
  'limit': 56, // {Number} 
  'pageNum': 56 // {Number} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVersionBalanceGet(version, opts, callback);

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
ps.module.BalanceApi apiVersionBalanceGet GET /api/{version}/balance List all balance transaction
ps.module.BalanceApi apiVersionBalancePut PUT /api/{version}/balance Update Top up call credit
ps.module.BalanceApi apiVersionBalanceTenantIdPut PUT /api/{version}/balance/{tenantId} Customer's credit adjustment
ps.module.BlacklistNumberApi apiVersionBlacklistnumberInboundGet GET /api/{version}/blacklistnumber/inbound [Inbound] List blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberInboundIdDelete DELETE /api/{version}/blacklistnumber/inbound/{id} [Inbound] Delete blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberInboundIdPut PUT /api/{version}/blacklistnumber/inbound/{id} [Inbound] Update blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberInboundPost POST /api/{version}/blacklistnumber/inbound [Inbound] Create blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberOutboundGet GET /api/{version}/blacklistnumber/outbound [Outbound] List blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberOutboundIdDelete DELETE /api/{version}/blacklistnumber/outbound/{id} [Outbound] Delete blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberOutboundIdPut PUT /api/{version}/blacklistnumber/outbound/{id} [Outbound] Update blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberOutboundPost POST /api/{version}/blacklistnumber/outbound [Outbound] Create blacklist number
ps.module.BlacklistNumberApi apiVersionBlacklistnumberOutboundSyncPost POST /api/{version}/blacklistnumber/outbound/sync [Outbound] Sync blacklist number
ps.module.BrandApi apiVersionBrandExternalvettingIdPut PUT /api/{version}/brand/externalvetting/{id} Request brand vetting
ps.module.BrandApi apiVersionBrandGet GET /api/{version}/brand List brand
ps.module.BrandApi apiVersionBrandIdDelete DELETE /api/{version}/brand/{id} Delete brand
ps.module.BrandApi apiVersionBrandIdGet GET /api/{version}/brand/{id} Get brand
ps.module.BrandApi apiVersionBrandIdPut PUT /api/{version}/brand/{id} Update brand
ps.module.BrandApi apiVersionBrandIdRevetPut PUT /api/{version}/brand/{id}/revet Revet Brand
ps.module.BrandApi apiVersionBrandPost POST /api/{version}/brand Create brand
ps.module.BrandApi apiVersionBrandSyncGet GET /api/{version}/brand/sync Brand Sync From User (Required Identity Login)
ps.module.BrandApi apiVersionBrandSyncdataGet GET /api/{version}/brand/syncdata Brand Sync Data From CloudFlare Require Key Access
ps.module.CallRecordingApi apiVersionTeammateTeammateIdCallrecordingGet GET /api/{version}/teammate/{teammateId}/callrecording List Call Recording
ps.module.CallRecordingApi apiVersionTeammateTeammateIdCallrecordingIdDelete DELETE /api/{version}/teammate/{teammateId}/callrecording/{id} Delete Call Recording
ps.module.CallRecordingApi apiVersionTeammateTeammateIdCallrecordingIdGet GET /api/{version}/teammate/{teammateId}/callrecording/{id} Get Call Recording
ps.module.CallRecordingApi apiVersionTeammateTeammateIdCallrecordingPost POST /api/{version}/teammate/{teammateId}/callrecording Create Call Recording
ps.module.CallRecordingApi apiVersionTenantTenantIdCallrecordingDelete DELETE /api/{version}/tenant/{tenantId}/callrecording Tenant Call Recording Delete
ps.module.CallRecordingApi apiVersionTenantTenantIdCallrecordingEnabledEnablePut PUT /api/{version}/tenant/{tenantId}/callrecording/enabled/{enable} Tenant Call Recording Enable
ps.module.CallRecordingApi apiVersionTenantTenantIdCallrecordingGet GET /api/{version}/tenant/{tenantId}/callrecording Tenant Call Recording List
ps.module.CallRecordingApi apiVersionTenantTenantIdCallrecordingIdDelete DELETE /api/{version}/tenant/{tenantId}/callrecording/{id} Tenant Call Recording Delete
ps.module.CallRecordingAnonymousApi apiVersionTenantTenantIdCallrecordingDirectionUploadIdPut PUT /api/{version}/tenant/{tenantId}/callrecording/{direction}/upload/{id}
ps.module.CallRestrictionApi apiVersionTenantTenantIdCallrestrictionGet GET /api/{version}/tenant/{tenantId}/callrestriction [Tenant] Get Tenant Call Restriction
ps.module.CallRestrictionApi apiVersionTenantTenantIdCallrestrictionPut PUT /api/{version}/tenant/{tenantId}/callrestriction [Tenant] Update Tenant Call Restriction
ps.module.CallerIdApi apiVersionTeammateTeammateIdCalleridGet GET /api/{version}/teammate/{teammateId}/callerid [Teammate] List Caller Id
ps.module.CallerIdApi apiVersionTeammateTeammateIdCalleridIdPut PUT /api/{version}/teammate/{teammateId}/callerid/{id} [Teammate] Update Default Caller Id
ps.module.CampaignApi apiVersionCampaignGet GET /api/{version}/campaign List Campaign
ps.module.CampaignApi apiVersionCampaignIdDeactivatePut PUT /api/{version}/campaign/{id}/deactivate Deactivate Campaign
ps.module.CampaignApi apiVersionCampaignIdDelete DELETE /api/{version}/campaign/{id} Delete Campaign
ps.module.CampaignApi apiVersionCampaignIdGet GET /api/{version}/campaign/{id} Get Campaign
ps.module.CampaignApi apiVersionCampaignIdPut PUT /api/{version}/campaign/{id} Update Campaign
ps.module.CampaignApi apiVersionCampaignIdRevetPut PUT /api/{version}/campaign/{id}/revet Revet Campaign
ps.module.CampaignApi apiVersionCampaignIdTnoptionsPost POST /api/{version}/campaign/{id}/tnoptions Update Campaign Asociated Number (can be add or remove)
ps.module.CampaignApi apiVersionCampaignPost POST /api/{version}/campaign Create Campaign
ps.module.CampaignApi apiVersionCampaignSyncGet GET /api/{version}/campaign/sync Campaign Sync From User (Required Identity Login)
ps.module.CampaignApi apiVersionCampaignSyncdataGet GET /api/{version}/campaign/syncdata Campaign Sync Data From CloudFlare Require Key Access
ps.module.CampaignApi apiVersionCampaignVettedGet GET /api/{version}/campaign/vetted List Campaign vetted only
ps.module.CdrApi apiVersionCdrCalleeDetailGet GET /api/{version}/cdr/callee/detail Get call cdr
ps.module.CdrApi apiVersionCdrCallidIdGet GET /api/{version}/cdr/callid/{id} Get call id info
ps.module.CdrApi apiVersionCdrGet GET /api/{version}/cdr List Cdr
ps.module.CdrApi apiVersionCdrLogGet GET /api/{version}/cdr/log List admin Cdr
ps.module.CdrApi apiVersionCdrOwnerIdAllDelete DELETE /api/{version}/cdr/{ownerId}/all Update Cdr
ps.module.CdrApi apiVersionCdrPut PUT /api/{version}/cdr Update Cdr
ps.module.CdrApi apiVersionCsrCdrLogExportGet GET /api/{version}/csr/cdr/log/export List csr Cdr
ps.module.CdrApi apiVersionCsrCdrLogGet GET /api/{version}/csr/cdr/log List csr Cdr
ps.module.CloudSoftPhoneApi cloudsoftphoneContactGet GET /cloudsoftphone/contact
ps.module.CloudSoftPhoneApi cloudsoftphoneMessageFetchPost POST /cloudsoftphone/message/fetch
ps.module.CloudSoftPhoneApi cloudsoftphoneMessagePost POST /cloudsoftphone/message
ps.module.CloudSoftPhoneApi cloudsoftphoneProvGet GET /cloudsoftphone/prov
ps.module.CloudSoftPhoneApi cloudsoftphonePushtokenPost POST /cloudsoftphone/pushtoken
ps.module.CompanyApi apiVersionCompanyGet GET /api/{version}/company List all company
ps.module.CompanyApi apiVersionCompanyIdBusinesshourPut PUT /api/{version}/company/{id}/businesshour Update company business hour
ps.module.CompanyApi apiVersionCompanyIdCallhandlingPut PUT /api/{version}/company/{id}/callhandling Update company call handling
ps.module.CompanyApi apiVersionCompanyIdDelete DELETE /api/{version}/company/{id} Delete company
ps.module.CompanyApi apiVersionCompanyIdGet GET /api/{version}/company/{id} Retrieves a company
ps.module.CompanyApi apiVersionCompanyIdPut PUT /api/{version}/company/{id} Update a company
ps.module.CompanyApi apiVersionCompanyPost POST /api/{version}/company Create a company
ps.module.ContactApi apiVersionContactGet GET /api/{version}/contact List all contact
ps.module.ContactApi apiVersionContactIdContactimagePut PUT /api/{version}/contact/{id}/contactimage Update existing contact image
ps.module.ContactApi apiVersionContactIdDelete DELETE /api/{version}/contact/{id} Delete contact
ps.module.ContactApi apiVersionContactIdGet GET /api/{version}/contact/{id} Retrieves existing contact
ps.module.ContactApi apiVersionContactIdPut PUT /api/{version}/contact/{id} Update existing contact
ps.module.ContactApi apiVersionContactIdSettingPut PUT /api/{version}/contact/{id}/setting Update existing contact setting
ps.module.ContactApi apiVersionContactPost POST /api/{version}/contact Create contact
ps.module.ContactCompanyApi apiVersionContactCompanyGet GET /api/{version}/contact/company List all company contact
ps.module.ContactCompanyApi apiVersionContactCompanyIdGet GET /api/{version}/contact/company/{id} Retrieves a company contact
ps.module.ContactTeammateApi apiVersionContactTeammateGet GET /api/{version}/contact/teammate List all Teammate contact
ps.module.ContactTeammateApi apiVersionContactTeammateIdGet GET /api/{version}/contact/teammate/{id} Retrieves a Teammate contact
ps.module.CouponApi apiVersionCouponGet GET /api/{version}/coupon List of coupon to applied that can be applied to subscriptions or invoice
ps.module.CsrUserApi apiVersionCsrGet GET /api/{version}/csr Retrieve current login CSR User info
ps.module.CsrUserApi apiVersionCsrUserGet GET /api/{version}/csr/user [Rerpresentative] Returns a list of active CSR User.
ps.module.CsrUserApi apiVersionCsrUserIdAccessPut PUT /api/{version}/csr/user/{id}/access [Rerpresentative] Update csr user site access
ps.module.CsrUserApi apiVersionCsrUserIdDelete DELETE /api/{version}/csr/user/{id} [Rerpresentative] Delete existing Csr User
ps.module.CsrUserApi apiVersionCsrUserIdGet GET /api/{version}/csr/user/{id} [Rerpresentative] Retrieve existing CSR User account
ps.module.CsrUserApi apiVersionCsrUserIdProfileimagePut PUT /api/{version}/csr/user/{id}/profileimage [Rerpresentative] Upload existing CSR User Profile Image
ps.module.CsrUserApi apiVersionCsrUserIdPut PUT /api/{version}/csr/user/{id} [Rerpresentative] Update existing Csr User
ps.module.CsrUserApi apiVersionCsrUserIdStatusStatusPut PUT /api/{version}/csr/user/{id}/status/{status} [Rerpresentative] Update existing CSR User Status
ps.module.CsrUserApi apiVersionCsrUserPost POST /api/{version}/csr/user [Rerpresentative] Create Csr User
ps.module.DeviceApi apiVersionTeammateTeammateIdDeviceDefaultGet GET /api/{version}/teammate/{teammateId}/device/default [Only for desktop and mobile] Retrieve default device.
ps.module.DeviceApi apiVersionTeammateTeammateIdDeviceGet GET /api/{version}/teammate/{teammateId}/device Returns a list of active device.
ps.module.DeviceApi apiVersionTeammateTeammateIdDeviceIdDelete DELETE /api/{version}/teammate/{teammateId}/device/{id} [Team] Delete Device
ps.module.DeviceApi apiVersionTeammateTeammateIdDeviceIdGet GET /api/{version}/teammate/{teammateId}/device/{id} Retrieve existing device.
ps.module.DeviceApi apiVersionTeammateTeammateIdDeviceIdPut PUT /api/{version}/teammate/{teammateId}/device/{id} [Team] Update existing device
ps.module.DeviceApi apiVersionTeammateTeammateIdDevicePost POST /api/{version}/teammate/{teammateId}/device [Teammates] Add new device
ps.module.DeviceApi apiVersionTenantTenantIdDeviceGet GET /api/{version}/tenant/{tenantId}/device Returns a list of active device.
ps.module.DialPlanApi apiVersionSystemDialplanGet GET /api/{version}/system/dialplan Retrieves the details of an existing System Dial Plan.
ps.module.DialPlanApi apiVersionSystemDialplanPost POST /api/{version}/system/dialplan Create System Dial Plan
ps.module.DialPlanApi apiVersionSystemDialplanPut PUT /api/{version}/system/dialplan Updates the specific System Dial Plan.
ps.module.InvoiceApi apiVersionInvoiceGet GET /api/{version}/invoice Retrieve billing/payment history
ps.module.InvoiceApi apiVersionInvoicePut PUT /api/{version}/invoice Pay invoice
ps.module.InvoiceApi apiVersionInvoiceRefundPost POST /api/{version}/invoice/refund Refund Charges
ps.module.IvrApi apiVersionCompanyCompanyIdIvrActionGet GET /api/{version}/company/{companyId}/ivr/action [Company] Returns a list of active Menu action.
ps.module.IvrApi apiVersionCompanyCompanyIdIvrIdDelete DELETE /api/{version}/company/{companyId}/ivr/{id} [Company] Delete Ivr Menu
ps.module.IvrApi apiVersionCompanyCompanyIdIvrIdPut PUT /api/{version}/company/{companyId}/ivr/{id} [Company] Update existing IVR menu
ps.module.IvrApi apiVersionCompanyCompanyIdIvrPost POST /api/{version}/company/{companyId}/ivr [Company] Create IVR menu
ps.module.IvrApi apiVersionTeamTeamIdIvrActionGet GET /api/{version}/team/{teamId}/ivr/action [Team] Returns a list of active Menu action.
ps.module.IvrApi apiVersionTeamTeamIdIvrIdDelete DELETE /api/{version}/team/{teamId}/ivr/{id} [Team] Delete Ivr Menu
ps.module.IvrApi apiVersionTeamTeamIdIvrIdPut PUT /api/{version}/team/{teamId}/ivr/{id} [Team] Update existing IVR menu
ps.module.IvrApi apiVersionTeamTeamIdIvrPost POST /api/{version}/team/{teamId}/ivr [Team] Create IVR menu
ps.module.IvrMediaApi apiVersionCompanyCompanyIdIvrIvridMediaIdDelete DELETE /api/{version}/company/{companyId}/ivr/{ivrid}/media/{id} [Company] Delete ivr media
ps.module.IvrMediaApi apiVersionCompanyCompanyIdIvrIvridMediaPost POST /api/{version}/company/{companyId}/ivr/{ivrid}/media [Company] Add new ivr media
ps.module.IvrMediaApi apiVersionCompanyCompanyIdIvrIvridTextmediaPost POST /api/{version}/company/{companyId}/ivr/{ivrid}/textmedia [Company] Add new ivr text media
ps.module.IvrMediaApi apiVersionTeamTeamIdIvrIvridMediaIdDelete DELETE /api/{version}/team/{teamId}/ivr/{ivrid}/media/{id} [Team] Delete ivr media
ps.module.IvrMediaApi apiVersionTeamTeamIdIvrIvridMediaPost POST /api/{version}/team/{teamId}/ivr/{ivrid}/media [Team] Add new ivr media
ps.module.IvrMediaApi apiVersionTeamTeamIdIvrIvridTextmediaPost POST /api/{version}/team/{teamId}/ivr/{ivrid}/textmedia [Team] Add new ivr text media
ps.module.IvrMediaApi apiVersionTenantTenantIdIvrmediaPost POST /api/{version}/tenant/{tenantId}/ivrmedia [Tenant] Add new ivr media
ps.module.LocationApi apiVersionLocationGet GET /api/{version}/location [AllowAnonymous] Get User State
ps.module.MessageApi apiVersionMessageConversationIdIdGet GET /api/{version}/message/{conversationId}/{id} [AllowAnonymous] Get message media
ps.module.MessageApi apiVersionMessageLogExportGet GET /api/{version}/message/log/export Export log of Message
ps.module.MessageApi apiVersionMessageLogGet GET /api/{version}/message/log Returns a log of Message
ps.module.MessageApi apiVersionMessageOwnerIdCountGet GET /api/{version}/message/{ownerId}/count Get message count
ps.module.MessageApi apiVersionOwnerIdConversationAllDelete DELETE /api/{version}/{ownerId}/conversation/all Delete All Conversation
ps.module.MessageApi apiVersionOwnerIdConversationConversationIdDelete DELETE /api/{version}/{ownerId}/conversation/{conversationId} Delete Conversation
ps.module.MessageApi apiVersionOwnerIdConversationConversationIdGet GET /api/{version}/{ownerId}/conversation/{conversationId} Returns a list of Message
ps.module.MessageApi apiVersionOwnerIdConversationConversationIdPut PUT /api/{version}/{ownerId}/conversation/{conversationId} Update Conversation Name, Image
ps.module.MessageApi apiVersionOwnerIdConversationGet GET /api/{version}/{ownerId}/conversation Returns a list of Conversation
ps.module.MessageApi apiVersionOwnerIdConversationReadPut PUT /api/{version}/{ownerId}/conversation/read Update message
ps.module.MessageApi apiVersionOwnerIdMessageIdDelete DELETE /api/{version}/{ownerId}/message/{id} Delete message
ps.module.MessageApi apiVersionOwnerIdMessageIdPut PUT /api/{version}/{ownerId}/message/{id} Update message
ps.module.MessageApi apiVersionOwnerIdMessageIdResendGet GET /api/{version}/{ownerId}/message/{id}/resend Resend message
ps.module.MessageApi apiVersionOwnerIdMessagePost POST /api/{version}/{ownerId}/message Create new Message
ps.module.MobileApi apiVersionMobileContactsGet GET /api/{version}/mobile/contacts (Auth)
ps.module.MobileApi apiVersionMobileFetchPost POST /api/{version}/mobile/fetch (Auth)
ps.module.MobileApi apiVersionMobileRegistrationPost POST /api/{version}/mobile/registration (Auth)
ps.module.MobileApi apiVersionMobileSendmessagePost POST /api/{version}/mobile/sendmessage (Auth)
ps.module.MusicOnHoldApi apiVersionTeamTeamIdMohIdDelete DELETE /api/{version}/team/{TeamId}/moh/{id} [Team] Delete music on hold
ps.module.MusicOnHoldApi apiVersionTeamTeamIdMohIdPut PUT /api/{version}/team/{TeamId}/moh/{id} [Team] Select music on hold
ps.module.MusicOnHoldApi apiVersionTeamTeamIdMohPost POST /api/{version}/team/{TeamId}/moh [Team] Add new music on hold
ps.module.MusicOnHoldApi apiVersionTeammateTeammateIdMohIdDelete DELETE /api/{version}/teammate/{teammateId}/moh/{id} [Teammate] Delete music on hold
ps.module.MusicOnHoldApi apiVersionTeammateTeammateIdMohIdPut PUT /api/{version}/teammate/{teammateId}/moh/{id} [Teammate] Select music on hold
ps.module.MusicOnHoldApi apiVersionTeammateTeammateIdMohPost POST /api/{version}/teammate/{teammateId}/moh [Teammate] Add new music on hold
ps.module.MusicOnHoldApi apiVersionTenantTenantIdMohIdDelete DELETE /api/{version}/tenant/{tenantId}/moh/{id} [Tenant] Delete music on hold
ps.module.MusicOnHoldApi apiVersionTenantTenantIdMohIdPut PUT /api/{version}/tenant/{tenantId}/moh/{id} [Tenant] Select music on hold
ps.module.MusicOnHoldApi apiVersionTenantTenantIdMohPost POST /api/{version}/tenant/{tenantId}/moh [Tenant] Add new music on hold
ps.module.NoteApi apiVersionNoteGet GET /api/{version}/note List note
ps.module.NoteApi apiVersionNoteIdDelete DELETE /api/{version}/note/{id} Delete note
ps.module.NoteApi apiVersionNoteIdPut PUT /api/{version}/note/{id} Update note
ps.module.NoteApi apiVersionNotePost POST /api/{version}/note Create note
ps.module.NumberApi apiVersionNumberCountryGet GET /api/{version}/number/{country} Search Number
ps.module.NumberApi apiVersionNumberCountryPurchasePost POST /api/{version}/number/{country}/purchase [TBC] Purchase Number
ps.module.NumberApi apiVersionNumberCountryReleaseDelete DELETE /api/{version}/number/{country}/release [TBC] Release number
ps.module.NumberApi apiVersionNumberCountryReservePost POST /api/{version}/number/{country}/reserve Reserve Number
ps.module.NumberApi apiVersionNumberImportPost POST /api/{version}/number/import [TBC] Import Number to local number pool
ps.module.PackageApi apiVersionPackageGet GET /api/{version}/package Returns a list of your package(s).
ps.module.PackageApi apiVersionPackageIdDelete DELETE /api/{version}/package/{id} Delete existing package.
ps.module.PackageApi apiVersionPackageIdGet GET /api/{version}/package/{id} Retrieves the details of an existing package.
ps.module.PackageApi apiVersionPackageIdPut PUT /api/{version}/package/{id} Updates the specific package.
ps.module.PackageApi apiVersionPackagePost POST /api/{version}/package Create Package
ps.module.PaymentMethodApi apiVersionPaymentmethodGet GET /api/{version}/paymentmethod Returns a list of payment method.
ps.module.PaymentMethodApi apiVersionPaymentmethodIdDelete DELETE /api/{version}/paymentmethod/{id} Delete existing payment method.
ps.module.PaymentMethodApi apiVersionPaymentmethodIdGet GET /api/{version}/paymentmethod/{id} Retrieves the details of an existing payment method.
ps.module.PaymentMethodApi apiVersionPaymentmethodIdPut PUT /api/{version}/paymentmethod/{id} Update the details of an existing payment method.
ps.module.PaymentMethodApi apiVersionPaymentmethodPost POST /api/{version}/paymentmethod Create payment method
ps.module.PbxApi apiVersionUserPbxDelete DELETE /api/{version}/user/pbx (Auth policies: AdminAndCsrAdminOnlyPolicy)
ps.module.PbxApi apiVersionUserPbxGet GET /api/{version}/user/pbx (Auth policies: AdminAndCsrAdminOnlyPolicy)
ps.module.PbxApi apiVersionUserPbxPost POST /api/{version}/user/pbx (Auth policies: AdminAndCsrAdminOnlyPolicy)
ps.module.PbxApi apiVersionUserPbxPut PUT /api/{version}/user/pbx (Auth policies: AdminAndCsrAdminOnlyPolicy)
ps.module.PhoneNumberApi apiVersionCompanyCompanyIdPhonenumberIdDelete DELETE /api/{version}/company/{companyId}/phonenumber/{id} [Company] Delete Phone Number of respective company
ps.module.PhoneNumberApi apiVersionCompanyCompanyIdPhonenumberIdPut PUT /api/{version}/company/{companyId}/phonenumber/{id} [Company] Update Phone Number of respective company
ps.module.PhoneNumberApi apiVersionCompanyCompanyIdPhonenumberPost POST /api/{version}/company/{companyId}/phonenumber [Company] Add Phone Number to respective company
ps.module.PhoneNumberApi apiVersionCsrPhonenumberGet GET /api/{version}/csr/phonenumber [CSR] List all Phone Number sort by tenant id, then number
ps.module.PhoneNumberApi apiVersionCsrTenantTenantIdPhonenumberGet GET /api/{version}/csr/tenant/{tenantId}/phonenumber [CSR] List all Phone Number by Tenant
ps.module.PhoneNumberApi apiVersionCsrTenantTenantIdPhonenumberIdOwnerOwnerIdPut PUT /api/{version}/csr/tenant/{tenantId}/phonenumber/{id}/owner/{ownerId} Assign Phone Number to company or teammate
ps.module.PhoneNumberApi apiVersionPhonenumberIdDldaDldaIdGet GET /api/{version}/phonenumber/{id}/dlda/{dldaId} Get directory listing and directory assistance for phone number
ps.module.PhoneNumberApi apiVersionPhonenumberIdDldaGet GET /api/{version}/phonenumber/{id}/dlda List directory listing and directory assistance for phone number
ps.module.PhoneNumberApi apiVersionPhonenumberIdDldaPost POST /api/{version}/phonenumber/{id}/dlda Create directory listing and directory assistance for phone number
ps.module.PhoneNumberApi apiVersionPhonenumberIdLidbGet GET /api/{version}/phonenumber/{id}/lidb List outbound calling name for phone number
ps.module.PhoneNumberApi apiVersionPhonenumberIdLidbLidbIdGet GET /api/{version}/phonenumber/{id}/lidb/{lidbId} Get outbound calling name for phone number
ps.module.PhoneNumberApi apiVersionPhonenumberIdLidbPost POST /api/{version}/phonenumber/{id}/lidb Create outbound calling name for phone number
ps.module.PhoneNumberApi apiVersionTeamTeamIdPhonenumberGet GET /api/{version}/team/{teamId}/phonenumber List team available SMS Phone Number
ps.module.PhoneNumberApi apiVersionTeammateTeammateIdPhonenumberGet GET /api/{version}/teammate/{teammateId}/phonenumber List teammate available SMS Phone Number
ps.module.PhoneNumberApi apiVersionTeammateTeammateIdPhonenumberIdDelete DELETE /api/{version}/teammate/{teammateId}/phonenumber/{id} [Teammate] Delete Phone Number of respective teammate
ps.module.PhoneNumberApi apiVersionTeammateTeammateIdPhonenumberIdPut PUT /api/{version}/teammate/{teammateId}/phonenumber/{id} [Teammate] Update Phone Number of respective teammate
ps.module.PhoneNumberApi apiVersionTeammateTeammateIdPhonenumberPost POST /api/{version}/teammate/{teammateId}/phonenumber [Teammate] Add Phone Number to respective teammate
ps.module.PhoneNumberApi apiVersionTenantTenantIdPhonenumberGet GET /api/{version}/tenant/{tenantId}/phonenumber List all Phone Number by Tenant
ps.module.PhoneNumberApi apiVersionTenantTenantIdPhonenumberPost POST /api/{version}/tenant/{tenantId}/phonenumber [CSR] Port in number from external source
ps.module.PlanApi apiVersionPlanGet GET /api/{version}/plan Returns a list of plan.
ps.module.ProductApi apiVersionProductGet GET /api/{version}/product Returns a list of your products.
ps.module.ProductApi apiVersionProductIdDelete DELETE /api/{version}/product/{id} Delete a product.
ps.module.ProductApi apiVersionProductIdGet GET /api/{version}/product/{id} Retrieves the details of an existing product.
ps.module.ProductApi apiVersionProductIdPut PUT /api/{version}/product/{id} Updates the specific product.
ps.module.RateDeckApi apiVersionTenantTenantIdRatedeckGet GET /api/{version}/tenant/{tenantId}/ratedeck List of RateDeck with call restriction
ps.module.ResellerApi apiVersionResellerGet GET /api/{version}/reseller Returns a list of active Reseller.
ps.module.ResellerApi apiVersionResellerIdDelete DELETE /api/{version}/reseller/{id} Delete Csr User
ps.module.ResellerApi apiVersionResellerIdGet GET /api/{version}/reseller/{id} Retrieve existing Reseller information
ps.module.ResellerApi apiVersionResellerIdPut PUT /api/{version}/reseller/{id} Update existing Reseller
ps.module.ResellerApi apiVersionResellerPost POST /api/{version}/reseller Create a new Reseller
ps.module.ResourceApi apiVersionResourceGet GET /api/{version}/resource Returns a list of your Resource.
ps.module.ResourceApi apiVersionResourceIdDelete DELETE /api/{version}/resource/{id} Delete existing Resource.
ps.module.ResourceApi apiVersionResourceIdGet GET /api/{version}/resource/{id} Retrieves the details of an existing Resource.
ps.module.ResourceApi apiVersionResourceIdPut PUT /api/{version}/resource/{id} Updates the specific Resource.
ps.module.ResourceApi apiVersionResourcePost POST /api/{version}/resource Create Resource
ps.module.SessionApi apiVersionSessionPost POST /api/{version}/session [AllowAnonymous] Create session for checkout
ps.module.StorageApi apiVersionStorageAuthenticationGet GET /api/{version}/storage/authentication Get Authentication
ps.module.StorageApi apiVersionTenantTenantIdStorageCallrecordingAuthenticationGet GET /api/{version}/tenant/{tenantId}/storage/callrecording/authentication
ps.module.SubscriptionApi apiVersionSubscriptionIdDelete DELETE /api/{version}/subscription/{id} Cancel existing subscription.
ps.module.SubscriptionApi apiVersionSubscriptionIdGet GET /api/{version}/subscription/{id} Retrieves the details of an existing subscription.
ps.module.SubscriptionApi apiVersionSubscriptionPost POST /api/{version}/subscription Create Subscription
ps.module.SubscriptionApi apiVersionSubscriptionPut PUT /api/{version}/subscription Updates the specific subscription.
ps.module.SubscriptionItemApi apiVersionSubscriptionitemPut PUT /api/{version}/subscriptionitem Updates the specific subscription.
ps.module.TeamApi apiVersionTeamGet GET /api/{version}/team Returns a list of active team.
ps.module.TeamApi apiVersionTeamIdCallhandlingMissedcallPut PUT /api/{version}/team/{id}/callhandling/missedcall Update team miss call handling
ps.module.TeamApi apiVersionTeamIdCallhandlingOpenhourPut PUT /api/{version}/team/{id}/callhandling/openhour Update team open hour call handling
ps.module.TeamApi apiVersionTeamIdDelete DELETE /api/{version}/team/{id} Delete Team
ps.module.TeamApi apiVersionTeamIdGet GET /api/{version}/team/{id} Retrieve team info
ps.module.TeamApi apiVersionTeamIdMemberPut PUT /api/{version}/team/{id}/member Update team member
ps.module.TeamApi apiVersionTeamIdPut PUT /api/{version}/team/{id} Update existing Team
ps.module.TeamApi apiVersionTeamIdSettingPut PUT /api/{version}/team/{id}/setting Update team setting
ps.module.TeamApi apiVersionTeamIdSummaryGet GET /api/{version}/team/{id}/summary Update team setting
ps.module.TeamApi apiVersionTeamPost POST /api/{version}/team Create Team
ps.module.TeammateApi apiVersionTeammateExtensionGet GET /api/{version}/teammate/extension [Representative] Get next available extension
ps.module.TeammateApi apiVersionTeammateGet GET /api/{version}/teammate [Representative] Returns a list of active Teammate.
ps.module.TeammateApi apiVersionTeammateIdCallhandlingPut PUT /api/{version}/teammate/{id}/callhandling Update call handling
ps.module.TeammateApi apiVersionTeammateIdGet GET /api/{version}/teammate/{id} [Representative] Retrieve existing Teammate account
ps.module.TeammateApi apiVersionTeammateIdProfileimagePut PUT /api/{version}/teammate/{id}/profileimage [Representative] Upload existing Teammate Profile Image
ps.module.TeammateApi apiVersionTeammateIdPut PUT /api/{version}/teammate/{id} [Representative] Update existing teammmate.
ps.module.TeammateApi apiVersionTeammateIdSmsnoPhoneNumberIdPut PUT /api/{version}/teammate/{id}/smsno/{phoneNumberId} (Auth policies: StandardPolicy)
ps.module.TeammateApi apiVersionTeammateIdStatusStatusPut PUT /api/{version}/teammate/{id}/status/{status} [Representative] Update teammate status
ps.module.TeammateApi apiVersionTeammatePost POST /api/{version}/teammate [Representative] Create a new Teammate.
ps.module.TeammateApi apiVersionUserGet GET /api/{version}/user [Own] Retrieve current login Teammate User info
ps.module.TelcoWebhookApi apiVersionOrderBwPost POST /api/{version}/order/bw This webhook is triggered when there is incoming text message event.
ps.module.TelcoWebhookApi apiVersionSmsBwPost POST /api/{version}/sms/bw This webhook is triggered when there is incoming text message event.
ps.module.TenantApi apiVersionCsrTenantGet GET /api/{version}/csr/tenant [CSR] Returns a list of active Tenant
ps.module.TenantApi apiVersionCsrTenantIdDelete DELETE /api/{version}/csr/tenant/{id} [CSR] Delete Tenant from database
ps.module.TenantApi apiVersionCsrTenantIdForcecancelPut PUT /api/{version}/csr/tenant/{id}/forcecancel [CSR] FORCE CANCEL Tenant
ps.module.TenantApi apiVersionCsrTenantIdGet GET /api/{version}/csr/tenant/{id} [CSR] Retrieve existing Tenant
ps.module.TenantApi apiVersionCsrTenantIdPackagePackageIdPut PUT /api/{version}/csr/tenant/{id}/package/{packageId} [CSR] Update Tenant Package
ps.module.TenantApi apiVersionCsrTenantIdPut PUT /api/{version}/csr/tenant/{id} [CSR] Update Tenant
ps.module.TenantApi apiVersionCsrTenantIdResetusagePut PUT /api/{version}/csr/tenant/{id}/resetusage [CSR] Reset Usage Tenant
ps.module.TenantApi apiVersionCsrTenantIdStatusPut PUT /api/{version}/csr/tenant/{id}/status [CSR] Update Tenant Status
ps.module.TenantApi apiVersionCsrTenantPost POST /api/{version}/csr/tenant [CSR] Create Tenant
ps.module.TenantApi apiVersionStripeCreatetenantPost POST /api/{version}/stripe/createtenant [CSR] Create Tenant from Stripe
ps.module.TenantApi apiVersionTenantGet GET /api/{version}/tenant [Profile] Get Tenant
ps.module.TenantApi apiVersionTenantIdInternationalcallPut PUT /api/{version}/tenant/{id}/internationalcall Verify international call
ps.module.TenantApi apiVersionTenantIdInternationalchargePut PUT /api/{version}/tenant/{id}/internationalcharge Verify international call charges
ps.module.TenantApi apiVersionTenantIdTrialendPut PUT /api/{version}/tenant/{id}/trialend End trial
ps.module.TenantApi apiVersionTenantPut PUT /api/{version}/tenant [Profile] Update Tenant
ps.module.UrlApi apiVersionUrlGet GET /api/{version}/url Returns a list of your url.
ps.module.UrlApi apiVersionUrlIdDelete DELETE /api/{version}/url/{id} Delete existing url.
ps.module.UrlApi apiVersionUrlIdGet GET /api/{version}/url/{id} Retrieves the details of an existing url.
ps.module.UrlApi apiVersionUrlIdPut PUT /api/{version}/url/{id} Updates the specific url.
ps.module.UrlApi apiVersionUrlPost POST /api/{version}/url Create Url
ps.module.UsageApi apiVersionUsageGet GET /api/{version}/usage List all Usage transaction
ps.module.VoicemailApi apiVersionOwnerIdVoicemailAllDelete DELETE /api/{version}/{ownerId}/voicemail/all Delete all voicemail
ps.module.VoicemailApi apiVersionOwnerIdVoicemailDelete DELETE /api/{version}/{ownerId}/voicemail Delete Voicemail
ps.module.VoicemailApi apiVersionOwnerIdVoicemailGet GET /api/{version}/{ownerId}/voicemail List Voicemail
ps.module.VoicemailApi apiVersionOwnerIdVoicemailIdGet GET /api/{version}/{ownerId}/voicemail/{id} Get Voicemail
ps.module.VoicemailApi apiVersionOwnerIdVoicemailIdPut PUT /api/{version}/{ownerId}/voicemail/{id} Update Voicemail
ps.module.VoicemailApi apiVersionOwnerIdVoicemailUnreadcountGet GET /api/{version}/{ownerId}/voicemail/unreadcount Get Voicemail Unread Count
ps.module.VoicemailGreetingApi apiVersionTeamTeamIdVmGreetingIdDelete DELETE /api/{version}/team/{teamId}/vm/greeting/{id} [Team] Delete voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeamTeamIdVmGreetingIdPut PUT /api/{version}/team/{teamId}/vm/greeting/{id} [Team] Select voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeamTeamIdVmGreetingPost POST /api/{version}/team/{teamId}/vm/greeting [Team] Add new voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeamTeamIdVmTextgreetingPost POST /api/{version}/team/{teamId}/vm/textgreeting [Team] Convert Text to Speech and add new voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeammateTeammateIdVmGreetingIdDelete DELETE /api/{version}/teammate/{teammateId}/vm/greeting/{id} [Teammate] Delete voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeammateTeammateIdVmGreetingIdPut PUT /api/{version}/teammate/{teammateId}/vm/greeting/{id} [Teammate] Select voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeammateTeammateIdVmGreetingPost POST /api/{version}/teammate/{teammateId}/vm/greeting [Teammate] Add new voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTeammateTeammateIdVmTextgreetingPost POST /api/{version}/teammate/{teammateId}/vm/textgreeting [Teammate] Convert Text to Speech and add new voicemail greeting
ps.module.VoicemailGreetingApi apiVersionTenantTenantIdGreetingIdPut PUT /api/{version}/tenant/{tenantId}/greeting/{id} [Tenant] Select default voicemail greeting
ps.module.WorkerApi apiVersionWorkerBrandSyncdataGet GET /api/{version}/worker/brand/syncdata

Documentation for Models

Documentation for Authorization

oauth2

Readme

Keywords

none

Package Sidebar

Install

npm i phonespeakv2_api

Weekly Downloads

331

Version

2.1.501

License

Proprietary

Unpacked Size

2.42 MB

Total Files

760

Last publish

Collaborators

  • saascentral