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": 5668, "created_at": "2019-09-11 16:17:40", "customer_id": 9409, "duration": 2613, "operator_id": 8556, "operator_ua": "value", "state": 2, "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": 7814 } ], "total": 59 }
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/64 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": 5068, "created_at": "2016-10-16 09:12:19", "customer_id": 4879, "duration": 4234, "operator_id": 1116, "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": 2200 }, "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/86,135,482 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": 4894, "billsec": 116, "calldate": "2017-04-25 14:57:56", "charge": 6.11, "clid": "value", "context": "value", "destination": 2, "disposition": 2, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7909, "info": "value", "live_id": 9244, "parent_live_id": 2866, "rate": 8.5, "server_id": 7436, "sip_endpoint_id": 5106, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 4859 } ]
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": 4677, "billsec": 6464, "calldate": "2019-10-17 11:41:32", "charge": 6.11, "clid": "value", "context": "value", "destination": 2, "disposition": 2, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7695, "info": "value", "live_id": 1722, "parent_live_id": 8825, "rate": 8.17, "server_id": 5076, "sip_endpoint_id": 8702, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1 }, "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/30.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": 3547, "billsec": 9033, "calldate": "2020-08-29 14:48:26", "charge": 8.33, "clid": "value", "context": "value", "destination": 1, "disposition": 1, "dst": "32179243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1388, "info": "value", "live_id": 547, "parent_live_id": 8182, "rate": 4.25, "server_id": 1566, "sip_endpoint_id": 5203, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0 }, "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/72.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": 4708, "billsec": 944, "calldate": "2019-05-30 21:35:21", "charge": 2.13, "clid": "value", "context": "value", "destination": 0, "disposition": 1, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1931, "info": "value", "live_id": 971, "parent_live_id": 1648, "rate": 5.1, "server_id": 3050, "sip_endpoint_id": 3489, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0 }, "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": 3852, "billsec": 7378, "calldate": "2017-12-25 12:54:13", "charge": 5.25, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 4788, "info": "value", "live_id": 9888, "parent_live_id": 3419, "rate": 7.33, "server_id": 7634, "sip_endpoint_id": 492, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1 } ], "total": 59 }
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/4 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": 1887, "billsec": 3046, "calldate": "2021-01-01 01:11:22", "charge": 3.2, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3245, "info": "value", "live_id": 4844, "parent_live_id": 2976, "rate": 8.33, "server_id": 366, "sip_endpoint_id": 3848, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3 }, "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": 7412, "billsec": 9368, "calldate": "2017-11-13 05:10:52", "charge": 3.13, "clid": "value", "context": "value", "destination": 0, "disposition": 1, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 4156, "info": "value", "live_id": 3984, "parent_live_id": 7544, "rate": 5.14, "server_id": 6148, "sip_endpoint_id": 6568, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "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/91.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": 8286, "called": "13103345244", "caller": "13103345244", "duration": 7083, "live_id": 6984, "sip_endpoint_id": 4913, "size": 4096, "timestamp": "2017-10-14 03:06:17", "user_id": 8727 }, "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": 1055, "called": "44779243705", "caller": "44779243705", "duration": 2066, "live_id": 1265, "sip_endpoint_id": 571, "size": 5861, "timestamp": "2019-01-17 04:56:25", "user_id": 3335 } ], "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/34 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": 7084, "called": "44203844711", "caller": "44779243705", "duration": 6032, "live_id": 9013, "sip_endpoint_id": 2992, "size": 4402, "timestamp": "2016-07-25 19:17:50", "user_id": 9776 }, "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/39,193,500 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/57.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": 1967, "call_id": "value", "created_at": "2017-04-18 13:08:28", "dst": "13103345244", "dst_id": "value", "dst_ua": "value", "duration": 3828, "media_session_id": 4539, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 633 }, "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/7.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": 1897, "call_id": "value", "created_at": "2021-10-22 09:23:32", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 9427, "media_session_id": 1725, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 5887 }, "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": 1632, "call_id": "value", "created_at": "2022-10-16 06:33:18", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 4388, "media_session_id": 8010, "src": "44779243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 4318 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/79 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": 1421, "call_id": "value", "created_at": "2021-12-13 13:02:12", "dst": "44779243705", "dst_id": "value", "dst_ua": "value", "duration": 8736, "media_session_id": 1114, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 1562 }, "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": 7036, "call_id": "value", "created_at": "2021-03-05 12:51:35", "dst": "13103345244", "dst_id": "value", "dst_ua": "value", "duration": 5271, "media_session_id": 1608, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 774 } ], "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/60.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": 9615, "caller": "13103345244", "callerid": "44779243705", "dialled": "44779243705", "duration": 7916, "extension_id": 5061, "folder": 2, "is_new": true, "live_id": 446, "origtime": "2023-09-08 17:14:43", "parent_live_id": 1761, "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": 9724, "caller": "44779243705", "callerid": "12124537768", "dialled": "44203844711", "duration": 661, "extension_id": 8100, "folder": 1, "is_new": true, "live_id": 8375, "origtime": "2019-10-26 04:08:09", "parent_live_id": 1110, "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": 944, "folder": "abcd" }, { "id": 4547, "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": 3775, "caller": "13103345244", "callerid": "44203844711", "dialled": "44779243705", "duration": 2743, "extension_id": 5535, "folder": 2, "is_new": true, "live_id": 6986, "origtime": "2019-03-09 15:41:21", "parent_live_id": 5966, "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": 8696, "caller": "32179243705", "callerid": "12124537768", "dialled": "12124537768", "duration": 729, "extension_id": 5775, "folder": 2, "is_new": true, "live_id": 6420, "origtime": "2018-06-26 17:41:28", "parent_live_id": 3859, "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/31,181,434 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": 9852, "cli_hide": true, "cli_prefix": 8234, "created_at": "2020-09-02 02:32:52", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 6, "has_fax_password": true, "info": "value", "name": "value", "rate": 2.33, "sms_email": "value", "sms_enabled": true, "status": 4, "target_id": 8471, "target_type": 1, "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/71/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": 4779, "active": true, "created_at": "2019-09-11 16:20:19", "customer": 6947, "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": 2159, "call_id": "value", "created_at": "2017-11-03 16:31:03", "dst_id": "value", "dst_ua": "value", "duration": 3408, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2017-11-03 16:30:14", "user": 1953 } ], "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": 1247, "created_at": "2020-08-31 12:26:58", "from": "44203846719", "message": "value", "result": "value", "to": "44779243705", "type": "value", "user": 5207 } ], "total": 59 }