Skip to end of metadata
Go to start of metadata

WebPortal API

The VS.WebAPI.Admin  was designed to enable creating your own portals or integrating with your own CRM applications.

 

Icon

Default application name: PortalWebAPI

Default url at which application is installed: http://ip_address_or_dns/VS.WebAPI.Admin/

To find out what version of WebPortal API was installed enter the following url:

Icon

http://ip_address_or_dns/VS.WebAPI.Admin/api.test

In the result the version will be returned as shown on Fig 1.

To get information about each available method in the API enter the following url:

Icon

 

The WebPortal API built-in help guide provides useful information about each available method in the API. Once the url http://ip_address_or_dns/VS.WebAPI.Admin/Docs/index.html is opened a full list of methods is presented as in Fig 2. To view the details of a selected method select it from the left menu; in main window additional information will be shown as in the example method in Fig 3.

The example method AdminGetTariffName (Fig 3) provides information about the list of available attributes in the Members tag:

  • CurrencyId
  • Name
  • PageOffset
  • PageSize

In Remarks it provides information that the method returns: Return tariffs. Also, requirements are shown: Require admin authentication.

The service allows you to communicate in HTTP POST and for selected methods in GET. It is recommended to use JSon format. To access API methods authorization is required. An API client can log in to each method separately or to use session information. Login by default is turned on with passwords hashed in SHA1. The account for authorization is taken from VSM module Users as shown in Fig 4. To pass login information it is required to add the #admin suffix, e.g api_login#admin.

 

List of all methods available for:

Icon
 ApiPortal - user level

VoipSwitch WebPortal API
VS.PortalWebAPI.API Namespace
VoipSwitch WebPortal API version 3.0.0
Types
All Types Classes Enumerations
Icon Type Description
AddPlan
Represents WebAPI AddPlan method available at PortalWebAPI/client.plans.add

Add/Buy selected plan to logged client


AddPlanResponse
AddPlan method response see more AddPlan

AniNumber
Represents Ani Number

BeforeConnectionRule
Represents Before Connection Answering Call Rule

BranchItem
The Branch Item

CabinCall
Represents Callshop Cabin Call Object

CabinTariffRate
Represents Cabin Tariff Rate Object

Call
Represents Call Object

CallshopCabin
Represents Callshop Cabin Client

CallshopCall
Represents Callshop Call Object

CallshopCallState
The Call State

CallshopCurrentCall
Represents Callshop Current Call

ChangePassword
Represents WebAPI ChangePassword method available at PortalWebAPI/ChangePassword

ChangePasswordResponse
ChangePassword method response see more ChangePassword

ClientDID
Represents Client DID Object

ClientPlanPack
The client PlanPack

ContactGroupItem
The Contact Group

ContactItem
The contact Item

ConvertFileToGreeting
Represents WebAPI ConvertFileToGreeting method available at PortalWebAPI/client.convert.file.to.greeting

ConvertFileToGreetingResponse
ConvertFileToGreeting method response see more ConvertFileToGreeting

ConvertVoiceMail
Convert Voicemail to MP3 method available at PortalWebAPI/ConvertVoiceMail

ConvertVoiceMailResponse
ConvertVoiceMail method response see more ConvertVoiceMail

CreateCallbackCall
Represents WebAPI CreateCallbackCall method available at PortalWebAPI/client.callback.create

CreateCallbackCallResponse
CreateCallbackCall method response see more CreateCallbackCall

CustomEntry
The contact custom entry

DeleteAniNumber
Represents WebAPI DeleteAniNumber method available at PortalWebAPI/client.ani.delete

DeleteAniNumberResponse
DeleteAniNumber method response see more RechargeByPin

DeleteAnsweringRule
Represents WebAPI DeleteAnsweringRule method available at PortalWebAPI/DeleteAnsweringRule

DeleteAnsweringRuleResponse
DeleteAnsweringRule method response see more DeleteAnsweringRule

DeleteCallshopTariffRate
Represents WebAPI DeleteCallshopTariffRate method available at PortalWebAPI/DeleteCallshopTariffRate

DeleteCallshopTariffRateResponse
DeleteCallshopTariffRateResponse method response see more DeleteCallshopTariffRateResponse

DeleteContact
Represents WebAPI DeleteContact method available at PortalWebAPI/client.contacts.delete

Delete client contact


DeleteContactResponse
DeleteContact method response see more DeleteContact

DeleteContactsGroup
Represents WebAPI DeleteContactsGroup method available at PortalWebAPI/client.contacts.group.delete

Delete contacts group


DeleteContactsGroupResponse
DeleteContactsGroup method response see more DeleteContactsGroup

DeleteMusicOnHold
Represents WebAPI DeleteMusicOnHold method available at PortalWebAPI/client.musiconhold.delete

DeleteMusicOnHoldResponse
DeleteMusicOnHold method response see more DeleteMusicOnHold

DeleteQuickCalling
Represents WebAPI DeleteQuickCalling method available at PortalWebAPI/client.quickcalling.update

DeleteQuickCallingResponse
DeleteQuickCalling method response see more DeleteQuickCalling

DeleteSpeedial
Represents WebAPI DeleteSpeedial method available at PortalWebAPI/client.speedial.delete

DeleteSpeedialResponse
DeleteSpeedial method response see more DeleteSpeedial

DeleteVoiceMail
Represents WebAPI DeleteVoiceMail method available at PortalWebAPI/DeleteVoiceMail

DeleteVoiceMailResponse
DeleteVoiceMail method response see more DeleteVoiceMail

DownloadCallshopInvoice
Download generated Callshop Invoices

DownloadInvoice
Download client invoice

DownloadVoiceMail
Download converteted Voicemail to MP3

GenerateCallshopInvoice
Represents WebAPI GenerateCallshopInvoice method available at PortalWebAPI/GenerateCallshopInvoice

GenerateCallshopInvoiceResponse
GenerateCallshopInvoice method response see more GenerateCallshopInvoice

GetAniNumbers
Represents WebAPI GetAniNumbers method available at PortalWebAPI/GetAniNumbers

GetAniNumbersResponse
GetAniNumbers method response see more GetAniNumbers

GetAnsweringRules
Represents WebAPI GetAnsweringRules method available at PortalWebAPI/GetAnsweringRules

GetAnsweringRulesResponse
GetAnsweringRules method response see more GetAnsweringRules

GetCallerId
Represents WebAPI GetCallerId method available at PortalWebAPI/client.callerid.get

GetCallerIdResponse
GetCallerId method response see more GetCallerId

GetCalls
Represents WebAPI GetCalls method available at PortalWebAPI/GetCalls

GetCallshopCabins
Represents WebAPI GetCallshopCabins method available at PortalWebAPI/GetCallshopCabins

GetCallshopCabinsCalls
Represents WebAPI GetCalls method available at PortalWebAPI/GetCalls

GetCallshopCabinsCallsResponse
GetCallshopCabinsCalls method response see more GetCallshopCabinsCalls

GetCallshopCabinsResponse
GetCallshopCabinsResponse method response see more GetCallshopCabins

GetCallshopCabinTariffRates
Represents WebAPI GetCallshopCabinTariffRates method available at PortalWebAPI/GetCallshopCabinTariffRates

GetCallshopCabinTariffRatesResponse
GetCallshopCabinTariffRates method response see more GetCallshopCabinTariffRates

GetCallshopCalls
Represents WebAPI GetCallshopCalls method available at PortalWebAPI/GetCallshopCalls

GetCallshopCallsResponse
GetCallshopCalls method response see more GetCallshopCalls

GetCallshopCallsSummary
Represents WebAPI GetCallshopCallsSummary method available at PortalWebAPI/GetCallshopCallsSummary

GetCallshopCallsSummaryResponse
GetCallshopCallsSummary method response see more GetCallshopCallsSummary

GetCallshopCurrentCalls
Represents WebAPI GetCallshopCurrentCalls method available at PortalWebAPI/GetCallshopCurrentCalls

GetCallshopCurrentCallsResponse
GetCallshopCurrentCalls method response see more GetCallshopCurrentCalls

GetCallshopTariffTimespanEnable
Represents WebAPI GetCallshopTariffTimespanEnable method available at PortalWebAPI/GetCallshopTariffTimespanEnable

GetCallshopTariffTimespanEnableResponse
GetCallshopTariffTimespanEnable method response see more GetCallshopTariffTimespanEnable

GetCallsResponse
GetCalls method response see more GetCalls

GetClientDIDs
Represents WebAPI GetClientDIDs method available at PortalWebAPI/GetClientDIDs

GetClientDIDsResponse
GetClientDIDs method response see more GetClientDIDs

GetClientPersonal
Represents WebAPI GetClientPersonal method available at PortalWebAPI/GetClientPersonal

GetClientPersonalResponse
GetClientPersonal method response see more GetClientPersonal

GetContacts
Represents WebAPI GetContacts method available at PortalWebAPI/client.contacts.get

Return client contacts


GetContactsGroup
Represents WebAPI GetContactsGroup method available at PortalWebAPI/client.contacts.group.get

Return client contacts groups


GetContactsGroupResponse
GetContacts method response see more GetContactsGroup

GetContactsResponse
GetContacts method response see more GetContacts

GetCountries
Represents WebAPI GetCountries method available at PortalWebAPI/GetCountries

GetCountriesResponse
GetCountries method response see more GetCountries

GetGreetings
Represents WebAPI GetGreetings method available at PortalWebAPI/GetGreetings

GetGreetingsResponse
GetGreetings method response see more GetGreetings

GetInvoiceCustomFields
Represents WebAPI GetInvoiceCustomFields method available at PortalWebAPI/client.invoices.customfields.get

GetInvoiceCustomFieldsResponse
GetInvoiceCustomFields method response see more GetInvoiceCustomFields

GetInvoices
Represents WebAPI GetInvoices method available at PortalWebAPI/GetInvoices

GetInvoicesResponse
GetInvoices method response see more GetInvoices

GetMissedCalls
Represents WebAPI GetMissedCalls method available at PortalWebAPI/GetMissedCalls

GetMissedCallsResponse
GetMissedCalls method response see more GetMissedCalls

GetMobileTopUpHistory
Represents WebAPI GetPbxCompanyContacts method available at PortalWebAPI/client.mtu.history.get

Return PBX Contacts created from Company Users


GetMobileTopUpHistoryResponse
GetMobileTopUpHistory method response see more GetMobileTopUpHistory

GetMusicOnHold
Represents WebAPI GetMusicOnHold method available at PortalWebAPI/client.musiconhold.get

GetMusicOnHoldResponse
GetMusicOnHoldResponse method response see more GetMusicOnHold

GetPayments
Represents WebAPI GetPayments method available at PortalWebAPI/GetPayments

GetPaymentsResponse
GetPayments method response see more GetPayments

GetPbxBranches
Represents WebAPI GetPbxBranches method available at PortalWebAPI/client.pbx.branches.list

Return logged in PBX Branches


GetPbxBranchesResponse
GetPbxBranches method response see more GetPbxBranches

GetPbxCompanyContacts
Represents WebAPI GetPbxCompanyContacts method available at PortalWebAPI/client.pbx.companycontacts.get

Return PBX Contacts created from Company Users


GetPbxCompanyContactsResponse
GetPbxCompanyContacts method response see more GetPbxCompanyContacts

GetPbxCompanyStructure
Represents WebAPI GetPbxCompanyStructure method available at PortalWebAPI/client.pbx.structure.list

Return pbx company structure groups


GetPbxCompanyStructureResponse
GetPbxCompanyStructure method response see more GetPbxCompanyStructure

GetPlanInfo
Represents WebAPI GetPlanInfo method available at PortalWebAPI/client.plans.info

Return selected plan info


GetPlanInfoResponse
GetPlanInfo method response see more GetPlanInfo

GetPlanPack
Represents WebAPI GetPlanPack method available at PortalWebAPI/client.planpack.get

GetPlanPackList
Represents WebAPI GetPlanPackList method available at PortalWebAPI/client.planpacks.list

GetPlanPackListResponse
GetPlanPackList method response see more GetPlanPackList

GetPlanPackResponse
GetPlanPack method response see more GetPlanPack

GetPlans
Represents WebAPI GetPlans method available at PortalWebAPI/client.plans.get

Return plans client have purchased


GetPlansList
Represents WebAPI GetPlanList method available at PortalWebAPI/client.plans.list

Return plans client can order


GetPlansListResponse
GetPlansList method response see more GetPlansList

GetPlansResponse
GetPlans method response see more GetPlans

GetQuickCallingList
Represents WebAPI GetQucikCalling method available at PortalWebAPI/client.quickcalling.list

Return logged client quick calling list


GetQuickCallingListResponse
GetQuickCallingList method response see more GetQuickCallingList

GetQuickCallingNumbers
Represents WebAPI GetQuickCallingNumbers method available at PortalWebAPI/client.quickcalling.list

Return logged client numbers mark for QuickCalling matching logged client Lot or Resller


GetQuickCallingNumbersResponse
GetQuickCallingNumbers method response see more GetQuickCallingNumbers

GetReferralKey
Represents WebAPI GetReferralKey method available at PortalWebAPI/client.referral.get

GetReferralKeyResponse
GetReferralKey method response see more GetReferralKey

GetSmsInbox
Represents WebAPI GetSmsInbox method available at PortalWebAPI/client.sms.inbox.list

GetSmsInboxResponse
GetSmsInbox method response see more GetSmsInbox

GetSmsOutbox
Represents WebAPI GetSmsOutbox method available at PortalWebAPI/client.sms.outbox.list

GetSmsOutboxResponse
GetSmsOutbox method response see more GetSmsOutbox

GetSpeedials
Represents WebAPI GetSpeedials method available at PortalWebAPI/client.speedial.list

GetSpeedialsResponse
GetPayments method response see more GetSpeedials

GetTariffRates
Represents WebAPI GetTariffRates method available at PortalWebAPI/GetTariffRates

GetTariffRatesResponse
GetTariffRates method response see more GetTariffRates

GetTopRatesList
Represents WebAPI GetTopRatesList method available at PortalWebAPI/client.portal.toprates

Return TopRates added in portal


GetTopRatesListResponse
GetTopRatesList method response see more GetTopRatesList

GetTransactionHistory
Represents WebAPI GetTransactionHistory method available at PortalWebAPI/client.transactionhistory.list

GetTransactionHistoryResponse
GetTransactionHistory method response see more GetTransactionHistory

GetVersion
Represents WebAPI GetVersion method available at PortalWebAPI/GetVersion

GetVersionResponse
GetVersion method response see more GetVersion

GetVoiceMails
Represents WebAPI GetVoiceMails method available at PortalWebAPI/GetVoiceMails

GetVoiceMailsResponse
GetVoiceMails method response see more GetVoiceMails

GetVoiceMailsSummary
Represents WebAPI GetVoiceMailsSummary method available at PortalWebAPI/GetVoiceMailsSummary

GetVoiceMailsSummaryResponse
GetVoiceMailsSummary method response see more GetVoiceMailsSummary

ImEntry
The contact im entry

Invoice
Represents Invoice Object

LogOn
Represents WebAPI LogOn method available at PortalWebAPI/LogOn

LogOnResponse
LogOn method response see more LogOn

LogOut
Represents WebAPI LogOut method available at PortalWebAPI/LogOut

LogOutResponse
LogOut method response see more LogOut

MissedCall
Represents Missed Call Object

MobileTopUpHistory
The mobile top history item

Payment
Represents Payment Object

PbxCompanyContact
The PBX Company Contact

PbxCompanyItem
The Pbx Company Struture

PhoneEntry
The contact phone entry

PlanInfo
The Plan Info

PlanItem

The Plan Entity


PlanPack
The PlanPack Entity

PlanPackPeriod
The plan pack period

PlanPeriod
The Plan Period types

PortalTopRateItem
The Portal Top Rate Tariff

QuickCallingItem
The QuickCalling Item

QuickCallingNumber
The Quick Callint DID number assigned to resller / lot

QuickCallingNumberAssign
The QuickCalling Type Filter

RechargeByPin
Represents WebAPI RechargeByPin method available at PortalWebAPI/client.recharge.pin

RechargeByPinResponse
RechargeByPin method response see more RechargeByPin

SendNewPasswordStatus
The password reset status response code

SendNewPasswordToEmail
Represents WebAPI SendNewPasswordToEmail method available at PortalWebAPI/client.password.reset

SendNewPasswordToEmailResponse
SendNewPasswordToEmail method response see more SendNewPasswordToEmail

SendPasswordReminder
Represents WebAPI SendPasswordReminder method available at PortalWebAPI/SendPasswordReminder

SendPasswordReminderResponse
SendPasswordReminder method response see more SendPasswordReminder

SendPasswordReminderType
The Send Password Reminder Type

SetAllCabinActiveState
Represents WebAPI SetAllCabinActiveState method available at PortalWebAPI/SetAllCabinActiveState

SetAllCabinActiveStateResponse
SetAllCabinActiveState method response see more SetAllCabinActiveState

SetCallerId
Represents WebAPI SetCallerId method available at PortalWebAPI/client.callerid.set

SetCallerIdResponse
SetCallerId method response see more SetCallerId

SetCallshopCallsOld
Represents WebAPI SetCallshopCallsOld method available at PortalWebAPI/SetCallshopCallsOld

SetCallshopCallsOldResponse
SetCallshopCallsOld method response see more SetCallshopCallsOld

SetMusicOnHold
Represents WebAPI SetMusicOnHold method available at PortalWebAPI/client.musiconhold.set

SetMusicOnHoldResponse
SetMusicOnHold method response see more SetMusicOnHold

SetPlanPack
Represents WebAPI SetPlanPack method available at PortalWebAPI/client.planpack.set

SetPlanPackResponse
SetPlanPack method response see more SetPlanPack

SetSelectedCabinActiveState
Represents WebAPI SetSelectedCabinActiveState method available at PortalWebAPI/SetSelectedCabinActiveState

SetSelectedCabinActiveStateResponse
SetSelectedCabinActiveState method response see more SetSelectedCabinActiveState

SmsInboxItem
The sms inbox item

SmsOutboxItem
The SMS Outbox item

Speedial
The client speedial

TariffRate
Represents Tariff Rate Object

Test
Represents WebAPI Test method available at PortalWebAPI/api.test

TestResponse
TestResponse method response see more Test

TransactionHistory
The transaction history entity

TransactionHistoryStatus
The transaction status

TransactionHistoryType
The transaction types

UnSuccessfullRule
Represents UnSuccessfull Answering Call Rule

UpdateAniNumber
Represents WebAPI UpdateAniNumber method available at PortalWebAPI/client.ani.update

UpdateAniNumberResponse
UpdateAniNumber method response see more UpdateAniNumber

UpdateAnsweringRule
Represents WebAPI UpdateAnsweringRule method available at PortalWebAPI/UpdateAnsweringRule

UpdateAnsweringRuleResponse
UpdateAnsweringRule method response see more UpdateAnsweringRule

UpdateCallshopTariffRate
Represents WebAPI UpdateCallshopTariffRate method available at PortalWebAPI/UpdateCallshopTariffRate

UpdateCallshopTariffRateResponse
UpdateCallshopTariffRate method response see more UpdateCallshopTariffRate

UpdateClientPersonal
Represents WebAPI UpdateClientPersonal method available at PortalWebAPI/UpdateClientPersonal

UpdateClientPersonalResponse
UpdateClientPersonal method response see more UpdateClientPersonal

UpdateContact
Represents WebAPI UpdateContact method available at PortalWebAPI/client.contacts.update

Save/Update client contact


UpdateContactResponse
UpdateContact method response see more UpdateContact

UpdateContactsGroup
Represents WebAPI UpdateContactsGroup method available at PortalWebAPI/client.contacts.group.get

Add/Update contacts group


UpdateContactsGroupResponse
UpdateContactsGroup method response see more UpdateContactsGroup

UpdateInvoiceCustomFields
Represents WebAPI UpdateInvoiceCustomFields method available at PortalWebAPI/client.invoices.customfields.update

UpdateInvoiceCustomFieldsResponse
UpdateInvoiceCustomFields method response see more UpdateInvoiceCustomFields

UpdateQuickCalling
Represents WebAPI UpdateSpeedial method available at PortalWebAPI/client.quickcalling.update

Add or Update logged in client qucikcallint item


UpdateQuickCallingResponse
UpdateQuickCalling method response see more UpdateQuickCalling

UpdateSpeedial
Represents WebAPI UpdateSpeedial method available at PortalWebAPI/client.speedial.update

UpdateSpeedialResponse
UpdateSpeedialResponse method response see more UpdateSpeedial

UploadGreeting
Upload greeting wav file for client and convert to voip codec

UploadGreetingResponse

UploadGreetingResponseCode
The upload greetings response code

VoiceMail
The Voicemail Object

 ApiAdmin - admin level

VoipSwitch WebAPI (Admin)

VS.WebAPI version 3.0.2
Types
All Types Classes Enumerations
Icon Type Description
AdminAddClientPayment
Represents WebAPI AdminAddClientPayment method available at PortalWebAPI/admin.payment.add

AdminAddClientPaymentResponse
AdminAddClientPayment method response see more AdminAddClientPayment

AdminAddPlan
Represents WebAPI AdminAddPlan method available at PortalWebAPI/admin.plan.add

AdminAddPlanResponse
AdminAddPlan method response

AdminAddRetailClientPayment
Represents WebAPI AdminAddRetailClientPayment method available at PortalWebAPI/admin.retail.payment.add

AdminAddRetailClientPaymentResponse
AdminAddRetailClientPayment method response see more AdminAddRetailClientPayment

AdminCallItem
The admin call query result

AdminCheckLogin
Represents WebAPI AdminCheckLogin method available at PortalWebAPI/admin.client.check.login

AdminCheckLoginResponse
AdminCheckLogin method response see more AdminCheckLogin

AdminCheckNumberAssinged
Represents WebAPI AdminCheckNumberAssinged method available at PortalWebAPI/AdminCheckNumberAssinged

AdminCheckNumberAssingedResponse
AdminCheckNumberAssinged method response see more AdminCheckNumberAssinged

AdminClientCheckStatus
Represents WebAPI AdminClientCheckStatus method available at PortalWebAPI/admin.client.check

AdminClientCheckStatusResponse
AdminClientCheckStatus method response see more AdminClientCheckStatus

AdminCreateCallbackAccount
Represents WebAPI AdminCreateCallbackAccount method available at PortalWebAPI/admin.callback.create

AdminCreateCallbackAccountResponse
AdminCreateCallbackAccount method response see more AdminCreateCallbackAccount

AdminCreateCallshopAccount
Represents WebAPI AdminCreateCallshopAccount method available at PortalWebAPI/admin.callshop.create

AdminCreateCallshopAccountResponse
AdminCreateCallshopAccount method response see more AdminCreateCallshopAccount

AdminCreateGateway
Represents WebAPI AdminCreateGateway method available at PortalWebAPI/admin.gateways.create

AdminCreateGatewayResponse
AdminCreateGateway method response see more AdminCreateGateway

AdminCreateGKRegistrar
Represents WebAPI AdminCreateGKRegistrar method available at PortalWebAPI/admin.gkregistrar.create

AdminCreateGKRegistrarResponse
AdminCreateGKRegistrar method response see more AdminCreateGKRegistrar

AdminCreateIvrAccount
Represents WebAPI AdminCreateIvrAccount method available at PortalWebAPI/admin.ivr.create

AdminCreateIvrAccountResponse
AdminCreateIvrAccount method response see more AdminCreateIvrAccount

AdminCreateMusicOnHold
Represents WebAPI AdminCreateMusicOnHold method available at PortalWebAPI/AdminCreateMusicOnHold

AdminCreateMusicOnHoldResponse
AdminCreateMusicOnHold method response see more AdminCreateMusicOnHold

AdminCreatePBXAccount
Represents WebAPI AdminCreatePBXAccount method available at PortalWebAPI/AdminCreatePBXAccount

AdminCreatePBXAccountResponse
AdminCreatePBXAccount method response see more AdminCreatePBXAccount

AdminCreatePBXSubAccountList

Represents WebAPI AdminCreatePBXSubAccountList method available at PortalWebAPI/AdminCreatePBXSubAccountList

Create new pbx subaccount from list


AdminCreatePBXSubAccountListResponse
AdminCreatePBXSubAccountList method response see more AdminCreatePBXSubAccountList

AdminCreateRetailAccount
Represents WebAPI AdminCreateRetailAccount method available at PortalWebAPI/AdminCreateRetailAccount

AdminCreateRetailAccountResponse
AdminCreateRetailAccount method response see more AdminCreateRetailAccount

AdminCreateWholeSaleClient
Represents WebAPI AdminCreateWholeSaleClient method available at PortalWebAPI/admin.wholesale.clients.create

AdminCreateWholeSaleClientResponse
AdminCreateWholeSaleClient method response see more AdminCreateWholeSaleClient

AdminDeleteClient
Represents WebAPI AdminDeleteClient method available at PortalWebAPI/admin.client.delete

AdminDeleteClientAni
Represents WebAPI AdminDeleteClientAni method available at PortalWebAPI/admin.client.ani.delete

AdminDeleteClientAniResponse

AdminDeleteClientPlanPacks
Represents WebAPI AdminDeleteClientPlanPacks method available at PortalWebAPI/admin.planpacks.client.delete

AdminDeleteClientPlanPacksResponse
AdminGetPlanPacks method response see more AdminGetPlanPacks

AdminDeleteClientResponse
AdminDeleteClient method response see more AdminGetClientByAni

AdminDeletePlan
Represents WebAPI AdminDeletePlan method available at PortalWebAPI/admin.plan.delete

AdminDeletePlanResponse
AdminDeletePlan method response

AdminDownloadClientInvoice
Download client Invoice PDF

AdminGenerateLogin
Represents WebAPI AdminGetBallance method available at PortalWebAPI/admin.client.generate.login

AdminGenerateLoginResponse
AdminGeneratePassword method response see more AdminGenerateLogin

AdminGetBallance
Represents WebAPI AdminGetBallance method available at PortalWebAPI/admin.client.balance

AdminGetBallanceResponse
AdminGetBallanceResponse method response see more AdminGetBallance

AdminGetCallbackClients
Represents WebAPI AdminGetCallbackClients method available at PortalWebAPI/admin.callback.clients.list

AdminGetCallbackClientsResponse
AdminGetCallbackClients method response see more AdminGetCallbackClients

AdminGetCalls
Represents WebAPI AdminGetCalls method available at PortalWebAPI/admin.calls.list

AdminGetCallshopClients
Represents WebAPI AdminGetCallshopClients method available at PortalWebAPI/admin.callshop.clients.list

AdminGetCallshopClientsResponse
AdminGetCallshopClients method response see more AdminGetCallshopClients

AdminGetCallsLimit
Represents WebAPI AdminGetCallsLimit method available at PortalWebAPI/admin.callslimit.get

AdminGetCallsLimitResponse
AdminGetCallsLimit method response see more AdminGetCallsLimit

AdminGetCallsResponse
AdminGetCallsResponse method response see more AdminGetCalls

AdminGetClientActive
Represents WebAPI AdminGetClientActive method available at PortalWebAPI/admin.client.status.set

AdminGetClientActiveResponse
AdminGetClientActive method response see more AdminGetClientActive

AdminGetClientByAni
Represents WebAPI AdminGetClientByAni method available at PortalWebAPI/admin.client.getby.ani

AdminGetClientByAniResponse
AdminGetClientByAni method response see more AdminGetClientByAni

AdminGetClientCodecs
Represents WebAPI AdminGetClientCodecs method available at PortalWebAPI/admin.client.codecs.get

AdminGetClientCodecsResponse
AdminGetClientCodecs method response see more AdminGetClientCodecs

AdminGetClientDIDs
Represents WebAPI AdminGetClientDIDs method available at PortalWebAPI/AdminGetClientDIDs

AdminGetClientDIDsResponse
AdminGetClientDIDs method response see more AdminGetClientDIDs

AdminGetClientFaxTasks
Represents WebAPI AdminGetClientFaxTasks method available at PortalWebAPI/AdminGetClientFaxTasks

AdminGetClientFaxTasksResponse
AdminGetClientFaxTasks method response see more AdminGetClientFaxTasks

AdminGetClientInvoices
Represents WebAPI AdminGetClientInvoices method available at PortalWebAPI/admin.invoices.list

AdminGetClientInvoicesResponse
AdminGetClientInvoices method response see more AdminGetClientInvoices

AdminGetClientPassword
Represents WebAPI AdminGetClientPassword method available at PortalWebAPI/admin.client.password.get

AdminGetClientPasswordResponse
AdminGetClientPassword method response see more AdminGetClientPassword

AdminGetClientPayments
Represents WebAPI AdminGetClientPayments method available at PortalWebAPI/admin.payments.list

AdminGetClientPaymentsResponse
AdminGetClientPayments method response see more AdminGetClientPayments

AdminGetClientPersonal
Represents WebAPI AdminGetRetailClientPersonal method available at PortalWebAPI/AdminGetRetailClientPersonal

AdminGetClientPersonalResponse
AdminGetClientPersonal method response see more AdminGetClientPersonal

AdminGetClientPlanPacks
Represents WebAPI AdminGetClientPlanPacks method available at PortalWebAPI/admin.planpacks.client.list

AdminGetClientPlanPacksResponse
AdminGetClientPlanPacks method response see more AdminGetClientPlanPacks

AdminGetClientPrefix

Represents WebAPI AdminGetClientPrefix method available at PortalWebAPI/AdminGetClientPrefix

Return Client Prefix, only Retail or PBX Subaccount client


AdminGetClientPrefixResponse
AdminGetClientPrefix method response see more AdminGetClientPrefix

AdminGetClientReceiveFax
Represents WebAPI AdminGetClientReceiveFax method available at PortalWebAPI/AdminGetClientReceiveFax

AdminGetClientReceiveFaxResponse
AdminGetClientReceiveFax method response see more AdminGetClientReceiveFax

AdminGetClientRetail
Represents WebAPI AdminGetClientRetail method available at PortalWebAPI/admin.retail.get

AdminGetClientRetailResponse
AdminGetClientRetail method response see more AdminGetClientRetail

AdminGetClientsListByAni
Represents WebAPI AdminGetClientsListByAni method available at PortalWebAPI/admin.client.list.getby.ani

AdminGetClientsListByAniItem
The client list found by ani item

AdminGetClientsListByAniResponse
AdminGetClientsListByAni method response see more AdminGetClientsListByAni

AdminGetCodecs
Represents WebAPI AdminGetCodecs method available at PortalWebAPI/admin.codecs.list

AdminGetCodecsResponse
AdminGetCodecs method response see more AdminGetCodecs

AdminGetCountries
Represents WebAPI AdminGetCountries method available at PortalWebAPI/admin.countries.list

AdminGetCountriesResponse
AdminGetCountries method response see more AdminGetCountries

AdminGetCurrencies
Represents WebAPI AdminGetClientAniNumbers method available at PortalWebAPI/AdminGetCurrencies

AdminGetCurrenciesResponse
AdminGetCurrencies method response see more AdminGetCurrencies

AdminGetCustomField
Represents WebAPI AdminGetCustomField method available at PortalWebAPI/admin.invoices.customfields.get

AdminGetCustomFieldResponse
AdminGetCustomField method response see more AdminGetCustomField

AdminGetGatewayExtend
Represents WebAPI AdminGetGatewayExtend method available at PortalWebAPI/admin.gateway.get

AdminGetGatewayExtendResponse
AdminGetGatwayExtend method response see more AdminGetGatewayExtend

AdminGetGateways
Represents WebAPI AdminGetGateways method available at PortalWebAPI/admin.gateways.list

AdminGetGatewaysResponse
AdminGetGateways method response see more AdminGetGateways

AdminGetGKRegistrarExtend
Represents WebAPI AdminGetGKRegistrarExtend method available at PortalWebAPI/admin.gkregistrar.get

AdminGetGKRegistrarExtendResponse
AdminGetGKRegistrarExtend method response see more AdminGetGKRegistrarExtend

AdminGetGKRegistrarList
Represents WebAPI AdminGKRegistrarList method available at PortalWebAPI/admin.gkregistrar.list

AdminGetGKRegistrarListResponse
AdminGetGKRegistrarList method response see more AdminGetGKRegistrarList

AdminGetGreetings
Represents WebAPI AdminGetGreetings method available at PortalWebAPI/admin.greetings.get

AdminGetGreetingsResponse
AdminGetGreetings method response see more AdminGetGreetings

AdminGetInvoiceCustomFields
Represents WebAPI AdminGetInvoiceCustomFields method available at PortalWebAPI/admin.invoices.customfields.get

AdminGetInvoiceCustomFieldsResponse
AdminGetInvoiceCustomFields method response see more AdminGetInvoiceCustomFields

AdminGetIvrClients
Represents WebAPI AdminGetIvrClients method available at PortalWebAPI/admin.ivr.clients.list

AdminGetIvrClientsResponse
AdminGetIvrClients method response see more AdminGetIvrClients

AdminGetPBXClients
Represents WebAPI AdminGetPBXClients method available at PortalWebAPI/AdminGetPBXClients

AdminGetPBXClientsResponse
AdminGetPBXClients method response see more AdminGetPBXClients

AdminGetPBXSubAccountClients
Represents WebAPI AdminGetPBXClients method available at PortalWebAPI/AdminGetPBXClients

AdminGetPBXSubAccountClientsResponse
AdminGetPBXSubAccountClients method response see more AdminGetPBXSubAccountClients

AdminGetPlan
Represents WebAPI AdminGetPlan method available at PortalWebAPI/admin.plan.get

AdminGetPlanPacks
Represents WebAPI AdminGetPlansPack method available at PortalWebAPI/admin.planpacks.list

AdminGetPlanPacksResponse
AdminGetPlanPacks method response see more AdminGetPlanPacks

AdminGetPlanResponse
AdminGetPlans method response

AdminGetPlans
Represents WebAPI AdminGetPlans method available at PortalWebAPI/admin.plans.list

AdminGetPlansResponse
AdminGetPlans method response

AdminGetRetailClients
Represents WebAPI AdminGetRetailClients method available at PortalWebAPI/admin.retail.clients.list

AdminGetRetailClientsResponse
AdminGetRetailClients method response see more AdminGetRetailClients

AdminGetTariffNames
Represents WebAPI AdminGetTariffNames method available at PortalWebAPI/admin.tariffs.list

AdminGetTariffNamesResponse
AdminGetTariffNames method response see more AdminGetTariffNames

AdminGetTariffPlans
Represents WebAPI AdminGetTariffPlans method available at PortalWebAPI/admin.tariffs.plans.list

AdminGetTariffPlansResponse
AdminGetTariffPlans method response see more AdminGetTariffPlans

AdminGetTariffRates
Represents WebAPI AdminUpdateTariffName method available at PortalWebAPI/admin.tariffs.update

AdminGetTariffRatesResponse
AdminGetTariffRates method response see more AdminGetTariffRates

AdminGetWholeSaleClients
Represents WebAPI AdminGetWholeSaleClients method available at PortalWebAPI/admin.wholesale.clients.list

AdminGetWholeSaleClientsResponse
AdminGetWholeSaleClients method response see more AdminGetWholeSaleClients

AdminImportDIDsCountries

AdminImportDIDsCountriesResponse

AdminLogOn
Represents WebAPI AdminLogOn method available at PortalWebAPI/AdminLogOn

AdminLogOnResponse
AdminLogOn method response see more AdminLogOn

AdminLogOut
Represents WebAPI AdminLogOut method available at PortalWebAPI/AdminLogOut

AdminLogOutResponse
AdminLogOut method response see more AdminLogOut

AdminLotAddClient
Represents WebAPI admin.lot.client.add method available at PortalWebAPI/admin.lot.client.add

AdminLotAddClientResponse
AdminLotAddClientResponse method response see more AdminLotAddClient

AdminLotAddRechargablePin
Represents WebAPI AdminLotAddRechargablePin method available at PortalWebAPI/admin.lot.pin.create

AdminLotAddRechargablePinResponse
AdminLotAddRechargablePin method response see more AdminLotAddRechargablePin

AdminSetAccountActive

Represents WebAPI AdminSetAccountActive method available at PortalWebAPI/AdminSetAccountActive

Activate or deactive client


AdminSetAccountActiveResponse
AdminSetAccountActive method response see more AdminSetAccountActive

AdminSetCallsLimit
Represents WebAPI AdminSetCallsLimit method available at PortalWebAPI/admin.callslimit.set

AdminSetCallsLimitResponse
AdminSetCallsLimit method response see more AdminSetCallsLimit

AdminSetClientActive
Represents WebAPI AdminSetClientActive method available at PortalWebAPI/admin.client.status.set

AdminSetClientActiveResponse
AdminSetClientActive method response see more AdminSetClientActive

AdminSetClientCodecs
Represents WebAPI AdminSetClientCodecs method available at PortalWebAPI/admin.client.codecs.set

AdminSetClientCodecsResponse
AdminSetClientCodecs method response see more AdminSetClientCodecs

AdminSetClientPassword
Represents WebAPI AdminSetClientPassword method available at PortalWebAPI/admin.client.password.set

AdminSetClientPasswordResponse
AdminSetClientPassword method response see more AdminSetClientPassword

AdminSetClientPlanPacks
Represents WebAPI AdminSetClientPlanPacks method available at PortalWebAPI/admin.planpacks.client.set

AdminSetClientPlanPacksResponse
AdminSetClientPlanPacks method response see more AdminSetClientPlanPacks

AdminSetClientPrefix

Represents WebAPI AdminSetClientPrefix method available at PortalWebAPI/AdminSetClientPrefix

Set Client Prefixes, only Retail or PBX Subaccount client


AdminSetClientPrefixResponse
AdminSetClientPrefix method response see more AdminSetClientPrefix

AdminSetCustomField
Represents WebAPI AdminSetCustomField method available at PortalWebAPI/admin.invoices.customfields.set

AdminSetCustomFieldResponse
AdminSetCustomField method response see more AdminSetCustomField

AdminUpdateClientPersonal
Represents WebAPI AdminUpdateClientPersonal method available at PortalWebAPI/admin.client.personal.update

AdminUpdateClientPersonalResponse
AdminUpdateRetailClientPersonal method response see more AdminUpdateClientPersonal

AdminUpdateInvoiceCustomFields
Represents WebAPI AdminUpdateInvoiceCustomFields method available at PortalWebAPI/admin.invoices.customfields.update

AdminUpdateInvoiceCustomFieldsResponse
AdminUpdateInvoiceCustomFields method response see more AdminUpdateInvoiceCustomFields

AdminUpdatePlan
Represents WebAPI AdminAddPlan method available at PortalWebAPI/admin.plan.update

AdminUpdatePlanResponse
AdminAddPlan method response

AdminUpdateTariffName
Represents WebAPI AdminUpdateTariffName method available at PortalWebAPI/admin.tariffs.update

AdminUpdateTariffNameResponse
AdminUpdateTariffName method response see more AdminUpdateTariffName

AdminUpdateTariffRate
Represents WebAPI AdminUpdateTariffName method available at PortalWebAPI/admin.tariffs.update

AdminUpdateTariffRateResponse
AdminUpdateTariffRate method response see more AdminUpdateTariffRate

CallbackClient
The Client Callback Data

CallshopClient
The Client Callshop Data

CallshopInvoiceSetting
The callshop invoice setting

ClientDIDItem
The client DID

ClientFaxTask
The Client Fax Task Entity

ClientInvoice
Represents Invoice Object

ClientPayment
Represents Payment Object

ClientPaymentPaymentType
The client Payment Type

ClientPlanPackItem
The Client plan pack item

ClientReceiveFax
The Fax Receive Entity

Currency
Represent Currency

FaxTaskStatus
The Fax Task Statuses

GatewayDeviceType
The Gateway Device Type

GatewayItem
The Gateway Item

GatewayItemExtend
Gateway + Codecs

GKRegistrarItem
The GK Registratr Item

GKRegistrarItemExtend
GKRegistart + codecs

GKRegistrarType
The GKRegistrar Type

IvrClient
The Client IVR Data

PBXClientItem
The PBX Client record item

PBXCreateSubAccountItem
Add/Update PBX SubAccount entity

PBXSubAccountItem
The PBX SubAccount Client

PBXSubAccountStatus
Adding subaccount status

PlanAddPlan

PlanDeletePlan

PlanItemExt

PlanListItem

PlanUpdatePlan

RetailClient
The Client Retail Data

TariffName
The Tariff Object

TariffPlanItem
The Tariff Plan Item

TariffRateAddPlan
The TariffRateAddPlan Entity

TariffRateGetPlan

TariffRateItem
The Tariff Rate Item

TariffRateLabel
The TariffRateLabel Entity

TariffRateUpdatePlan

WholeSaleClient
The Client Wholesale Data

Various examples of usage:

  1. PHP - Zend:

  2. PHP - Drupal:

  3. C#:

    Basic authentification using header Authorization and Base64 encoding with RestSharp
    Example with C# library RestClient from ServiceStack.Common (http://servicestack.net/)
    Calculating SHA1 example
  4. HTTP (fiddler):

    Request
    Response
  5. PHP (Without frameworks):

    Admin Login
    Get Tariffs Names
  6. Soap 1.2 in PHP (Not recommended, better use JSon):

     

     

     

See also

 

 

Figures

Click on a thumbnail to enlarge image


 
Fig. 1 - How to check WebPortal API versions


 
Fig. 2 - Full list of available methods


 
Fig. 3 - Details of selected method


 
Fig. 4 - API account information for authentication

 
 
  • No labels