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": 5992,
"created_at": "2019-05-23 18:35:23",
"customer_id": 7530,
"duration": 3836,
"operator_id": 8414,
"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": 6612
}
],
"total": 59
}
GET
/chats/{id} Returns Chat resource for given Id
Parameters
Endpoint URL:
{id} integerChat identifier
Example Request
GET /v1.1/voipstudio/chats/52 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": 2047,
"created_at": "2019-05-05 20:00:55",
"customer_id": 3173,
"duration": 3314,
"operator_id": 1404,
"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": 7179
},
"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/73,199,422 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": 2554,
"billsec": 5660,
"call_id": 8892,
"calldate": "2021-04-02 00:23:45",
"charge": 4.1,
"clid": "value",
"context": "value",
"destination": 0,
"disposition": 1,
"dst": "12124537768",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 3056,
"info": "value",
"live_id": 7654,
"parent_live_id": 1413,
"rate": 5.33,
"server_id": 7340,
"sip_endpoint_id": 5125,
"src": "13103345244",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 1,
"user_id": 5792
}
],
"total": 59
}
PATCH
/cdrs [BULK] Updates existing Cdr resources
Parameters
Example Request
PATCH /v1.1/voipstudio/cdrs HTTP/1.1
Host: l7api.com
[
[],
{
"id": 7736
}
]
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": 1885,
"billsec": 5336,
"call_id": 6901,
"calldate": "2018-01-12 08:29:37",
"charge": 8.1,
"clid": "value",
"context": "value",
"destination": 2,
"disposition": 1,
"dst": "13103345244",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 4015,
"info": "value",
"live_id": 5370,
"parent_live_id": 6437,
"rate": 4.13,
"server_id": 2067,
"sip_endpoint_id": 3260,
"src": "32179243705",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 2,
"user_id": 3694
},
"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/66.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": 1899,
"billsec": 886,
"call_id": 7273,
"calldate": "2024-02-13 05:06:52",
"charge": 6.2,
"clid": "value",
"context": "value",
"destination": 0,
"disposition": 2,
"dst": "44779243705",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 5845,
"info": "value",
"live_id": 8714,
"parent_live_id": 8496,
"rate": 5.14,
"server_id": 8385,
"sip_endpoint_id": 1527,
"src": "44203846719",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 2,
"user_id": 3667
},
"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/6.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": 953,
"billsec": 4647,
"call_id": 4583,
"calldate": "2016-12-26 20:59:13",
"charge": 3.33,
"clid": "value",
"context": "value",
"destination": 1,
"disposition": 2,
"dst": "44203846719",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 9081,
"info": "value",
"live_id": 822,
"parent_live_id": 6412,
"rate": 7.11,
"server_id": 8115,
"sip_endpoint_id": 1384,
"src": "12124537768",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 1,
"user_id": 7107
},
"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": 8987,
"billsec": 3695,
"call_id": 2555,
"calldate": "2023-08-11 06:07:33",
"charge": 3.5,
"clid": "value",
"context": "value",
"destination": 2,
"disposition": 2,
"dst": "44203844711",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 3746,
"info": "value",
"live_id": 3527,
"parent_live_id": 5861,
"rate": 3.11,
"server_id": 2915,
"sip_endpoint_id": 1483,
"src": "44203846719",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 3,
"user_id": 5596
}
],
"total": 59
}
GET
/cdrs/{id} Returns Cdr resource for given Id
Parameters
Endpoint URL:
{id} integerCdr identifier
Example Request
GET /v1.1/voipstudio/cdrs/89 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": 3712,
"billsec": 1305,
"call_id": 6552,
"calldate": "2016-10-04 20:00:37",
"charge": 9.33,
"clid": "value",
"context": "value",
"destination": 0,
"disposition": 0,
"dst": "32179243705",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 6545,
"info": "value",
"live_id": 321,
"parent_live_id": 2938,
"rate": 5.13,
"server_id": 1058,
"sip_endpoint_id": 3418,
"src": "13103345244",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 1,
"user_id": 8336
},
"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": 671,
"billsec": 1808,
"call_id": 4334,
"calldate": "2024-12-19 03:46:18",
"charge": 2.33,
"clid": "value",
"context": "value",
"destination": 2,
"disposition": 1,
"dst": "12124537768",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 8591,
"info": "value",
"live_id": 52,
"parent_live_id": 6189,
"rate": 8.11,
"server_id": 2394,
"sip_endpoint_id": 1498,
"src": "32179243705",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 2,
"user_id": 2343
}
],
"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/48/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": 6375,
"billsec": 6582,
"call_id": 1257,
"calldate": "2018-07-26 07:00:26",
"charge": 5.11,
"clid": "value",
"context": "value",
"destination": 2,
"disposition": 3,
"dst": "44203844711",
"dst_codec": "value",
"dst_id": "value",
"dst_name": "value",
"dst_ua": "value",
"duration": 1894,
"info": "value",
"live_id": 5833,
"parent_live_id": 7642,
"rate": 2.5,
"server_id": 5998,
"sip_endpoint_id": 2042,
"src": "44203844711",
"src_codec": "value",
"src_id": "value",
"src_name": "value",
"src_ua": "value",
"t_cause": "value",
"type": 1,
"user_id": 778
},
"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/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": 335,
"called": "32179243705",
"caller": "13103345244",
"context": "value",
"dst_id": "value",
"dst_name": "value",
"duration": 3445,
"live_id": 5372,
"sentiment": 1,
"sip_endpoint_id": 1203,
"size": 6634,
"src_id": "value",
"summary": "value",
"timestamp": "2021-10-14 23:48:22",
"transcript": "value",
"transcript_speakers": "value",
"type": "value",
"user_id": 7456
},
"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": 9278,
"called": "44203846719",
"caller": "12124537768",
"context": "value",
"dst_id": "value",
"dst_name": "value",
"duration": 3450,
"live_id": 3281,
"sentiment": 2,
"sip_endpoint_id": 5681,
"size": 523,
"src_id": "value",
"summary": "value",
"timestamp": "2023-01-10 01:02:00",
"transcript": "value",
"transcript_speakers": "value",
"type": "value",
"user_id": 1705
}
],
"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/12 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": 3433,
"called": "32179243705",
"caller": "32179243705",
"context": "value",
"dst_id": "value",
"dst_name": "value",
"duration": 1675,
"live_id": 2069,
"sentiment": 0,
"sip_endpoint_id": 4111,
"size": 6050,
"src_id": "value",
"summary": "value",
"timestamp": "2024-04-20 12:38:23",
"transcript": "value",
"transcript_speakers": "value",
"type": "value",
"user_id": 5049
},
"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/82 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": 2668,
"called": "44779243705",
"caller": "32179243705",
"context": "value",
"dst_id": "value",
"dst_name": "value",
"duration": 8610,
"live_id": 1361,
"sentiment": 1,
"sip_endpoint_id": 6135,
"size": 6504,
"src_id": "value",
"summary": "value",
"timestamp": "2023-07-15 15:55:45",
"transcript": "value",
"transcript_speakers": "value",
"type": "value",
"user_id": 2633
},
"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/87,146,442 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/42.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": 1222,
"call_id": "value",
"created_at": "2020-10-02 12:40:50",
"dst": "44203846719",
"dst_id": "value",
"dst_ua": "value",
"duration": 9608,
"media_session_id": 8737,
"src": "12124537768",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 2208
},
"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/30.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": 1475,
"call_id": "value",
"created_at": "2017-09-26 15:51:31",
"dst": "32179243705",
"dst_id": "value",
"dst_ua": "value",
"duration": 288,
"media_session_id": 6810,
"src": "13103345244",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 6119
},
"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": 8573,
"call_id": "value",
"created_at": "2024-09-14 20:41:13",
"dst": "13103345244",
"dst_id": "value",
"dst_ua": "value",
"duration": 2525,
"media_session_id": 7052,
"src": "12124537768",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 5912
}
],
"total": 59
}
GET
/msdrs/{id} Returns Msdr resource for given Id
Parameters
Endpoint URL:
{id} integerMsdr identifier
Example Request
GET /v1.1/voipstudio/msdrs/11 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": 552,
"call_id": "value",
"created_at": "2016-06-03 21:28:12",
"dst": "44203844711",
"dst_id": "value",
"dst_ua": "value",
"duration": 948,
"media_session_id": 9731,
"src": "12124537768",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 7829
},
"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": 4786,
"call_id": "value",
"created_at": "2018-01-09 00:42:48",
"dst": "44779243705",
"dst_id": "value",
"dst_ua": "value",
"duration": 8446,
"media_session_id": 3817,
"src": "44203844711",
"src_id": "value",
"src_ua": "value",
"t_cause": "value",
"type": "value",
"user_id": 2341
}
],
"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/68.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": 4636,
"caller": "44203844711",
"callerid": "44203846719",
"dialled": "12124537768",
"duration": 7621,
"extension_id": 3802,
"folder": 1,
"is_new": true,
"live_id": 6195,
"origtime": "2023-02-07 12:07:10",
"parent_live_id": 1539,
"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": 9982,
"caller": "44203846719",
"callerid": "13103345244",
"dialled": "44203846719",
"duration": 180,
"extension_id": 9831,
"folder": 0,
"is_new": true,
"live_id": 5455,
"origtime": "2023-11-06 10:55:43",
"parent_live_id": 2400,
"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": 809,
"folder": "abcd"
},
{
"id": 3825,
"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": 5137,
"caller": "44203844711",
"callerid": "13103345244",
"dialled": "12124537768",
"duration": 2707,
"extension_id": 7125,
"folder": 0,
"is_new": true,
"live_id": 3887,
"origtime": "2023-10-05 15:23:51",
"parent_live_id": 1720,
"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/41 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": 6972,
"caller": "44203844711",
"callerid": "44203844711",
"dialled": "32179243705",
"duration": 92,
"extension_id": 1559,
"folder": 1,
"is_new": true,
"live_id": 9777,
"origtime": "2023-08-16 18:26:03",
"parent_live_id": 719,
"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/45,102,492 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": 3716,
"created_at": "2018-09-12 13:12:33",
"from": "32179243705",
"from_id": "value",
"from_name": "value",
"message": "value",
"result": "value",
"to": "44203844711",
"to_id": "value",
"to_name": "value",
"type": "value",
"user_id": 1101
}
],
"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": 7840,
"cli_hide": true,
"cli_prefix": 772,
"created_at": "2018-03-14 08:17:57",
"e164": "value",
"esc_enabled": true,
"fax_email": "value",
"fax_enabled": true,
"flag": 5,
"has_fax_password": true,
"info": "value",
"name": "value",
"rate": 2.1,
"sms_email": "value",
"sms_enabled": true,
"status": 1,
"target_id": 3164,
"target_type": 5,
"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/85/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": 8209,
"active": true,
"created_at": "value",
"customer": 8952,
"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": 1699,
"call_id": "value",
"created_at": "2018-05-04 08:44:46",
"dst_id": "value",
"dst_ua": "value",
"duration": 117,
"src_id": "value",
"src_ua": "value",
"status": "value",
"type": "value",
"updated_at": "2018-05-04 08:31:45",
"user": 6277
}
],
"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 |