Base Digitale Cloud Web API Help Page

Introduction

REST-based web service that allow client applications of customers to get filtered traffic data report.
Customers have now the possibility to integrate requesting data report flow with any of their front or back-office applications. Communication between customer applications and IFM carrier’s API are secured through OAuth2 access token authentication over SSL.

To get filtered report of traffic file, must be used “createtrafficreport” method passing specified below parameters. This method, in case of positive outcome, returns file name as output. At this point are available two ways to get file:

Direct: by calling "getfile" method to obtain zip content as attachment in the response
Requesting after checking availability: "checkfileavailability" verify effective availability of file and send a unique download code. As second step must be called "getfilebyguid" with file name and obtained GUID as parameters, to obtain zip content as attachment in the response.

TrafficReports

API	Description
GET api/createtrafficreport?customerServiceName={customerServiceName}&boundness={boundness}&dateFrom={dateFrom}&dateTo={dateTo}&calledNumber={calledNumber}&callingNumber={callingNumber}&customerId={customerId}	Request for creation of filtered CDR report. In case of positive outcome it returns code that can be used to download file.
GET api/createbulktrafficreport?customerServiceId={customerServiceId}&boundness={boundness}&cdrStartId={cdrStartId}&cdrLength={cdrLength}&culture={culture}	Request for creation of filtered CDR report in bulk mode. In case of positive outcome it returns code that can be used to download file.
GET api/createhrbulktrafficreport?customerServiceId={customerServiceId}&connectedCalls={connectedCalls}&cdrStartId={cdrStartId}&cdrLength={cdrLength}	Request for creation of filtered High Retention report in bulk mode. In case of positive outcome it returns code that can be used to download file.
GET api/checkfileavailability?codeForDownload={codeForDownload}	Check for file availability: test if file exists and if is fully generated and saved.
GET api/getfile?fileName={fileName}	Get zip as attachment in HTTP response.
GET api/getfilebyguid?guid={guid}	Get zip as attachment in HTTP response.

Mnp

API	Description
GET api/mnp/Lookup?Cli={Cli}&asOperator={asOperator}	Lookup a mobile number to get Carrier who manages it.
GET api/mnp/mvd?number={number}	Search number information and returns suggested MVD parameters.
GET api/mnp/opcode?number={number}	Search number information and returns operator code.

CdrEnqueuer

API	Description
POST api/cdr/enqueuecdrnps	Enqueue the received CDR in a MSMQ queue.
POST api/cdr/enqueuecdrjson	Enqueue the received CDR in a MSMQ queue.
POST api/cdr/servicerequest	Invoke ServiceRequest for a SaaS Request.
POST api/cdr/eventterminated	Declare EventTermination for a valid SaaS Request ready for Billing.
POST api/cdr/billevent	Declare BillEvent for a valid SaaS Request ready for Billing.
GET api/cdr/plafondsaas?nodeSaaS={nodeSaaS}&channelName={channelName}	Get residual plafond from node SaaS and channel name.