Choose a chapter

Introduction
Resources
- Auth
- Calls
- Settings
- Storage
- Reports

Reports module

Endpoints for managing Call Details Reports and Call Recordings

DELETE

/chatmsgs Deletes collection of ChatMsg resources

Parameters

No parameters

Example Request

DELETE /v1.1/voipstudio/chatmsgs HTTP/1.1
Host: l7api.com

Responses

204 Success
401 Unauthorized

Example Response

HTTP/1.1 204 OK

GET

/cdrs/{id}.trace Returns Cdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/38.trace HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 2101,
    "billsec": 2260,
    "calldate": "2017-05-03 07:42:27",
    "charge": 2.11,
    "clid": "value",
    "destination": "out",
    "disposition": "O",
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 9707,
    "live_id": 1276,
    "rate": 7.2,
    "server_id": 6127,
    "sip_endpoint_id": 2553,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "M"
  },
  "links": {}
}

GET

/cdrs/{id}.pcap Returns Cdr resource as PCAP file for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/41.pcap HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 8196,
    "billsec": 9598,
    "calldate": "2016-10-15 15:45:06",
    "charge": 2.25,
    "clid": "value",
    "destination": "out",
    "disposition": "O",
    "dst": "32179243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 3527,
    "live_id": 2709,
    "rate": 3.11,
    "server_id": 9128,
    "sip_endpoint_id": 6633,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "U"
  },
  "links": {}
}

GET

/cdrs Returns collection of Cdr resources

Parameters

No parameters

Example Request

GET /v1.1/voipstudio/cdrs HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized

Example Response

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

{
  "data": [
    {
      "id": 8741,
      "billsec": 6094,
      "calldate": "2018-01-15 08:06:31",
      "charge": 9.25,
      "clid": "value",
      "destination": "webcall",
      "disposition": "I",
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 6739,
      "live_id": 2707,
      "rate": 4.25,
      "server_id": 9513,
      "sip_endpoint_id": 9899,
      "src": "44203846719",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "O"
    }
  ],
  "total": 59
}

DELETE

/cdrs Deletes collection of Cdr resources

Parameters

No parameters

Example Request

DELETE /v1.1/voipstudio/cdrs HTTP/1.1
Host: l7api.com

Responses

204 Success
401 Unauthorized

Example Response

HTTP/1.1 204 OK

GET

/cdrs/{id} Returns Cdr resource for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/98 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 1541,
    "billsec": 1139,
    "calldate": "2016-08-31 03:24:32",
    "charge": 7.2,
    "clid": "value",
    "destination": "in",
    "disposition": "U",
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 1649,
    "live_id": 8694,
    "rate": 2.5,
    "server_id": 712,
    "sip_endpoint_id": 3765,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "O"
  },
  "links": {}
}

GET

/cdrs/dictionaries Returns Dictionary for Cdr resource

Parameters

No parameters

Example Request

GET /v1.1/voipstudio/cdrs/dictionaries HTTP/1.1
Host: l7api.com

Responses

200 Unknown

Example Response

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

{
  "data": [
    {
      "id": 3438,
      "billsec": 3906,
      "calldate": "2019-03-23 16:14:36",
      "charge": 2.5,
      "clid": "value",
      "destination": "webcall",
      "disposition": "U",
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 325,
      "live_id": 357,
      "rate": 8.5,
      "server_id": 5452,
      "sip_endpoint_id": 4480,
      "src": "13103345244",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "M"
    }
  ],
  "total": 59
}

GET

/monitors/{id}.mp3 Returns Monitor resource for given Id as MP3 audio file

Parameters

Endpoint URL:

{id} integer
Monitor identifier

Example Request

GET /v1.1/voipstudio/monitors/99.mp3 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 4757,
    "called": "44203844711",
    "caller": "44203844711",
    "duration": 4929,
    "sip_endpoint_id": 8840,
    "size": 7333,
    "timestamp": "2018-10-17 17:59:51",
    "user_id": 1679
  },
  "links": {}
}

GET

/monitors Returns collection of Monitor resources

Parameters

No parameters

Example Request

GET /v1.1/voipstudio/monitors HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized

Example Response

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

{
  "data": [
    {
      "id": 6219,
      "called": "44203846719",
      "caller": "32179243705",
      "duration": 2999,
      "sip_endpoint_id": 3026,
      "size": 8006,
      "timestamp": "2019-01-15 05:25:58",
      "user_id": 865
    }
  ],
  "total": 59
}

DELETE

/monitors Deletes all Monitor resources for given customer

Parameters

No parameters

Example Request

DELETE /v1.1/voipstudio/monitors HTTP/1.1
Host: l7api.com

Responses

202 Success
401 Unauthorized

Example Response

HTTP/1.1 202 OK

DELETE

/monitors/{ids} Deletes existing Monitor resources

Parameters

Endpoint URL:

{ids} comma separated list of integers
Monitor identifiers

Example Request

DELETE /v1.1/voipstudio/monitors/60,144,445 HTTP/1.1
Host: l7api.com

Responses

204 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 204 OK

GET

/monitors/{id} Returns Monitor resource for given Id

Parameters

Endpoint URL:

{id} integer
Monitor identifier

Example Request

GET /v1.1/voipstudio/monitors/93 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 6093,
    "called": "44779243705",
    "caller": "44203846719",
    "duration": 671,
    "sip_endpoint_id": 9857,
    "size": 7686,
    "timestamp": "2016-11-26 17:01:29",
    "user_id": 2998
  },
  "links": {}
}

DELETE

/statements Deletes collection of Statement resources

Parameters

No parameters

Example Request

DELETE /v1.1/voipstudio/statements HTTP/1.1
Host: l7api.com

Responses

204 Success
401 Unauthorized

Example Response

HTTP/1.1 204 OK

GET

/voicemessages/{id}.mp3 Returns Voicemessage MP3 file for given Id

Parameters

Endpoint URL:

{id} integer
Voicemessage identifier

Example Request

GET /v1.1/voipstudio/voicemessages/85.mp3 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 6788,
    "caller": "32179243705",
    "callerid": "12124537768",
    "dialled": "44203844711",
    "duration": 1057,
    "extension_id": 1920,
    "folder": "value",
    "is_new": true,
    "origtime": "2019-06-11 11:58:39",
    "transcript": "value"
  },
  "links": {}
}

GET

/voicemessages Returns collection of Voicemessage resources

Parameters

No parameters

Example Request

GET /v1.1/voipstudio/voicemessages HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized

Example Response

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

{
  "data": [
    {
      "id": 2724,
      "caller": "44203844711",
      "callerid": "44203844711",
      "dialled": "44779243705",
      "duration": 9948,
      "extension_id": 6912,
      "folder": "value",
      "is_new": true,
      "origtime": "2016-05-22 09:24:48",
      "transcript": "value"
    }
  ],
  "total": 59
}

PATCH

/voicemessages [BULK] Updates folder of existing Voicemessage resources

Parameters

JSON body attributes:

id integer

folder string

Example Request

PATCH /v1.1/voipstudio/voicemessages HTTP/1.1
Host: l7api.com

[
  {
    "id": 514,
    "folder": "abcd"
  },
  {
    "id": 6368,
    "folder": "abcd"
  }
]

Responses

200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 4601,
    "caller": "13103345244",
    "callerid": "44779243705",
    "dialled": "32179243705",
    "duration": 9316,
    "extension_id": 8998,
    "folder": "value",
    "is_new": true,
    "origtime": "2019-03-04 22:57:12",
    "transcript": "value"
  },
  "links": {}
}

DELETE

/voicemessages Deletes collection of Voicemessage resources

Parameters

No parameters

Example Request

DELETE /v1.1/voipstudio/voicemessages HTTP/1.1
Host: l7api.com

Responses

202 Success
401 Unauthorized

Example Response

HTTP/1.1 202 OK

GET

/voicemessages/{id} Returns Voicemessage resource for given Id

Parameters

Endpoint URL:

{id} integer
Voicemessage identifier

Example Request

GET /v1.1/voipstudio/voicemessages/65 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

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

{
  "data": {
    "id": 222,
    "caller": "44779243705",
    "callerid": "13103345244",
    "dialled": "44203846719",
    "duration": 816,
    "extension_id": 7697,
    "folder": "value",
    "is_new": true,
    "origtime": "2016-05-13 01:49:39",
    "transcript": "value"
  },
  "links": {}
}

REST API Documentation

Choose a chapter

Reports module

/chatmsgs Deletes collection of ChatMsg resources

Parameters

Example Request

Responses

Example Response

/cdrs/{id}.trace Returns Cdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs/{id}.pcap Returns Cdr resource as PCAP file for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs Returns collection of Cdr resources

Parameters

Example Request

Responses

Example Response

/cdrs Deletes collection of Cdr resources

Parameters

Example Request

Responses

Example Response

/cdrs/{id} Returns Cdr resource for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs/dictionaries Returns Dictionary for Cdr resource

Parameters

Example Request

Responses

Example Response

/monitors/{id}.mp3 Returns Monitor resource for given Id as MP3 audio file

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/monitors Returns collection of Monitor resources

Parameters

Example Request

Responses

Example Response

/monitors Deletes all Monitor resources for given customer

Parameters

Example Request

Responses

Example Response

/monitors/{ids} Deletes existing Monitor resources

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/monitors/{id} Returns Monitor resource for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/statements Deletes collection of Statement resources

Parameters

Example Request

Responses

Example Response

/voicemessages/{id}.mp3 Returns Voicemessage MP3 file for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response