Choose a chapter

Introduction
Resources
- Auth
- Calls
- Chat
- 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/59.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": 4378,
    "billsec": 5840,
    "calldate": "2017-01-01 22:57:17",
    "charge": 9.1,
    "clid": "value",
    "destination": "out",
    "disposition": "M",
    "dst": "13103345244",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 3407,
    "live_id": 2824,
    "rate": 4.17,
    "server_id": 9026,
    "sip_endpoint_id": 8994,
    "src": "44203846719",
    "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/96.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": 922,
    "billsec": 895,
    "calldate": "2018-05-03 12:22:07",
    "charge": 6.25,
    "clid": "value",
    "destination": "webcall",
    "disposition": "O",
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 7102,
    "live_id": 2770,
    "rate": 9.5,
    "server_id": 6935,
    "sip_endpoint_id": 5958,
    "src": "32179243705",
    "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": 221,
      "billsec": 5936,
      "calldate": "2018-02-22 00:10:49",
      "charge": 5.2,
      "clid": "value",
      "destination": "out",
      "disposition": "U",
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 2758,
      "live_id": 3819,
      "rate": 3.17,
      "server_id": 9008,
      "sip_endpoint_id": 297,
      "src": "12124537768",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "I"
    }
  ],
  "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/35 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": 8879,
    "billsec": 8380,
    "calldate": "2016-09-03 17:30:15",
    "charge": 7.5,
    "clid": "value",
    "destination": "webcall",
    "disposition": "M",
    "dst": "44203844711",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 4319,
    "live_id": 1143,
    "rate": 3.25,
    "server_id": 3617,
    "sip_endpoint_id": 5746,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "I"
  },
  "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": 1743,
      "billsec": 1827,
      "calldate": "2017-11-02 10:55:43",
      "charge": 6.13,
      "clid": "value",
      "destination": "in",
      "disposition": "O",
      "dst": "13103345244",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 9794,
      "live_id": 9079,
      "rate": 8.17,
      "server_id": 7837,
      "sip_endpoint_id": 7234,
      "src": "12124537768",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "U"
    }
  ],
  "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/12.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": 410,
    "called": "44779243705",
    "caller": "44779243705",
    "duration": 117,
    "live_id": 1046,
    "sip_endpoint_id": 6842,
    "size": 6057,
    "timestamp": "2018-11-06 19:17:34",
    "user_id": 9720
  },
  "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": 4815,
      "called": "32179243705",
      "caller": "13103345244",
      "duration": 9791,
      "live_id": 9063,
      "sip_endpoint_id": 7848,
      "size": 9974,
      "timestamp": "2019-10-09 09:04:43",
      "user_id": 585
    }
  ],
  "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/77,171,442 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/48 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": 9277,
    "called": "44779243705",
    "caller": "44203844711",
    "duration": 7822,
    "live_id": 6041,
    "sip_endpoint_id": 7878,
    "size": 9296,
    "timestamp": "2018-06-02 20:09:26",
    "user_id": 2384
  },
  "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/32.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": 2543,
    "caller": "44203844711",
    "callerid": "44203846719",
    "dialled": "12124537768",
    "duration": 4942,
    "extension_id": 1672,
    "folder": "value",
    "is_new": true,
    "origtime": "2019-09-20 04:08:30",
    "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": 1230,
      "caller": "13103345244",
      "callerid": "44203846719",
      "dialled": "13103345244",
      "duration": 9587,
      "extension_id": 5035,
      "folder": "value",
      "is_new": true,
      "origtime": "2018-06-08 17:10:35",
      "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": 981,
    "folder": "abcd"
  },
  {
    "id": 2065,
    "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": 9521,
    "caller": "44779243705",
    "callerid": "13103345244",
    "dialled": "44203844711",
    "duration": 3676,
    "extension_id": 6531,
    "folder": "value",
    "is_new": true,
    "origtime": "2019-03-26 16:41:40",
    "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/79 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": 2218,
    "caller": "32179243705",
    "callerid": "44203846719",
    "dialled": "32179243705",
    "duration": 2911,
    "extension_id": 2443,
    "folder": "value",
    "is_new": true,
    "origtime": "2019-09-24 06:14:30",
    "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