Choose a chapter

Introduction
- General
- Endpoints
  - Making requests
- HTTP responses
- Pager
- Filters
- Grouping
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 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": 3017,
      "billsec": 4962,
      "calldate": "2018-05-09 22:38:04",
      "charge": 5.25,
      "clid": "value",
      "destination": 1,
      "disposition": 1,
      "dst": "13103345244",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 9909,
      "live_id": 9247,
      "rate": 7.11,
      "server_id": 5364,
      "sip_endpoint_id": 4012,
      "src": "44203846719",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 0
    }
  ],
  "total": 59
}

PATCH

/cdrs [BULK] Updates existing Cdr resources

Parameters

Example Request

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

[
  [],
  {
    "id": 2973
  }
]

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": 3967,
    "billsec": 7474,
    "calldate": "2019-08-16 09:41:44",
    "charge": 6.13,
    "clid": "value",
    "destination": 1,
    "disposition": 1,
    "dst": "44203844711",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 9006,
    "live_id": 1903,
    "rate": 3.1,
    "server_id": 8105,
    "sip_endpoint_id": 6356,
    "src": "12124537768",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 0
  },
  "links": {}
}

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}.trace Returns Cdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/7.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": 9366,
    "billsec": 9833,
    "calldate": "2018-04-25 16:41:30",
    "charge": 9.25,
    "clid": "value",
    "destination": 0,
    "disposition": 3,
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 3882,
    "live_id": 3010,
    "rate": 6.33,
    "server_id": 6995,
    "sip_endpoint_id": 9880,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 2
  },
  "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/63.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": 385,
    "billsec": 5926,
    "calldate": "2017-10-14 14:06:57",
    "charge": 2.17,
    "clid": "value",
    "destination": 1,
    "disposition": 3,
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 1954,
    "live_id": 5760,
    "rate": 9.13,
    "server_id": 4577,
    "sip_endpoint_id": 1626,
    "src": "44203846719",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 2
  },
  "links": {}
}

GET

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

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/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": 1303,
    "billsec": 7807,
    "calldate": "2020-10-29 03:40:27",
    "charge": 9.1,
    "clid": "value",
    "destination": 1,
    "disposition": 2,
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 9533,
    "live_id": 764,
    "rate": 4.11,
    "server_id": 4084,
    "sip_endpoint_id": 8471,
    "src": "44203846719",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 2
  },
  "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": 4842,
      "billsec": 6674,
      "calldate": "2016-11-26 23:01:21",
      "charge": 5.2,
      "clid": "value",
      "destination": 0,
      "disposition": 3,
      "dst": "32179243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 7205,
      "live_id": 8882,
      "rate": 7.13,
      "server_id": 9878,
      "sip_endpoint_id": 7618,
      "src": "32179243705",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 1
    }
  ],
  "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/22.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": 3422,
    "called": "44203844711",
    "caller": "44203846719",
    "duration": 6793,
    "live_id": 3273,
    "sip_endpoint_id": 2696,
    "size": 9782,
    "timestamp": "2019-03-29 05:30:29",
    "user_id": 3893
  },
  "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": 4503,
      "called": "13103345244",
      "caller": "44203844711",
      "duration": 762,
      "live_id": 292,
      "sip_endpoint_id": 3503,
      "size": 3336,
      "timestamp": "2017-02-21 21:07:23",
      "user_id": 9226
    }
  ],
  "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

GET

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

Parameters

Endpoint URL:

{id} integer
Monitor identifier

Example Request

GET /v1.1/voipstudio/monitors/85 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": 3182,
    "called": "12124537768",
    "caller": "32179243705",
    "duration": 1755,
    "live_id": 1593,
    "sip_endpoint_id": 7682,
    "size": 4447,
    "timestamp": "2020-02-27 06:28:09",
    "user_id": 9319
  },
  "links": {}
}

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/28,178,422 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

/msdrs/{id}.trace Returns Msdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

{id} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/46.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": 6644,
    "call_id": "value",
    "created_at": "2020-06-25 14:38:57",
    "dst": "44203844711",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 9822,
    "media_session_id": 6072,
    "src": "12124537768",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 8581
  },
  "links": {}
}

GET

/msdrs/{id}.pcap Returns Msdr resource as PCAP file for given Id

Parameters

Endpoint URL:

{id} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/23.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": 1905,
    "call_id": "value",
    "created_at": "2020-06-28 05:20:29",
    "dst": "13103345244",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 4158,
    "media_session_id": 6160,
    "src": "44203846719",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 6315
  },
  "links": {}
}

GET

/msdrs Returns collection of Msdr resources

Parameters

No parameters

Example Request

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

Responses

200 Success
401 Unauthorized

Example Response

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

{
  "data": [
    {
      "id": 8915,
      "call_id": "value",
      "created_at": "2019-01-27 19:45:55",
      "dst": "13103345244",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 3574,
      "media_session_id": 9948,
      "src": "32179243705",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 1674
    }
  ],
  "total": 59
}

GET

/msdrs/{id} Returns Msdr resource for given Id

Parameters

Endpoint URL:

{id} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/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": 3400,
    "call_id": "value",
    "created_at": "2017-03-03 00:39:13",
    "dst": "44779243705",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 7333,
    "media_session_id": 3717,
    "src": "13103345244",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 3729
  },
  "links": {}
}

GET

/msdrs/dictionaries Returns Dictionary for Msdr resource

Parameters

No parameters

Example Request

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

Responses

200 Unknown

Example Response

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

{
  "data": [
    {
      "id": 3552,
      "call_id": "value",
      "created_at": "2020-06-29 01:42:52",
      "dst": "32179243705",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 7207,
      "media_session_id": 6337,
      "src": "44779243705",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 5817
    }
  ],
  "total": 59
}

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/5.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": 9424,
    "caller": "32179243705",
    "callerid": "13103345244",
    "dialled": "44203844711",
    "duration": 158,
    "extension_id": 2749,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2019-11-05 13:17:13",
    "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": 1676,
      "caller": "12124537768",
      "callerid": "44779243705",
      "dialled": "32179243705",
      "duration": 4481,
      "extension_id": 2192,
      "folder": "DELETED",
      "is_new": true,
      "origtime": "2020-03-04 09:48:33",
      "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": 208,
    "folder": "abcd"
  },
  {
    "id": 1346,
    "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": 1281,
    "caller": "44203844711",
    "callerid": "12124537768",
    "dialled": "44779243705",
    "duration": 3525,
    "extension_id": 4242,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2021-01-11 09:27:08",
    "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/71 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": 7046,
    "caller": "32179243705",
    "callerid": "44203846719",
    "dialled": "12124537768",
    "duration": 9001,
    "extension_id": 2176,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2021-01-30 00:28:57",
    "transcript": "value"
  },
  "links": {}
}

GET

/mediasessions/dictionaries Returns Dictionary for Media Session resource

Parameters

No parameters

Example Request

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

Responses

200 Unknown

Example Response

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

{
  "data": [
    {
      "id": 8616,
      "call_id": "value",
      "created_at": "2021-01-07 04:07:22",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 1223,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2021-01-07 03:53:04",
      "user": 8160
    }
  ],
  "total": 59
}

GET

/sms/dictionaries Returns Dictionary for SMS resource

Parameters

No parameters

Example Request

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

Responses

200 Unknown

Example Response

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

{
  "data": [
    {
      "id": 4017,
      "created_at": "2018-05-27 19:55:20",
      "from": "32179243705",
      "message": "value",
      "result": "value",
      "to": "44203844711",
      "type": "value",
      "user": 8467
    }
  ],
  "total": 59
}