Rest API Usage - v0

The API contains two endpoints, one to save the Event Calls data and another one to retrieve the Bill for a phone number by period.

If the period is not informed, the last month of the current date will be used. You can’t retrieve Bill information of the current period.

POST Event Calls

POST /api/v0/call_events/

Save the data of a call event.

Example request:

POST /api/v0/call_events/ HTTP/1.1
Accept: application/json

{
  "call_id": "1",
  "type": "start",
  "timestamp": "2018-09-01T04:12:34Z",
  "source": "11911111111",
  "destination": "11922222222"
}

Example response:

HTTP/1.1 201 Created
Content-Type: application/json
Request JSON Object:
 
  • call_id (string) – call event id unique for the call
  • type (string) – type of the call event being: start or end
  • timestamp (string) – timestamp of this event (when it started or ended)
  • source (string) – the phone number making the call (only required for events of type start)
  • destination (string) – the phone number receiving the call (only required for events of type start)
Status Codes:

GET Bill

GET /api/v0/bills/(int: phone_number)/(int: month)/(int: year)/

Bill detail for phone_number and period month/year (optional).

Example request:

GET /api/v0/bill/11911111111/ HTTP/1.1

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "subscriber": "14911111111",
  "period": "01/2018",
  "calls": [
    {
      "destination": "14922222222",
      "start_date": "2018-01-15",
      "start_time": "01:01:11Z",
      "duration": "1:23:01",
      "price": "0.36"
    },
    {
      "destination": "14933333333",
      "start_date": "2018-01-18",
      "start_time": "10:30:00Z",
      "duration": "2 days, 1:00:00",
      "price": "178.56"
    }
  ]
}
Query Parameters:
 
  • phone_number (int) – the number to retrieve the bill
  • month (int) – month of the period (optional)
  • year (int) – year of the period (optional)
Status Codes: