Since version 5.6, the ability to export report by API is available.
Desc: export report data to CSV file.
Request example
HTTP Method: POST
Input:
Output format: FILE
Output structure:
Error output:
Notifications / events
Desc: When a defined threshold is met the system will send notification with details.
Outgoing Request:
Structure:
event_code: The user-defined event code of the triggered event.
event_type: balance/subscriber/customer
creation_time: time that the notification was created
start_notify_time: time that the notification was sent to the 3rd party.
stamp: unique identifier of the notification record.
based_on:
usage: threshold is usage based.
monetary: threshold is monetary based.
before: the usage/cost before taking into account another cdr usage.
after: the usage/cost after taking into account another cdr usage.
extra_params:
aid: customer identification number associated with the notification.
sid: subscriber id.
row:
usagev: usage of the cdr that triggered the notification.
urt: timestamp of the cdr that triggered the notification.
conditions: array of objects where each object is a condition need to met for
the notification to be sent.
Condition objects contains the following fields:
group_total: appears only if there’s condition on a group, displays the
the group included usage.
Example Request:
HTTP Method: GET
http://host?event_code=TOTAL_COST&event_type=balance&before=0&after=5&
based_on=monetary&stamp=90d9b683d0f3912a41166e5aa8ac27bc&
start_notify_time=1513604493&creation_time=1513603493&
extra_params={“aid”:2, ”sid”:7, “row”:{“usagev”:60, “urt”:1513604493}}&
conditions=[{“path”:”balance.cost”,”unit”:””,”usaget”:””,
”Type”:”reached_constant_recurring”},”value”:10]
Expected Response:
Structure:
success: true
Example Response:
Format:JSON
{“success”: true}