Mercurius API
Parlacom API reference
Every Parlacom service — voice, PBX, DIDs, VoIP/M2M PINs, SMS, GPS and UPC — is exposed through a single HTTP endpoint. Pick a function, send the parameters, receive an XML/JSON response. All 82 endpoints share the conventions below.
Base URL
base url
https://www.parlacom.net/cgi-bin/parlaEvery call selects an endpoint through the function parameter, and works with either GET (query string) or POST (form-urlencoded).
Authentication
Call login → receive sessionid. Pass sessionid on later calls, or fall back to admin + adminpwd on every request.
Output format
output_type=json returns XML (renamed json), output_type=html returns the same view the web UI renders.
Errors
Every response includes <errorcode>. 0 = success; any other value indicates a failure — see the error code list.
Sessions
sessionid stays valid while the app timeout has not elapsed. If it expires the next call returns an error and you must login again.
Quick start
Request (GET)
GET https://www.parlacom.net/cgi-bin/parla?function=login &company=parla &output_type=json &user=clovis1234 &password=s3cretResponse (XML)
<?xml version="1.0" encoding="UTF-8"?>
<response>
<errorcode>0</errorcode>
<sessionid>617310111715966...</sessionid>
<expires>3600</expires>
</response>All endpoints
User Functions & Bank
User Accounts
- POST
loginUser LoginAuthenticate and obtain a sessionid. - POST
logoutUser LogoutInvalidate the current sessionid. - GET
refreshidSessionID RefreshExtend session expiration. - GET
validateauthValidate SessionID AuthCheck whether a sessionid is valid. - GET
getallusersGet all available UsersList every user under the admin's hierarchy. - POST
adduserAdd new userCreate a new user under the admin. - POST
deluserDelete existing userRemove a user from the hierarchy. - POST
changeuserChange existing userUpdate user profile fields. - GET
getuserGet User InfoFetch a single user's details.
Bank Account & Invoices
- GET
getbankGet Bank BalanceReturn the login's monetary balance. - GET
getbankstatementGet Bank StatementReturn all bank transactions for a period. - POST
transferbankTransfer Bank BalanceTransfer credit between accounts. - GET
getsmsbankGet SMS Bank BalanceReturn SMS credit balance. - GET
getsmsbankstatementGet SMS Bank StatementReturn SMS bank transactions. - POST
transfersmsbankTransfer SMS Bank BalanceTransfer SMS credit between accounts. - GETPOST
logsmsbankLog SMS Bank ActivityPost a manual entry into the SMS bank log. - GETPOST
invoiceInvoice CDR for LoginGenerate an invoice from CDRs for a login.
Virtual PBX & Call Center
Extensions
- POST
addextensionAdd ExtensionCreate a new PBX extension. - POST
changeextensionChange ExtensionUpdate PBX extension settings. - GET
getuserextensionGet ExtensionFetch a PBX extension configuration. - POST
changesegualiChange SegualiUpdate follow-me / seguali routing rules. - GET
getrealtimestatusPBX Service StatusReal-time status of the PBX service.
Conferences, IVR, Queues, Dialer
- POST
addconferenceAdd ConferenceCreate a conference room. - POST
changeconferenceChange ConferenceUpdate a conference room. - GET
getuserconferenceGet ConferenceReturn a conference room configuration. - POST
addpbxAdd PBXCreate an IVR / auto attendant. - POST
changepbxChange PBXUpdate an IVR / auto attendant. - GET
getuserpbxGet PBXFetch an IVR / auto attendant. - POST
addqueueAdd QueueCreate a call queue. - POST
adddialerAdd DialerCreate a predictive dialer campaign. - POST
sendphonesSend Phones to DialerUpload a phone list to a dialer campaign. - GET
searchrecSearch for audio recordingLocate call recordings by criteria. - GET
getdialerstatusGet Dialer Status from RECIDReturn the status of a dialer record.
Public Number (DID)
- GET
getdidcountriesGet Country ListReturn DID-supported countries. - GET
getdidlocationsGet DID LocationsReturn DID locations for a country. - GET
getdidslistGet List of DIDsReturn the login's DIDs. - POST
adddidAdd DIDProvision a new DID. - POST
changedidChange DIDUpdate DID routing. - GET
getuserdidGet DIDFetch one DID configuration.
PIN — VoIP (ServiceID = 2)
PIN Functions
- POST
addpinAdd PINCreate a VoIP PIN (ServiceID = 2). - POST
delpinDel PINDelete a VoIP PIN. - GET
getpinbalanceGet PIN BalanceReturn current PIN balance. - GET
getpindailybalanceGet PIN Daily BalanceReturn PIN balance day-by-day. - POST
changepinbalanceChange PIN BalanceAdd or remove credit from a PIN. - POST
resetpinbalanceReset PIN BalanceReset a PIN's balance to zero. - POST
changepinplansChange PIN PlansAssign rate plans to a PIN. - POST
changepintrafficChange PIN TrafficChange allowed traffic destinations. - POST
changepinlimitChange PIN Credit LimitUpdate the PIN's credit limit.
PIN CallerID Functions
- POST
addpincalleridAdd CallerID to PINBind a CallerID to a PIN. - POST
delpincalleridDelete CallerID from PINRemove a CallerID from a PIN. - GET
getpincalleridGet CallerIDs from PINList CallerIDs bound to a PIN. - GET
findpinfromcidFind PIN from CallerIDReverse lookup: find a PIN by CallerID. - GET
findpinfromiccidFind PIN from ICCIDReverse lookup: find a PIN by SIM ICCID. - GET
checkpincalleridCheck if CallerID existsVerify whether a CallerID is registered.
PIN CDR Data
- GET
getpincdrGet PIN CDRReturn raw CDR rows for a PIN. - GET
getpinbillGet PIN BillReturn a billed summary for a PIN. - GET
getpincdrhtmlGet PIN CDR (HTML)Return the CDR as an HTML report. - GET
getlogincdrGet Login/Agent CDRReturn CDR rows for a login or agent. - GET
getagentstatsGet Agent StatsReturn call-center agent statistics.
PIN — M2M (ServiceID = 20)
M2M Functions
- POST
addpinmvnoAdd PIN (M2M)Create an M2M PIN (ServiceID = 20). - POST
delpinmvnoDel PIN (M2M)Delete an M2M PIN. - GETPOST
editpingeoEdit PIN Geo LocationUpdate stored geolocation for a PIN. - POST
moveserviceTransfer ServiceMove an M2M service between logins. - GETPOST
pinsonlinePINs OnlineList currently online M2M PINs. - GET
showlastcarrierM2M Last CarrierReturn the last carrier a SIM used. - POST
setjasperstatusSet Jasper StatusSet Jasper lifecycle status for a SIM. - POST
sendpushPUSH APISend a PUSH request to a device.
Mobile, GPS & UPC
SMS & Voice Prepaid Mobile
- POST
sendsmsSend SMSDeliver an SMS to a destination MSISDN. - GET
getsmsstatusGet SMS StatusReturn delivery status of a sent SMS. - GET
getmobilecarriersGet Mobile CarriersList mobile carriers available for recharge. - GET
getmobilechargesGet Mobile RechargesList recharge denominations. - POST
rechargemobileRecharge mobile phoneTop-up a prepaid mobile number. - GETPOST
goipMobile number Portability look upReturn current carrier for an MSISDN.
GPS