Wählen Sie einen Abschnitt aus

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 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": 3233,
      "billsec": 388,
      "calldate": "2019-12-16 20:59:24",
      "charge": 9.25,
      "clid": "value",
      "destination": 1,
      "disposition": 0,
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 272,
      "live_id": 579,
      "rate": 4.25,
      "server_id": 1066,
      "sip_endpoint_id": 8194,
      "src": "32179243705",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 2
    }
  ],
  "total": 59
}

PATCH

/cdrs [BULK] Updates existing Cdr resources

Parameters

Example Request

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

[
  [],
  {
    "id": 1997
  }
]

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": 9774,
    "billsec": 4516,
    "calldate": "2018-07-10 20:47:47",
    "charge": 4.1,
    "clid": "value",
    "destination": 2,
    "disposition": 3,
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 8269,
    "live_id": 4077,
    "rate": 4.5,
    "server_id": 2726,
    "sip_endpoint_id": 7830,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 3
  },
  "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

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/87.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": 5957,
    "billsec": 7796,
    "calldate": "2018-05-13 16:29:35",
    "charge": 4.33,
    "clid": "value",
    "destination": 2,
    "disposition": 3,
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 7194,
    "live_id": 4415,
    "rate": 4.17,
    "server_id": 5750,
    "sip_endpoint_id": 418,
    "src": "44203844711",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 1
  },
  "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/86.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": 8933,
    "billsec": 1758,
    "calldate": "2020-02-23 20:45:34",
    "charge": 6.5,
    "clid": "value",
    "destination": 0,
    "disposition": 3,
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 4107,
    "live_id": 2171,
    "rate": 6.11,
    "server_id": 1079,
    "sip_endpoint_id": 2872,
    "src": "12124537768",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 0
  },
  "links": {}
}

GET

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

Parameters

Endpoint URL:

{id} integer
Cdr identifier

Example Request

GET /v1.1/voipstudio/cdrs/95 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": 938,
    "billsec": 4493,
    "calldate": "2016-08-25 03:50:05",
    "charge": 2.13,
    "clid": "value",
    "destination": 2,
    "disposition": 1,
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 3158,
    "live_id": 5482,
    "rate": 7.13,
    "server_id": 2733,
    "sip_endpoint_id": 5790,
    "src": "12124537768",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 1
  },
  "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": 3370,
      "billsec": 64,
      "calldate": "2020-10-05 06:50:46",
      "charge": 7.1,
      "clid": "value",
      "destination": 1,
      "disposition": 0,
      "dst": "44203846719",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 1818,
      "live_id": 6987,
      "rate": 6.13,
      "server_id": 3606,
      "sip_endpoint_id": 7669,
      "src": "32179243705",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 2
    }
  ],
  "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/45.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": 170,
    "called": "13103345244",
    "caller": "44203844711",
    "duration": 4790,
    "live_id": 5519,
    "sip_endpoint_id": 985,
    "size": 3525,
    "timestamp": "2017-11-19 18:01:44",
    "user_id": 882
  },
  "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": 498,
      "called": "12124537768",
      "caller": "44203846719",
      "duration": 3077,
      "live_id": 4635,
      "sip_endpoint_id": 9105,
      "size": 9323,
      "timestamp": "2018-06-17 16:13:45",
      "user_id": 3722
    }
  ],
  "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/30 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": 9434,
    "called": "32179243705",
    "caller": "32179243705",
    "duration": 5131,
    "live_id": 2112,
    "sip_endpoint_id": 9928,
    "size": 3414,
    "timestamp": "2017-02-26 12:09:54",
    "user_id": 5911
  },
  "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/82,128,484 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/14.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": 3483,
    "call_id": "value",
    "created_at": "2018-12-07 19:12:41",
    "dst": "13103345244",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 2918,
    "media_session_id": 6869,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 7827
  },
  "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/68.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": 1788,
    "call_id": "value",
    "created_at": "2019-03-24 12:20:23",
    "dst": "12124537768",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 123,
    "media_session_id": 8555,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 15
  },
  "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": 3976,
      "call_id": "value",
      "created_at": "2017-04-09 12:47:03",
      "dst": "44779243705",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 4171,
      "media_session_id": 2979,
      "src": "44779243705",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 7253
    }
  ],
  "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/20 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": 9045,
    "call_id": "value",
    "created_at": "2018-08-19 05:02:55",
    "dst": "13103345244",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 1457,
    "media_session_id": 1299,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 7431
  },
  "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": 6063,
      "call_id": "value",
      "created_at": "2017-04-01 09:21:34",
      "dst": "13103345244",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 7346,
      "media_session_id": 7940,
      "src": "44203844711",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 2464
    }
  ],
  "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/87.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": 301,
    "caller": "32179243705",
    "callerid": "32179243705",
    "dialled": "13103345244",
    "duration": 800,
    "extension_id": 4976,
    "folder": "INBOX",
    "is_new": true,
    "origtime": "2018-03-11 19:34:50",
    "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": 4024,
      "caller": "32179243705",
      "callerid": "44203844711",
      "dialled": "44203844711",
      "duration": 2974,
      "extension_id": 7690,
      "folder": "DELETED",
      "is_new": true,
      "origtime": "2018-04-11 05:51:29",
      "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": 686,
    "folder": "abcd"
  },
  {
    "id": 4090,
    "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": 2100,
    "caller": "12124537768",
    "callerid": "13103345244",
    "dialled": "44203846719",
    "duration": 1741,
    "extension_id": 8538,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2020-03-09 17:29:32",
    "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/21 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": 9755,
    "caller": "44203844711",
    "callerid": "44779243705",
    "dialled": "44203846719",
    "duration": 6444,
    "extension_id": 7008,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2019-12-26 04:45:26",
    "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": 4184,
      "call_id": "value",
      "created_at": "2019-04-03 00:16:56",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 5593,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2019-04-03 00:08:16",
      "user": 4790
    }
  ],
  "total": 59
}