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
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
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 7185,
"billsec": 9929,
"calldate": "2018-02-24 08:50:51",
"charge": 6.2,
"clid": "value",
"destination": 0,
"disposition": 2,
"dst": "12124537768",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 3231,
"live_id": 4969,
"rate": 5.33,
"server_id": 157,
"sip_endpoint_id": 1277,
"src": "13103345244",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 3
}
],
"total": 59
}
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1
Host: l7api.com
[
[],
{
"id": 3780
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
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": 3477,
"billsec": 8056,
"calldate": "2020-04-12 10:32:54",
"charge": 7.1,
"clid": "value",
"destination": 2,
"disposition": 3,
"dst": "13103345244",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 8692,
"live_id": 9421,
"rate": 9.11,
"server_id": 9101,
"sip_endpoint_id": 9865,
"src": "12124537768",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 3
},
"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
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} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/93.trace HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6754,
"billsec": 4420,
"calldate": "2019-02-08 05:10:38",
"charge": 4.2,
"clid": "value",
"destination": 0,
"disposition": 3,
"dst": "12124537768",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 4123,
"live_id": 3365,
"rate": 8.14,
"server_id": 6069,
"sip_endpoint_id": 447,
"src": "44203844711",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 1
},
"links": {}
}
GET
/cdrs/{id}.pcap Returns Cdr resource as PCAP file for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/42.pcap HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 5745,
"billsec": 7238,
"calldate": "2018-05-05 06:16:00",
"charge": 8.2,
"clid": "value",
"destination": 0,
"disposition": 0,
"dst": "44203844711",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 6643,
"live_id": 8523,
"rate": 2.33,
"server_id": 108,
"sip_endpoint_id": 3929,
"src": "44779243705",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 3
},
"links": {}
}
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/83 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 358,
"billsec": 2698,
"calldate": "2017-06-20 15:44:22",
"charge": 8.1,
"clid": "value",
"destination": 2,
"disposition": 3,
"dst": "13103345244",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 6083,
"live_id": 7984,
"rate": 2.25,
"server_id": 4105,
"sip_endpoint_id": 9406,
"src": "13103345244",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 0
},
"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": 2702,
"billsec": 318,
"calldate": "2019-04-19 05:31:54",
"charge": 4.5,
"clid": "value",
"destination": 2,
"disposition": 3,
"dst": "44779243705",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 6491,
"live_id": 7317,
"rate": 8.11,
"server_id": 7019,
"sip_endpoint_id": 4627,
"src": "13103345244",
"src_codec": "value",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": 2
}
],
"total": 59
}
GET
/monitors/{id}.mp3 Returns Monitor resource for given Id as MP3 audio file
Parameters
Endpoint URL:
{id} integerMonitor identifier
Example Request
GET /v1.1/voipstudio/monitors/67.mp3 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 451,
"called": "44203846719",
"caller": "13103345244",
"duration": 4085,
"live_id": 553,
"sip_endpoint_id": 8491,
"size": 4536,
"timestamp": "2018-07-28 19:47:22",
"user_id": 7575
},
"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
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 4255,
"called": "44203844711",
"caller": "44203846719",
"duration": 8967,
"live_id": 2167,
"sip_endpoint_id": 6688,
"size": 1887,
"timestamp": "2018-12-13 23:20:28",
"user_id": 3274
}
],
"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
401 Unauthorized
Example Response
HTTP/1.1 202 OK
GET
/monitors/{id} Returns Monitor resource for given Id
Parameters
Endpoint URL:
{id} integerMonitor identifier
Example Request
GET /v1.1/voipstudio/monitors/71 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 3116,
"called": "44203846719",
"caller": "13103345244",
"duration": 5487,
"live_id": 2935,
"sip_endpoint_id": 7367,
"size": 6019,
"timestamp": "2018-05-01 00:37:54",
"user_id": 9159
},
"links": {}
}
DELETE
/monitors/{ids} Deletes existing Monitor resources
Parameters
Endpoint URL:
{ids} comma separated list of integersMonitor identifiers
Example Request
DELETE /v1.1/voipstudio/monitors/46,180,424 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
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} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/38.trace HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 460,
"call_id": "value",
"created_at": "2018-02-18 15:32:56",
"dst": "44779243705",
"dst_id": "value",
"dst_ua": "value",
"duration": 3573,
"media_session_id": 7530,
"src": "32179243705",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 6991
},
"links": {}
}
GET
/msdrs/{id}.pcap Returns Msdr resource as PCAP file for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/52.pcap HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4251,
"call_id": "value",
"created_at": "2018-12-02 16:50:40",
"dst": "13103345244",
"dst_id": "value",
"dst_ua": "value",
"duration": 6634,
"media_session_id": 3043,
"src": "12124537768",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 4959
},
"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
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 902,
"call_id": "value",
"created_at": "2020-04-25 04:40:52",
"dst": "13103345244",
"dst_id": "value",
"dst_ua": "value",
"duration": 1086,
"media_session_id": 1540,
"src": "44203844711",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 1605
}
],
"total": 59
}
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/67 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8870,
"call_id": "value",
"created_at": "2020-11-28 22:00:47",
"dst": "44203846719",
"dst_id": "value",
"dst_ua": "value",
"duration": 7990,
"media_session_id": 4134,
"src": "44203844711",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 1148
},
"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": 9311,
"call_id": "value",
"created_at": "2016-09-02 16:12:05",
"dst": "13103345244",
"dst_id": "value",
"dst_ua": "value",
"duration": 7266,
"media_session_id": 4700,
"src": "44203844711",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 5800
}
],
"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
401 Unauthorized
Example Response
HTTP/1.1 204 OK
GET
/voicemessages/{id}.mp3 Returns Voicemessage MP3 file for given Id
Parameters
Endpoint URL:
{id} integerVoicemessage identifier
Example Request
GET /v1.1/voipstudio/voicemessages/12.mp3 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 4634,
"caller": "44779243705",
"callerid": "44203846719",
"dialled": "32179243705",
"duration": 1495,
"extension_id": 7695,
"folder": "SAVED",
"is_new": true,
"origtime": "2020-05-29 14:09:42",
"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
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 2383,
"caller": "12124537768",
"callerid": "44779243705",
"dialled": "12124537768",
"duration": 3997,
"extension_id": 6238,
"folder": "SAVED",
"is_new": true,
"origtime": "2016-09-27 13:18:31",
"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": 328,
"folder": "abcd"
},
{
"id": 1639,
"folder": "abcd"
}
]
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
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": 962,
"caller": "44203844711",
"callerid": "44203844711",
"dialled": "44203846719",
"duration": 9094,
"extension_id": 7013,
"folder": "SAVED",
"is_new": true,
"origtime": "2020-06-14 16:33:00",
"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
401 Unauthorized
Example Response
HTTP/1.1 202 OK
GET
/voicemessages/{id} Returns Voicemessage resource for given Id
Parameters
Endpoint URL:
{id} integerVoicemessage identifier
Example Request
GET /v1.1/voipstudio/voicemessages/37 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6308,
"caller": "44779243705",
"callerid": "44203844711",
"dialled": "44203846719",
"duration": 2848,
"extension_id": 5286,
"folder": "DELETED",
"is_new": true,
"origtime": "2020-12-06 06:27:01",
"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": 3893,
"call_id": "value",
"created_at": "2016-11-23 17:21:43",
"dst_id": "value",
"dst_ua": "value",
"duration": 8199,
"src_id": "value",
"src_ua": "value",
"status": "value",
"type": "value",
"updated_at": "2016-11-23 17:22:49",
"user": 9096
}
],
"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": 1185,
"created_at": "2020-06-18 15:19:36",
"from": "44203846719",
"message": "value",
"result": "value",
"to": "13103345244",
"type": "value",
"user": 2663
}
],
"total": 59
}