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/96.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": 8393,
    "billsec": 1744,
    "calldate": "2018-12-15 14:01:20",
    "charge": 8.5,
    "clid": "value",
    "destination": "webcall",
    "disposition": "M",
    "dst": "32179243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 6378,
    "live_id": 4772,
    "rate": 7.14,
    "server_id": 1231,
    "sip_endpoint_id": 9173,
    "src": "44779243705",
    "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/40.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": 5865,
    "billsec": 7559,
    "calldate": "2018-04-12 22:03:56",
    "charge": 9.1,
    "clid": "value",
    "destination": "in",
    "disposition": "M",
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 8263,
    "live_id": 3725,
    "rate": 7.13,
    "server_id": 3605,
    "sip_endpoint_id": 6189,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "M"
  },
  "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": 4073,
      "billsec": 3785,
      "calldate": "2017-10-17 20:20:39",
      "charge": 4.14,
      "clid": "value",
      "destination": "out",
      "disposition": "M",
      "dst": "32179243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 2112,
      "live_id": 2946,
      "rate": 9.1,
      "server_id": 2510,
      "sip_endpoint_id": 100,
      "src": "44779243705",
      "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/38 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": 33,
    "billsec": 9248,
    "calldate": "2017-05-26 07:09:16",
    "charge": 4.11,
    "clid": "value",
    "destination": "in",
    "disposition": "I",
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 7564,
    "live_id": 7381,
    "rate": 3.5,
    "server_id": 3183,
    "sip_endpoint_id": 2253,
    "src": "44203846719",
    "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": 5143,
      "billsec": 3932,
      "calldate": "2018-04-14 20:06:36",
      "charge": 4.13,
      "clid": "value",
      "destination": "webcall",
      "disposition": "M",
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 2441,
      "live_id": 479,
      "rate": 6.1,
      "server_id": 3146,
      "sip_endpoint_id": 1406,
      "src": "12124537768",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "I"
    }
  ],
  "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/36.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": 5603,
    "called": "32179243705",
    "caller": "13103345244",
    "duration": 1928,
    "sip_endpoint_id": 5220,
    "size": 2844,
    "timestamp": "2017-11-30 18:28:47",
    "user_id": 4464
  },
  "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": 1131,
      "called": "44203844711",
      "caller": "12124537768",
      "duration": 5845,
      "sip_endpoint_id": 4146,
      "size": 8402,
      "timestamp": "2019-05-27 04:56:51",
      "user_id": 4849
    }
  ],
  "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/19,191,409 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/56 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": 4934,
    "called": "44779243705",
    "caller": "13103345244",
    "duration": 4065,
    "sip_endpoint_id": 6423,
    "size": 6862,
    "timestamp": "2019-01-16 13:41:08",
    "user_id": 3327
  },
  "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/81.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": 7665,
    "caller": "44203844711",
    "callerid": "12124537768",
    "dialled": "12124537768",
    "duration": 3626,
    "extension_id": 8079,
    "folder": "value",
    "is_new": true,
    "origtime": "2018-08-04 02:05:56",
    "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": 385,
      "caller": "32179243705",
      "callerid": "44203846719",
      "dialled": "44203846719",
      "duration": 6364,
      "extension_id": 6999,
      "folder": "value",
      "is_new": true,
      "origtime": "2017-07-29 09:20:39",
      "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": 247,
    "folder": "abcd"
  },
  {
    "id": 7312,
    "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": 3549,
    "caller": "32179243705",
    "callerid": "12124537768",
    "dialled": "13103345244",
    "duration": 8799,
    "extension_id": 5613,
    "folder": "value",
    "is_new": true,
    "origtime": "2018-05-09 12:32: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/83 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": 389,
    "caller": "44203846719",
    "callerid": "44203846719",
    "dialled": "44203846719",
    "duration": 725,
    "extension_id": 8254,
    "folder": "value",
    "is_new": true,
    "origtime": "2016-05-21 09:49:35",
    "transcript": "value"
  },
  "links": {}
}

REST API Dokumentation

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