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": 5284, "created_at": "2021-04-13 21:53:56", "customer_id": 9264, "duration": 7310, "operator_id": 3406, "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": 9480 } ], "total": 59 }
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/46 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": 8632, "created_at": "2022-09-09 13:59:04", "customer_id": 393, "duration": 1529, "operator_id": 1109, "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": 5122 }, "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/68,153,468 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": 1678, "billsec": 643, "calldate": "2018-03-12 03:50:25", "charge": 4.25, "clid": "value", "context": "value", "destination": 0, "disposition": 0, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 8591, "info": "value", "live_id": 4427, "parent_live_id": 3565, "rate": 7.11, "server_id": 2817, "sip_endpoint_id": 7903, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 267 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 4008 } ]
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": 3081, "billsec": 3060, "calldate": "2022-06-10 22:55:52", "charge": 6.17, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 9466, "info": "value", "live_id": 8867, "parent_live_id": 2020, "rate": 5.13, "server_id": 6374, "sip_endpoint_id": 1658, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 2565 }, "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/75.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": 5267, "billsec": 7061, "calldate": "2023-04-29 03:04:51", "charge": 4.2, "clid": "value", "context": "value", "destination": 2, "disposition": 3, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3625, "info": "value", "live_id": 6212, "parent_live_id": 4167, "rate": 8.13, "server_id": 564, "sip_endpoint_id": 1286, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 5747 }, "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/49.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": 8050, "billsec": 9468, "calldate": "2020-04-02 07:53:22", "charge": 5.1, "clid": "value", "context": "value", "destination": 0, "disposition": 1, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 9801, "info": "value", "live_id": 4679, "parent_live_id": 4626, "rate": 6.1, "server_id": 6027, "sip_endpoint_id": 682, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 572 }, "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": 5360, "billsec": 9503, "calldate": "2023-01-20 16:18:18", "charge": 2.13, "clid": "value", "context": "value", "destination": 2, "disposition": 3, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 155, "info": "value", "live_id": 5098, "parent_live_id": 2432, "rate": 7.14, "server_id": 4524, "sip_endpoint_id": 3290, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 4365 } ], "total": 59 }
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/23 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": 3638, "billsec": 8036, "calldate": "2016-09-25 03:17:05", "charge": 8.17, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3270, "info": "value", "live_id": 7857, "parent_live_id": 9725, "rate": 3.5, "server_id": 9824, "sip_endpoint_id": 2630, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 988 }, "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": 449, "billsec": 7985, "calldate": "2017-04-03 13:41:59", "charge": 9.13, "clid": "value", "context": "value", "destination": 2, "disposition": 3, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3791, "info": "value", "live_id": 6600, "parent_live_id": 5131, "rate": 9.2, "server_id": 210, "sip_endpoint_id": 898, "src": "13103345244", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 2232 } ], "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/85/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": 5790, "billsec": 5161, "calldate": "2022-12-21 15:20:09", "charge": 7.14, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7391, "info": "value", "live_id": 8079, "parent_live_id": 1083, "rate": 9.25, "server_id": 6560, "sip_endpoint_id": 8803, "src": "44779243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 7629 }, "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/98.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": 9656, "called": "13103345244", "caller": "13103345244", "context": "value", "dst_id": "value", "duration": 7083, "live_id": 4543, "sip_endpoint_id": 3838, "size": 6295, "src_id": "value", "timestamp": "2018-04-17 01:58:03", "type": "value", "user_id": 9776 }, "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": 783, "called": "44203844711", "caller": "32179243705", "context": "value", "dst_id": "value", "duration": 4042, "live_id": 2581, "sip_endpoint_id": 2663, "size": 5790, "src_id": "value", "timestamp": "2022-10-23 12:25:16", "type": "value", "user_id": 7056 } ], "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/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": 9448, "called": "32179243705", "caller": "44203844711", "context": "value", "dst_id": "value", "duration": 8873, "live_id": 2525, "sip_endpoint_id": 3207, "size": 3959, "src_id": "value", "timestamp": "2022-06-06 05:18:53", "type": "value", "user_id": 22 }, "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/60,142,499 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/48.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": 2204, "call_id": "value", "created_at": "2016-10-11 18:10:52", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 4092, "media_session_id": 6706, "src": "44203846719", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 4602 }, "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/62.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": 3937, "call_id": "value", "created_at": "2022-06-10 10:53:43", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 7158, "media_session_id": 9979, "src": "12124537768", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 5524 }, "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": 533, "call_id": "value", "created_at": "2021-08-02 00:41:58", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 1330, "media_session_id": 1915, "src": "13103345244", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 2527 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/93 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": 9584, "call_id": "value", "created_at": "2019-10-19 11:36:01", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 8364, "media_session_id": 3342, "src": "44779243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 2783 }, "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": 574, "call_id": "value", "created_at": "2019-09-10 18:52:51", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 7498, "media_session_id": 2008, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 6960 } ], "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/51.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": 154, "caller": "12124537768", "callerid": "44203844711", "dialled": "44203844711", "duration": 2490, "extension_id": 2046, "folder": 2, "is_new": true, "live_id": 9430, "origtime": "2022-05-03 07:41:43", "parent_live_id": 5857, "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": 1953, "caller": "32179243705", "callerid": "44203846719", "dialled": "13103345244", "duration": 5768, "extension_id": 5184, "folder": 0, "is_new": true, "live_id": 6608, "origtime": "2020-08-25 09:57:33", "parent_live_id": 2159, "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": 293, "folder": "abcd" }, { "id": 5296, "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": 4230, "caller": "13103345244", "callerid": "44779243705", "dialled": "13103345244", "duration": 8283, "extension_id": 9556, "folder": 2, "is_new": true, "live_id": 2899, "origtime": "2017-05-31 15:15:58", "parent_live_id": 8036, "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/85 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": 2274, "caller": "13103345244", "callerid": "44779243705", "dialled": "44779243705", "duration": 7647, "extension_id": 9289, "folder": 1, "is_new": true, "live_id": 3825, "origtime": "2023-03-15 16:34:11", "parent_live_id": 8408, "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/22,101,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
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": 2790, "created_at": "2021-12-17 10:16:41", "from": "12124537768", "message": "value", "result": "value", "to": "44779243705", "type": "value", "user_id": 5626 } ], "total": 59 }
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": 8467, "cli_hide": true, "cli_prefix": 830, "created_at": "2016-11-14 07:33:46", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 2, "has_fax_password": true, "info": "value", "name": "value", "rate": 7.17, "sms_email": "value", "sms_enabled": true, "status": 2, "target_id": 3886, "target_type": 0, "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/97/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": 9260, "active": true, "created_at": "2016-10-09 09:13:11", "customer": 9962, "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": 9100, "call_id": "value", "created_at": "2020-05-31 14:07:35", "dst_id": "value", "dst_ua": "value", "duration": 7, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2020-05-31 14:20:33", "user": 3211 } ], "total": 59 }