History module
Endpoints
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": 4738, "created_at": "2024-04-22 21:28:43", "customer_id": 1461, "duration": 4252, "operator_id": 950, "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": 3068 } ], "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": 7859, "created_at": "2022-09-04 20:44:15", "customer_id": 5066, "duration": 2233, "operator_id": 1726, "operator_ua": "value", "state": 0, "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": 1873 }, "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/16,136,425 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": 3583, "billsec": 8229, "call_id": 9517, "calldate": "2019-03-05 20:44:59", "charge": 6.13, "clid": "value", "context": "value", "destination": 2, "disposition": 0, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 7450, "info": "value", "live_id": 1109, "parent_live_id": 8154, "rate": 5.2, "server_id": 5777, "sip_endpoint_id": 7919, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 5295 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 4749 } ]
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": 140, "billsec": 4886, "call_id": 2741, "calldate": "2021-02-11 14:49:24", "charge": 2.1, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3540, "info": "value", "live_id": 8144, "parent_live_id": 5146, "rate": 4.13, "server_id": 8360, "sip_endpoint_id": 9185, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 8300 }, "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/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": 1637, "billsec": 178, "call_id": 1506, "calldate": "2016-05-28 17:28:53", "charge": 9.17, "clid": "value", "context": "value", "destination": 1, "disposition": 0, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 4892, "info": "value", "live_id": 3213, "parent_live_id": 9343, "rate": 2.33, "server_id": 985, "sip_endpoint_id": 958, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 5861 }, "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/10.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": 7919, "billsec": 4758, "call_id": 2263, "calldate": "2017-12-18 22:25:05", "charge": 6.25, "clid": "value", "context": "value", "destination": 1, "disposition": 1, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 2666, "info": "value", "live_id": 4563, "parent_live_id": 4149, "rate": 8.5, "server_id": 5931, "sip_endpoint_id": 456, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 1289 }, "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": 3384, "billsec": 6179, "call_id": 7507, "calldate": "2021-06-27 15:24:00", "charge": 5.25, "clid": "value", "context": "value", "destination": 0, "disposition": 1, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 6655, "info": "value", "live_id": 7946, "parent_live_id": 737, "rate": 7.1, "server_id": 2261, "sip_endpoint_id": 8787, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 4823 } ], "total": 59 }
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/13 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": 7677, "billsec": 9204, "call_id": 2933, "calldate": "2021-06-13 20:49:12", "charge": 7.25, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "12124537768", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3116, "info": "value", "live_id": 4820, "parent_live_id": 7195, "rate": 4.5, "server_id": 7505, "sip_endpoint_id": 4209, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 4477 }, "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": 3998, "billsec": 6772, "call_id": 2379, "calldate": "2025-01-10 23:35:03", "charge": 8.33, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 9117, "info": "value", "live_id": 3301, "parent_live_id": 1339, "rate": 8.1, "server_id": 5129, "sip_endpoint_id": 6817, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 3520 } ], "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/84/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": 5315, "billsec": 8069, "call_id": 990, "calldate": "2020-03-02 00:48:37", "charge": 7.1, "clid": "value", "context": "value", "destination": 1, "disposition": 1, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 6052, "info": "value", "live_id": 325, "parent_live_id": 5664, "rate": 3.1, "server_id": 2161, "sip_endpoint_id": 9949, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 6098 }, "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/82.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": 121, "called": "44203846719", "caller": "32179243705", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 7687, "live_id": 5527, "sentiment": 2, "sip_endpoint_id": 6146, "size": 6258, "src_id": "value", "summary": "value", "timestamp": "2018-12-28 14:16:39", "transcript": "value", "type": "value", "user_id": 3677 }, "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": 3552, "called": "44203844711", "caller": "44203846719", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 7530, "live_id": 4096, "sentiment": 0, "sip_endpoint_id": 1474, "size": 2139, "src_id": "value", "summary": "value", "timestamp": "2016-09-06 11:55:46", "transcript": "value", "type": "value", "user_id": 9163 } ], "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/26 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": 2079, "called": "44779243705", "caller": "44203844711", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 1105, "live_id": 8538, "sentiment": 2, "sip_endpoint_id": 5994, "size": 2298, "src_id": "value", "summary": "value", "timestamp": "2022-06-14 20:47:11", "transcript": "value", "type": "value", "user_id": 4025 }, "links": {} }
PATCH
/monitors/{id} Updates existing Monitor resource
Parameters
Endpoint URL:
{id} integerMonitor identifier
JSON body attributes:
transcript string
transcript_speakers string
summary string
sentiment string
metadata undefined
Example Request
PATCH /v1.1/voipstudio/monitors/83 HTTP/1.1 Host: l7api.com { "transcript": "abcd", "transcript_speakers": "abcd", "summary": "abcd", "sentiment": "abcd", "metadata": "abcd" }
Responses
200 Success
400 Validation error
404 Resource not found
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": { "id": 1302, "called": "44203846719", "caller": "32179243705", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 2374, "live_id": 3107, "sentiment": 0, "sip_endpoint_id": 243, "size": 8889, "src_id": "value", "summary": "value", "timestamp": "2017-08-14 22:37:05", "transcript": "value", "type": "value", "user_id": 2333 }, "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/78,197,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
/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/98.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": 1190, "call_id": "value", "created_at": "2021-12-09 23:55:28", "dst": "44779243705", "dst_id": "value", "dst_ua": "value", "duration": 6714, "media_session_id": 5507, "src": "44779243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 6414 }, "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/66.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": 2820, "call_id": "value", "created_at": "2021-11-06 13:50:45", "dst": "44779243705", "dst_id": "value", "dst_ua": "value", "duration": 3280, "media_session_id": 8507, "src": "44779243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 8652 }, "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": 338, "call_id": "value", "created_at": "2020-10-04 00:15:20", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 9550, "media_session_id": 4533, "src": "13103345244", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 6436 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/66 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": 5034, "call_id": "value", "created_at": "2019-11-07 11:04:36", "dst": "12124537768", "dst_id": "value", "dst_ua": "value", "duration": 2873, "media_session_id": 6121, "src": "44203844711", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3685 }, "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": 7896, "call_id": "value", "created_at": "2024-09-22 13:16:59", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 3159, "media_session_id": 8377, "src": "44203844711", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 3007 } ], "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/95.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": 8201, "caller": "32179243705", "callerid": "44203844711", "dialled": "44779243705", "duration": 7987, "extension_id": 6352, "folder": 0, "is_new": true, "live_id": 7752, "origtime": "2021-03-14 08:38:06", "parent_live_id": 719, "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": 6874, "caller": "44203846719", "callerid": "44203844711", "dialled": "44203844711", "duration": 7391, "extension_id": 4379, "folder": 1, "is_new": true, "live_id": 4929, "origtime": "2016-11-24 10:14:33", "parent_live_id": 839, "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": 532, "folder": "abcd" }, { "id": 1715, "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": 5442, "caller": "32179243705", "callerid": "13103345244", "dialled": "44203846719", "duration": 4349, "extension_id": 5373, "folder": 1, "is_new": true, "live_id": 368, "origtime": "2017-12-24 03:19:02", "parent_live_id": 5211, "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/95 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": 6016, "caller": "13103345244", "callerid": "44779243705", "dialled": "12124537768", "duration": 9436, "extension_id": 4370, "folder": 0, "is_new": true, "live_id": 7000, "origtime": "2020-09-14 03:32:15", "parent_live_id": 4688, "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/71,166,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
/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": 7104, "created_at": "2017-05-04 15:21:01", "from": "32179243705", "from_id": "value", "from_name": "value", "message": "value", "result": "value", "to": "44779243705", "to_id": "value", "to_name": "value", "type": "value", "user_id": 4689 } ], "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": 331, "cli_hide": true, "cli_prefix": 5056, "created_at": "2024-02-23 05:58:54", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 5, "has_fax_password": true, "info": "value", "name": "value", "rate": 7.14, "sms_email": "value", "sms_enabled": true, "status": 4, "target_id": 7346, "target_type": 2, "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/47/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": 1733, "active": true, "created_at": "value", "customer": 4269, "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": 5950, "call_id": "value", "created_at": "2023-09-10 02:21:07", "dst_id": "value", "dst_ua": "value", "duration": 9843, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2023-09-10 02:32:37", "user": 6592 } ], "total": 59 }
Models
CDR
Attribute | Data type | Description |
id | integer | Object ID |
duration | integer | Call duration in seconds |
live_id | integer | The identifier of the Live Call that generated this CDR record. It can be used to look up related records, such as call recordings. |
parent_live_id | integer | The identifier of parent (previous) Live Call that generated this CDR record. |
user_id | integer | The identifier of the User who made the call. |
sip_endpoint_id | integer | The identifier of the SIP Endpoint which made or received the call. |
server_id | integer | The identifier of the Media Server which handled the call. |
type | string | Call type: O (outbound), I (inbound), M (missed) |
calldate | string | Date and time of the call in format YYYY-MM-DD H:I:S in UTC timezone |
clid | string | Caller ID (if available) with number; |
src_id | string | The identified of the Source of the call, for example User ID 10002 or Contact ID contact:3423 |
src_name | string | String representation of Source of the call, for example Contact name |
src | string | Telephone number associated with the Source of the call |
src_ua | string | User agent of the Source of the call |
src_codec | string | Audio Codec of the Source of the call |
dst_id | string | The identified of the Destination of the call, for example User ID 10002 , Contact ID contact:3423 an IVR IVR324 or a Queue Queue12443 |
dst | string | Telephone number associated with the Destination of the call |
dst_name | string | String representation of Destination of the call, for example Contact name or a Queue name |
dst_ua | string | User agent of the Destination of the call |
dst_codec | string | Audio Codec of the Source of the call |
billsec | integer | Billable (connected) time of the call |
disposition | string | Outcome of the call, one of: INITIAL , RINGING , CONNECTED , ON_HOLD or VM (Voicemail) |
destination | string | Call direction: in (inbound), out (outbound), webcall (Web Call) or callmeback (Call Me Back) |
context | string | Call context: PSTN_CALL , USER_LOCAL , IVR , FOLLOW_ME , TEST_CALL etc. |
rate | number | The per-minute rate of the call. |
charge | number | The cost of the call. |
t_cause | string | Call termination reason, for example: Normal Clearing , User busy , No user responding etc. |
info | string | Additional information about the call. |
call_id | integer | Depreciated |