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": 2390, "created_at": "2018-03-11 11:00:19", "customer_id": 7288, "duration": 1117, "operator_id": 5186, "operator_ua": "value", "state": 4, "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": 4425 } ], "total": 59 }
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/44 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": 7439, "created_at": "2018-08-07 18:28:33", "customer_id": 8350, "duration": 1420, "operator_id": 9672, "operator_ua": "value", "state": 4, "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": 9259 }, "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/15,164,436 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": 2705, "billsec": 6513, "calldate": "2017-12-30 09:27:17", "charge": 8.2, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 8859, "info": "value", "live_id": 9141, "parent_live_id": 2654, "rate": 3.33, "server_id": 1183, "sip_endpoint_id": 8483, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 1669 } ]
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": 726, "billsec": 4636, "calldate": "2022-12-04 17:52:02", "charge": 3.11, "clid": "value", "context": "value", "destination": 0, "disposition": 0, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7248, "info": "value", "live_id": 5937, "parent_live_id": 431, "rate": 7.14, "server_id": 8649, "sip_endpoint_id": 2725, "src": "44203844711", "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/62.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": 7781, "billsec": 6726, "calldate": "2020-08-15 17:15:09", "charge": 4.1, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 6425, "info": "value", "live_id": 5315, "parent_live_id": 549, "rate": 7.14, "server_id": 9400, "sip_endpoint_id": 6970, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "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} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/36.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": 2738, "billsec": 2003, "calldate": "2018-09-19 19:23:05", "charge": 9.33, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 8845, "info": "value", "live_id": 1158, "parent_live_id": 142, "rate": 2.14, "server_id": 8457, "sip_endpoint_id": 9524, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2 }, "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": 5574, "billsec": 6688, "calldate": "2017-05-09 02:15:05", "charge": 5.17, "clid": "value", "context": "value", "destination": 2, "disposition": 0, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1570, "info": "value", "live_id": 842, "parent_live_id": 2801, "rate": 6.17, "server_id": 592, "sip_endpoint_id": 8201, "src": "12124537768", "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/74 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": 6446, "billsec": 7495, "calldate": "2023-04-05 20:51:34", "charge": 4.13, "clid": "value", "context": "value", "destination": 2, "disposition": 2, "dst": "32179243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 2591, "info": "value", "live_id": 8708, "parent_live_id": 1770, "rate": 4.2, "server_id": 5956, "sip_endpoint_id": 3662, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1 }, "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": 8051, "billsec": 4203, "calldate": "2022-07-08 09:58:31", "charge": 3.14, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 412, "info": "value", "live_id": 7464, "parent_live_id": 351, "rate": 4.1, "server_id": 862, "sip_endpoint_id": 277, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0 } ], "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/23.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": 6343, "called": "12124537768", "caller": "44203846719", "duration": 8048, "live_id": 5228, "sip_endpoint_id": 4706, "size": 1111, "timestamp": "2022-11-26 00:06:08", "user_id": 8091 }, "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": 6420, "called": "13103345244", "caller": "13103345244", "duration": 90, "live_id": 4980, "sip_endpoint_id": 5386, "size": 2232, "timestamp": "2019-05-27 23:07:17", "user_id": 1864 } ], "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/57 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": 9989, "called": "12124537768", "caller": "13103345244", "duration": 7336, "live_id": 1477, "sip_endpoint_id": 2809, "size": 6043, "timestamp": "2017-06-13 01:39:03", "user_id": 4041 }, "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/93,143,470 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/54.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": 7968, "call_id": "value", "created_at": "2023-01-06 04:45:11", "dst": "44203844711", "dst_id": "value", "dst_ua": "value", "duration": 2534, "media_session_id": 3008, "src": "44203846719", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 2272 }, "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/41.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": 4017, "call_id": "value", "created_at": "2021-03-04 12:09:01", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 2681, "media_session_id": 5931, "src": "13103345244", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3675 }, "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": 9839, "call_id": "value", "created_at": "2021-02-19 07:21:31", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 4278, "media_session_id": 5395, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3623 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/29 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": 5905, "call_id": "value", "created_at": "2017-06-20 07:41:51", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 5278, "media_session_id": 2883, "src": "13103345244", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 4426 }, "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": 237, "call_id": "value", "created_at": "2017-05-28 15:59:48", "dst": "44779243705", "dst_id": "value", "dst_ua": "value", "duration": 323, "media_session_id": 7428, "src": "44203844711", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3080 } ], "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/21.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": 564, "caller": "13103345244", "callerid": "32179243705", "dialled": "44203846719", "duration": 9323, "extension_id": 7179, "folder": 1, "is_new": true, "live_id": 2671, "origtime": "2021-06-06 05:32:33", "parent_live_id": 9788, "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": 4386, "caller": "44203846719", "callerid": "32179243705", "dialled": "32179243705", "duration": 1583, "extension_id": 7075, "folder": 1, "is_new": true, "live_id": 4950, "origtime": "2019-03-24 13:17:51", "parent_live_id": 9059, "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": 695, "folder": "abcd" }, { "id": 8252, "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": 8238, "caller": "13103345244", "callerid": "44203846719", "dialled": "44203844711", "duration": 8073, "extension_id": 4304, "folder": 0, "is_new": true, "live_id": 2756, "origtime": "2019-05-30 09:52:29", "parent_live_id": 8643, "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/76 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": 504, "caller": "44203844711", "callerid": "44203844711", "dialled": "13103345244", "duration": 9315, "extension_id": 1444, "folder": 2, "is_new": true, "live_id": 6014, "origtime": "2021-02-14 18:33:08", "parent_live_id": 7913, "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/68,197,495 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": 17, "cli_hide": true, "cli_prefix": 1581, "created_at": "2019-04-05 05:01:17", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 1, "has_fax_password": true, "info": "value", "name": "value", "rate": 3.33, "sms_email": "value", "sms_enabled": true, "status": 4, "target_id": 9064, "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/40/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": 3327, "active": true, "created_at": "2021-05-17 08:14:41", "customer": 2307, "email": "value", "first_name": "value", "is_initial": true, "is_root": true, "last_name": "value", "roles": "value", "two_factor_auth": 1, "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": 9511, "call_id": "value", "created_at": "2022-01-01 11:14:14", "dst_id": "value", "dst_ua": "value", "duration": 9990, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2022-01-01 11:11:56", "user": 6435 } ], "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": 915, "created_at": "2019-09-24 10:24:54", "from": "12124537768", "message": "value", "result": "value", "to": "13103345244", "type": "value", "user": 1737 } ], "total": 59 }