History module
Endpoints for managing Call Details Reports, Call Recordings, Chats and Voicemessages
GET
/chats Returns collection of Chat resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/chats 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": 1287, "created_at": "2017-05-13 04:05:59", "customer_id": 6025, "duration": 1543, "operator_id": 63, "operator_ua": "value", "state": 1, "visitor_city": "value", "visitor_country": "value", "visitor_email": "value", "visitor_geo": "value", "visitor_id": "value", "visitor_ip": "value", "visitor_name": "value", "visitor_referer": "value", "visitor_ua": "value", "website_id": 2220 } ], "total": 59 }
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/27 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": 116, "created_at": "2020-12-24 17:54:08", "customer_id": 1109, "duration": 9888, "operator_id": 4043, "operator_ua": "value", "state": 1, "visitor_city": "value", "visitor_country": "value", "visitor_email": "value", "visitor_geo": "value", "visitor_id": "value", "visitor_ip": "value", "visitor_name": "value", "visitor_referer": "value", "visitor_ua": "value", "website_id": 5893 }, "links": {} }
DELETE
/chatmsgs/{ids} Deletes given chat message resources
Parameters
Endpoint URL:
{ids} comma separated list of integersResource identifiers
Example Request
DELETE /v1.1/voipstudio/chatmsgs/63,190,449 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
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": 5196, "billsec": 9567, "calldate": "2019-06-15 20:08:08", "charge": 2.2, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1370, "info": "value", "live_id": 2836, "parent_live_id": 8724, "rate": 4.33, "server_id": 2931, "sip_endpoint_id": 1390, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 5070 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 5224 } ]
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": 7706, "billsec": 6006, "calldate": "2021-04-20 19:24:36", "charge": 4.1, "clid": "value", "context": "value", "destination": 1, "disposition": 0, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3091, "info": "value", "live_id": 8101, "parent_live_id": 6634, "rate": 6.5, "server_id": 6049, "sip_endpoint_id": 9213, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 7885 }, "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/51.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": 2216, "billsec": 7307, "calldate": "2016-09-04 15:54:28", "charge": 2.5, "clid": "value", "context": "value", "destination": 1, "disposition": 3, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1644, "info": "value", "live_id": 476, "parent_live_id": 734, "rate": 2.17, "server_id": 1344, "sip_endpoint_id": 8737, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 9340 }, "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/97.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": 8600, "billsec": 477, "calldate": "2017-08-24 06:52:53", "charge": 4.33, "clid": "value", "context": "value", "destination": 1, "disposition": 1, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7777, "info": "value", "live_id": 944, "parent_live_id": 9380, "rate": 5.17, "server_id": 3486, "sip_endpoint_id": 949, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 4198 }, "links": {} }
GET
/cdrs/calltracking Returns collection of Call Tracking Cdr resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/cdrs/calltracking 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": 3798, "billsec": 2494, "calldate": "2018-04-18 21:26:15", "charge": 2.25, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1611, "info": "value", "live_id": 1399, "parent_live_id": 7993, "rate": 7.2, "server_id": 5990, "sip_endpoint_id": 9353, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 1077 } ], "total": 59 }
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr 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
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 8347, "billsec": 2420, "calldate": "2023-08-07 02:18:05", "charge": 5.11, "clid": "value", "context": "value", "destination": 1, "disposition": 3, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 8024, "info": "value", "live_id": 7100, "parent_live_id": 9970, "rate": 3.25, "server_id": 6138, "sip_endpoint_id": 8297, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 1091 }, "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": 9313, "billsec": 7049, "calldate": "2018-09-24 05:33:06", "charge": 4.17, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1869, "info": "value", "live_id": 8708, "parent_live_id": 3013, "rate": 5.5, "server_id": 6097, "sip_endpoint_id": 5022, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 1947 } ], "total": 59 }
GET
/cdrs/{id}/notes Returns Notes for give CDR resource
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/21/notes 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": 6027, "billsec": 5261, "calldate": "2023-02-06 12:31:30", "charge": 2.11, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 2762, "info": "value", "live_id": 4389, "parent_live_id": 6625, "rate": 6.11, "server_id": 4913, "sip_endpoint_id": 1409, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 8550 }, "links": {} }
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/83.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": 5011, "called": "44779243705", "caller": "13103345244", "context": "value", "dst_id": "value", "duration": 4113, "live_id": 4806, "sip_endpoint_id": 8460, "size": 9793, "src_id": "value", "timestamp": "2020-04-30 09:51:12", "type": "value", "user_id": 2249 }, "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": 821, "called": "44779243705", "caller": "12124537768", "context": "value", "dst_id": "value", "duration": 2840, "live_id": 6861, "sip_endpoint_id": 6513, "size": 1469, "src_id": "value", "timestamp": "2023-10-12 22:14:55", "type": "value", "user_id": 8575 } ], "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/6 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": 1350, "called": "12124537768", "caller": "44203846719", "context": "value", "dst_id": "value", "duration": 8103, "live_id": 5528, "sip_endpoint_id": 6976, "size": 8345, "src_id": "value", "timestamp": "2021-02-28 14:44:38", "type": "value", "user_id": 8779 }, "links": {} }
DELETE
/monitors/{ids} Deletes given Monitor resources
Parameters
Endpoint URL:
{ids} comma separated list of integersMonitor identifiers
Example Request
DELETE /v1.1/voipstudio/monitors/19,129,464 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/14.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": 6855, "call_id": "value", "created_at": "2018-08-22 02:53:26", "dst": "44203844711", "dst_id": "value", "dst_ua": "value", "duration": 8191, "media_session_id": 866, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3414 }, "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/16.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": 6651, "call_id": "value", "created_at": "2017-03-22 05:27:10", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 6564, "media_session_id": 7515, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 6393 }, "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": 8688, "call_id": "value", "created_at": "2018-05-19 20:33:20", "dst": "13103345244", "dst_id": "value", "dst_ua": "value", "duration": 1078, "media_session_id": 8869, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 8874 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/40 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": 771, "call_id": "value", "created_at": "2020-11-24 22:37:42", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 5568, "media_session_id": 8328, "src": "44779243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 1455 }, "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": 8903, "call_id": "value", "created_at": "2016-08-05 18:44:37", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 8754, "media_session_id": 9904, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 9328 } ], "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/16.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": 7464, "caller": "13103345244", "callerid": "44203844711", "dialled": "44203844711", "duration": 2453, "extension_id": 939, "folder": 1, "is_new": true, "live_id": 3548, "origtime": "2023-05-29 08:09:53", "parent_live_id": 5761, "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": 8478, "caller": "13103345244", "callerid": "13103345244", "dialled": "32179243705", "duration": 1636, "extension_id": 8018, "folder": 2, "is_new": true, "live_id": 8328, "origtime": "2022-05-06 05:18:11", "parent_live_id": 2735, "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": 251, "folder": "abcd" }, { "id": 7685, "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": 4157, "caller": "12124537768", "callerid": "32179243705", "dialled": "32179243705", "duration": 3844, "extension_id": 1867, "folder": 1, "is_new": true, "live_id": 6179, "origtime": "2019-12-13 14:55:36", "parent_live_id": 2765, "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/70 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": 7864, "caller": "44203844711", "callerid": "13103345244", "dialled": "32179243705", "duration": 3484, "extension_id": 7583, "folder": 0, "is_new": true, "live_id": 3014, "origtime": "2022-12-27 09:23:28", "parent_live_id": 4391, "transcript": "value" }, "links": {} }
DELETE
/voicemessages/{ids} Deletes given voicemessage resources
Parameters
Endpoint URL:
{ids} comma separated list of integersVoicemessage identifiers
Example Request
DELETE /v1.1/voipstudio/voicemessages/48,188,404 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
/calltracking/cdrs Returns collection of Call Tracking Cdr resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/calltracking/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": "value", "channels": 438, "cli_hide": true, "cli_prefix": 2885, "created_at": "2017-01-10 19:46:35", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 3, "has_fax_password": true, "info": "value", "name": "value", "rate": 4.25, "sms_email": "value", "sms_enabled": true, "status": 4, "target_id": 9552, "target_type": 5, "tel_verified": true, "uri": "value" } ], "total": 59 }
GET
/users/{id}/cdrs.csv Exports collection of Cdr resources to .csv file for given user
Parameters
Endpoint URL:
{id} integerUser identifier
Example Request
GET /v1.1/voipstudio/users/46/cdrs.csv 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": 5695, "active": true, "created_at": "2020-04-16 05:25:59", "customer": 3495, "email": "value", "first_name": "value", "is_initial": true, "is_root": true, "last_name": "value", "roles": "value", "two_factor_auth": 0, "visited_apps": "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": 1676, "call_id": "value", "created_at": "2018-12-24 14:04:45", "dst_id": "value", "dst_ua": "value", "duration": 7962, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2018-12-24 13:50:51", "user": 9473 } ], "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": 5799, "created_at": "2021-12-17 23:34:29", "from": "44203846719", "message": "value", "result": "value", "to": "44203846719", "type": "value", "user": 1803 } ], "total": 59 }