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": 5959, "created_at": "2023-07-31 17:54:16", "customer_id": 9304, "duration": 3390, "operator_id": 7005, "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": 5309 } ], "total": 59 }
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/10 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": 4317, "created_at": "2023-04-27 02:13:39", "customer_id": 7774, "duration": 3042, "operator_id": 4153, "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": 9731 }, "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/12,198,441 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": 828, "billsec": 2415, "call_id": 3462, "calldate": "2018-06-14 05:41:15", "charge": 5.25, "clid": "value", "context": "value", "destination": 1, "disposition": 2, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 455, "info": "value", "live_id": 9590, "parent_live_id": 5348, "rate": 3.17, "server_id": 1501, "sip_endpoint_id": 8430, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 8950 } ], "total": 59 }
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1 Host: l7api.com [ [], { "id": 2076 } ]
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": 210, "billsec": 5383, "call_id": 7202, "calldate": "2017-11-15 17:01:28", "charge": 8.13, "clid": "value", "context": "value", "destination": 0, "disposition": 2, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3963, "info": "value", "live_id": 8249, "parent_live_id": 2120, "rate": 7.2, "server_id": 6153, "sip_endpoint_id": 1594, "src": "32179243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 4540 }, "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/29.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": 8968, "billsec": 9095, "call_id": 201, "calldate": "2022-07-03 18:54:34", "charge": 7.11, "clid": "value", "context": "value", "destination": 0, "disposition": 0, "dst": "44203846719", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 9004, "info": "value", "live_id": 9606, "parent_live_id": 9242, "rate": 6.14, "server_id": 8983, "sip_endpoint_id": 5142, "src": "44779243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 863 }, "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/65.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": 5440, "billsec": 4606, "call_id": 8220, "calldate": "2024-05-03 09:00:26", "charge": 2.17, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 1122, "info": "value", "live_id": 2596, "parent_live_id": 9541, "rate": 9.11, "server_id": 7580, "sip_endpoint_id": 5806, "src": "44779243705", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 3, "user_id": 9271 }, "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": 7834, "billsec": 8581, "call_id": 8686, "calldate": "2023-08-16 01:30:41", "charge": 6.25, "clid": "value", "context": "value", "destination": 1, "disposition": 3, "dst": "44779243705", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 8361, "info": "value", "live_id": 7970, "parent_live_id": 1159, "rate": 3.14, "server_id": 8328, "sip_endpoint_id": 5146, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 539 } ], "total": 59 }
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/80 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": 1969, "billsec": 8167, "call_id": 5156, "calldate": "2019-05-18 18:14:49", "charge": 2.5, "clid": "value", "context": "value", "destination": 2, "disposition": 3, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 9360, "info": "value", "live_id": 4180, "parent_live_id": 2743, "rate": 3.11, "server_id": 4450, "sip_endpoint_id": 7076, "src": "12124537768", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 2, "user_id": 5991 }, "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": 8717, "billsec": 5795, "call_id": 5906, "calldate": "2020-05-01 12:31:31", "charge": 2.5, "clid": "value", "context": "value", "destination": 0, "disposition": 3, "dst": "44203844711", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 415, "info": "value", "live_id": 3066, "parent_live_id": 7350, "rate": 2.14, "server_id": 5650, "sip_endpoint_id": 103, "src": "44203844711", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 1, "user_id": 4263 } ], "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/72/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": 3380, "billsec": 178, "call_id": 529, "calldate": "2022-03-05 08:48:08", "charge": 4.11, "clid": "value", "context": "value", "destination": 2, "disposition": 1, "dst": "13103345244", "dst_codec": "value", "dst_id": "value", "dst_name": "value", "dst_ua": "value", "duration": 3997, "info": "value", "live_id": 7241, "parent_live_id": 2839, "rate": 9.14, "server_id": 4906, "sip_endpoint_id": 1443, "src": "44203846719", "src_codec": "value", "src_id": "value", "src_name": "value", "src_ua": "value", "t_cause": "value", "type": 0, "user_id": 1491 }, "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/87.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": 1017, "called": "13103345244", "caller": "44779243705", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 2563, "live_id": 8669, "sentiment": 0, "sip_endpoint_id": 5427, "size": 9851, "src_id": "value", "summary": "value", "timestamp": "2019-07-29 19:26:57", "transcript": "value", "transcript_speakers": "value", "type": "value", "user_id": 4008 }, "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": 1600, "called": "32179243705", "caller": "44203846719", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 8009, "live_id": 1209, "sentiment": 1, "sip_endpoint_id": 3886, "size": 4279, "src_id": "value", "summary": "value", "timestamp": "2017-08-13 14:43:42", "transcript": "value", "transcript_speakers": "value", "type": "value", "user_id": 8840 } ], "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/86 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": 6242, "called": "44203846719", "caller": "44203844711", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 4770, "live_id": 7574, "sentiment": 0, "sip_endpoint_id": 4592, "size": 4056, "src_id": "value", "summary": "value", "timestamp": "2023-08-18 23:41:59", "transcript": "value", "transcript_speakers": "value", "type": "value", "user_id": 4124 }, "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/34 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": 2009, "called": "32179243705", "caller": "44203844711", "context": "value", "dst_id": "value", "dst_name": "value", "duration": 2928, "live_id": 6378, "sentiment": 0, "sip_endpoint_id": 138, "size": 8163, "src_id": "value", "summary": "value", "timestamp": "2024-10-14 23:45:47", "transcript": "value", "transcript_speakers": "value", "type": "value", "user_id": 9838 }, "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/83,191,458 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/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": 9112, "call_id": "value", "created_at": "2025-02-22 03:30:15", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 9749, "media_session_id": 8602, "src": "13103345244", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 2032 }, "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/23.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": 8858, "call_id": "value", "created_at": "2022-05-06 01:41:07", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 6546, "media_session_id": 9828, "src": "44203844711", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 8253 }, "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": 8459, "call_id": "value", "created_at": "2018-06-26 09:03:58", "dst": "44203846719", "dst_id": "value", "dst_ua": "value", "duration": 4787, "media_session_id": 4314, "src": "44203844711", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 7462 } ], "total": 59 }
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/25 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": 4415, "call_id": "value", "created_at": "2021-07-08 08:02:59", "dst": "44203844711", "dst_id": "value", "dst_ua": "value", "duration": 7819, "media_session_id": 8467, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 9072 }, "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": 6933, "call_id": "value", "created_at": "2018-08-31 09:52:00", "dst": "32179243705", "dst_id": "value", "dst_ua": "value", "duration": 6317, "media_session_id": 485, "src": "32179243705", "src_id": "value", "src_ua": "value", "t_cause": "value", "type": "value", "user_id": 1646 } ], "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/58.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": 7688, "caller": "13103345244", "callerid": "44203846719", "dialled": "44203844711", "duration": 414, "extension_id": 3974, "folder": 0, "is_new": true, "live_id": 3266, "origtime": "2023-01-26 16:51:32", "parent_live_id": 5317, "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": 4043, "caller": "44203844711", "callerid": "13103345244", "dialled": "13103345244", "duration": 2812, "extension_id": 6282, "folder": 2, "is_new": true, "live_id": 6016, "origtime": "2020-05-30 08:25:46", "parent_live_id": 565, "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": 324, "folder": "abcd" }, { "id": 7066, "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": 5349, "caller": "44203846719", "callerid": "44203844711", "dialled": "44779243705", "duration": 1450, "extension_id": 3132, "folder": 2, "is_new": true, "live_id": 2901, "origtime": "2024-10-15 18:27:26", "parent_live_id": 7819, "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/20 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": 553, "caller": "13103345244", "callerid": "32179243705", "dialled": "44779243705", "duration": 8635, "extension_id": 982, "folder": 2, "is_new": true, "live_id": 4076, "origtime": "2018-05-15 19:59:26", "parent_live_id": 3638, "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/8,176,466 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": 9497, "created_at": "2021-08-17 23:52:06", "from": "44779243705", "from_id": "value", "from_name": "value", "message": "value", "result": "value", "to": "12124537768", "to_id": "value", "to_name": "value", "type": "value", "user_id": 2911 } ], "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": 8873, "cli_hide": true, "cli_prefix": 5700, "created_at": "2025-02-23 23:37:58", "e164": "value", "esc_enabled": true, "fax_email": "value", "fax_enabled": true, "flag": 3, "has_fax_password": true, "info": "value", "name": "value", "rate": 9.17, "sms_email": "value", "sms_enabled": true, "status": 3, "target_id": 7721, "target_type": 6, "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/98/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": 3241, "active": true, "created_at": "value", "customer": 3687, "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": 8527, "call_id": "value", "created_at": "2020-11-05 07:06:19", "dst_id": "value", "dst_ua": "value", "duration": 6738, "src_id": "value", "src_ua": "value", "status": "value", "type": "value", "updated_at": "2020-11-05 06:58:56", "user": 3768 } ], "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 |