Choose a chapter

Einleitung
Resources
- Auth
- Calls
- Chat
- Settings
- Storage
- Reports

Reports module

Endpoints for managing Call Details Reports and Call Recordings

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

Example Response

HTTP/1.1 204 OK

GET

/cdrs/{id}.trace Returns Cdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/45.trace HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 1003,
    "billsec": 9,
    "calldate": "2018-07-06 05:21:58",
    "charge": 7.11,
    "clid": "value",
    "destination": 0,
    "disposition": 1,
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 190,
    "live_id": 7807,
    "rate": 3.14,
    "server_id": 4934,
    "sip_endpoint_id": 142,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 3
  },
  "links": {}
}

GET

/cdrs/{id}.pcap Returns Cdr resource as PCAP file for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/57.pcap HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 2290,
    "billsec": 5012,
    "calldate": "2016-12-12 06:07:09",
    "charge": 8.25,
    "clid": "value",
    "destination": 0,
    "disposition": 1,
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 4406,
    "live_id": 2541,
    "rate": 4.2,
    "server_id": 2944,
    "sip_endpoint_id": 3504,
    "src": "44203846719",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 2
  },
  "links": {}
}

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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": 7193,
      "billsec": 7838,
      "calldate": "2019-04-12 22:06:41",
      "charge": 2.13,
      "clid": "value",
      "destination": 2,
      "disposition": 0,
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 3698,
      "live_id": 2596,
      "rate": 2.2,
      "server_id": 5460,
      "sip_endpoint_id": 793,
      "src": "44203844711",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 3
    }
  ],
  "total": 59
}

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

Example Response

HTTP/1.1 204 OK

GET

/cdrs/{id} Returns Cdr resource for given Id

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/82 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 6418,
    "billsec": 8067,
    "calldate": "2017-05-21 05:46:53",
    "charge": 5.1,
    "clid": "value",
    "destination": 2,
    "disposition": 1,
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 3601,
    "live_id": 5874,
    "rate": 2.25,
    "server_id": 3665,
    "sip_endpoint_id": 4654,
    "src": "13103345244",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 3
  },
  "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": 5573,
      "billsec": 5621,
      "calldate": "2017-04-23 16:30:33",
      "charge": 8.5,
      "clid": "value",
      "destination": 1,
      "disposition": 1,
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 4323,
      "live_id": 3885,
      "rate": 3.1,
      "server_id": 5235,
      "sip_endpoint_id": 990,
      "src": "12124537768",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 0
    }
  ],
  "total": 59
}

GET

/monitors/{id}.mp3 Returns Monitor resource for given Id as MP3 audio file

Parameters

Endpoint URL:

{id} integer
Monitor identifier

Example Request

GET /v1.1/voipstudio/monitors/84.mp3 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 9084,
    "called": "44203846719",
    "caller": "13103345244",
    "duration": 9415,
    "live_id": 7203,
    "sip_endpoint_id": 3091,
    "size": 6982,
    "timestamp": "2018-06-07 12:25:02",
    "user_id": 7637
  },
  "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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": 7787,
      "called": "13103345244",
      "caller": "44203846719",
      "duration": 5137,
      "live_id": 2464,
      "sip_endpoint_id": 8507,
      "size": 5121,
      "timestamp": "2018-06-13 18:02:12",
      "user_id": 8008
    }
  ],
  "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

Example Response

HTTP/1.1 202 OK

GET

/monitors/{id} Returns Monitor resource for given Id

Parameters

Endpoint URL:

{id} integer
Monitor identifier

Example Request

GET /v1.1/voipstudio/monitors/23 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 8792,
    "called": "44203844711",
    "caller": "44203844711",
    "duration": 1904,
    "live_id": 8849,
    "sip_endpoint_id": 6580,
    "size": 9642,
    "timestamp": "2017-10-22 21:07:32",
    "user_id": 8008
  },
  "links": {}
}

DELETE

/monitors/{ids} Deletes existing Monitor resources

Parameters

Endpoint URL:

{ids} comma separated list of integers
Monitor identifiers

Example Request

DELETE /v1.1/voipstudio/monitors/71,148,498 HTTP/1.1
Host: l7api.com

Responses

204 Success
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} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/86.trace HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 5075,
    "call_id": "value",
    "created_at": "2016-05-12 11:06:27",
    "dst": "12124537768",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 3867,
    "media_session_id": 3325,
    "src": "44779243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 9102
  },
  "links": {}
}

GET

/msdrs/{id}.pcap Returns Msdr resource as PCAP file for given Id

Parameters

Endpoint URL:

{id} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/92.pcap HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 3445,
    "call_id": "value",
    "created_at": "2019-06-17 12:53:36",
    "dst": "13103345244",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 3154,
    "media_session_id": 1754,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 8201
  },
  "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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": 9915,
      "call_id": "value",
      "created_at": "2016-05-21 19:31:07",
      "dst": "32179243705",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 407,
      "media_session_id": 8740,
      "src": "44203846719",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 5793
    }
  ],
  "total": 59
}

GET

/msdrs/{id} Returns Msdr resource for given Id

Parameters

Endpoint URL:

{id} integer
Msdr identifier

Example Request

GET /v1.1/voipstudio/msdrs/97 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 5097,
    "call_id": "value",
    "created_at": "2019-03-17 08:11:20",
    "dst": "44779243705",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 2445,
    "media_session_id": 5687,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 4011
  },
  "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": 3872,
      "call_id": "value",
      "created_at": "2017-12-18 01:49:59",
      "dst": "13103345244",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 2980,
      "media_session_id": 6655,
      "src": "32179243705",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 9176
    }
  ],
  "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

Example Response

HTTP/1.1 204 OK

GET

/voicemessages/{id}.mp3 Returns Voicemessage MP3 file for given Id

Parameters

Endpoint URL:

{id} integer
Voicemessage identifier

Example Request

GET /v1.1/voipstudio/voicemessages/35.mp3 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 3266,
    "caller": "44203844711",
    "callerid": "32179243705",
    "dialled": "12124537768",
    "duration": 805,
    "extension_id": 6552,
    "folder": "INBOX",
    "is_new": true,
    "origtime": "2020-08-23 16:32:00",
    "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

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": [
    {
      "id": 9218,
      "caller": "44203844711",
      "callerid": "32179243705",
      "dialled": "44203846719",
      "duration": 7133,
      "extension_id": 7291,
      "folder": "DELETED",
      "is_new": true,
      "origtime": "2016-12-22 17:51:12",
      "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": 219,
    "folder": "abcd"
  },
  {
    "id": 6207,
    "folder": "abcd"
  }
]

Responses

200 Success
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": 4344,
    "caller": "44203846719",
    "callerid": "44779243705",
    "dialled": "44779243705",
    "duration": 5966,
    "extension_id": 1753,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2018-04-10 22:58:14",
    "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

Example Response

HTTP/1.1 202 OK

GET

/voicemessages/{id} Returns Voicemessage resource for given Id

Parameters

Endpoint URL:

{id} integer
Voicemessage identifier

Example Request

GET /v1.1/voipstudio/voicemessages/22 HTTP/1.1
Host: l7api.com

Responses

200 Success
401 Unauthorized
403 Access denied
404 Resource not found

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "id": 7612,
    "caller": "44779243705",
    "callerid": "44203844711",
    "dialled": "12124537768",
    "duration": 8126,
    "extension_id": 6454,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2017-06-29 12:24:16",
    "transcript": "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": 2101,
      "call_id": "value",
      "created_at": "2018-09-13 23:24:53",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 6637,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2018-09-13 23:19:16",
      "user": 9098
    }
  ],
  "total": 59
}

REST API Dokumentation

Choose a chapter

Reports module

/chatmsgs Deletes collection of ChatMsg resources

Parameters

Example Request

Responses

Example Response

/cdrs/{id}.trace Returns Cdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs/{id}.pcap Returns Cdr resource as PCAP file for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs Returns collection of Cdr resources

Parameters

Example Request

Responses

Example Response

/cdrs Deletes collection of Cdr resources

Parameters

Example Request

Responses

Example Response

/cdrs/{id} Returns Cdr resource for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/cdrs/dictionaries Returns Dictionary for Cdr resource

Parameters

Example Request

Responses

Example Response

/monitors/{id}.mp3 Returns Monitor resource for given Id as MP3 audio file

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/monitors Returns collection of Monitor resources

Parameters

Example Request

Responses

Example Response

/monitors Deletes all Monitor resources for given customer

Parameters

Example Request

Responses

Example Response

/monitors/{id} Returns Monitor resource for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/monitors/{ids} Deletes existing Monitor resources

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/msdrs/{id}.trace Returns Msdr resource as SIP Trace for given Id

Parameters

Endpoint URL:

Example Request

Responses

Example Response

/msdrs/{id}.pcap Returns Msdr resource as PCAP file for given Id

Parameters

Endpoint URL:

Example Request

Responses