Elige un tema

Introducción
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/31.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": 9596,
    "billsec": 3386,
    "calldate": "2019-03-07 05:59:11",
    "charge": 6.1,
    "clid": "value",
    "destination": 2,
    "disposition": 2,
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 6050,
    "live_id": 3675,
    "rate": 4.17,
    "server_id": 230,
    "sip_endpoint_id": 1122,
    "src": "32179243705",
    "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/36.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": 544,
    "billsec": 2417,
    "calldate": "2016-06-07 21:39:19",
    "charge": 8.2,
    "clid": "value",
    "destination": 2,
    "disposition": 3,
    "dst": "32179243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 1737,
    "live_id": 134,
    "rate": 6.5,
    "server_id": 229,
    "sip_endpoint_id": 1281,
    "src": "44203846719",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 1
  },
  "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": 7402,
      "billsec": 3849,
      "calldate": "2017-10-30 06:17:22",
      "charge": 7.13,
      "clid": "value",
      "destination": 2,
      "disposition": 1,
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 1487,
      "live_id": 8269,
      "rate": 5.2,
      "server_id": 6914,
      "sip_endpoint_id": 6943,
      "src": "12124537768",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 0
    }
  ],
  "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/91 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": 6927,
    "billsec": 3473,
    "calldate": "2017-12-07 11:37:02",
    "charge": 3.17,
    "clid": "value",
    "destination": 2,
    "disposition": 1,
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 6325,
    "live_id": 7894,
    "rate": 5.17,
    "server_id": 3922,
    "sip_endpoint_id": 3233,
    "src": "32179243705",
    "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": 795,
      "billsec": 6236,
      "calldate": "2019-10-03 10:36:04",
      "charge": 6.25,
      "clid": "value",
      "destination": 0,
      "disposition": 0,
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 2597,
      "live_id": 3241,
      "rate": 5.2,
      "server_id": 4297,
      "sip_endpoint_id": 1977,
      "src": "44203846719",
      "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/72.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": 2439,
    "called": "44203846719",
    "caller": "32179243705",
    "duration": 9724,
    "live_id": 4535,
    "sip_endpoint_id": 4671,
    "size": 7880,
    "timestamp": "2020-02-18 09:53:49",
    "user_id": 3695
  },
  "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": 2968,
      "called": "44779243705",
      "caller": "13103345244",
      "duration": 4800,
      "live_id": 7295,
      "sip_endpoint_id": 6905,
      "size": 7267,
      "timestamp": "2018-03-24 08:58:45",
      "user_id": 6904
    }
  ],
  "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/37 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": 4370,
    "called": "44203846719",
    "caller": "44203844711",
    "duration": 70,
    "live_id": 193,
    "sip_endpoint_id": 7335,
    "size": 8817,
    "timestamp": "2018-04-23 16:01:59",
    "user_id": 8776
  },
  "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/50,161,420 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/28.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": 9810,
    "call_id": "value",
    "created_at": "2018-10-13 22:03:39",
    "dst": "32179243705",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 4181,
    "media_session_id": 52,
    "src": "12124537768",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 1336
  },
  "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/90.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": 7157,
    "call_id": "value",
    "created_at": "2017-10-19 16:37:45",
    "dst": "44203846719",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 9219,
    "media_session_id": 9404,
    "src": "32179243705",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 3941
  },
  "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": 8115,
      "call_id": "value",
      "created_at": "2018-12-30 14:03:50",
      "dst": "44203846719",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 1520,
      "media_session_id": 8626,
      "src": "32179243705",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 5792
    }
  ],
  "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": 5956,
    "call_id": "value",
    "created_at": "2019-09-01 02:18:51",
    "dst": "44203844711",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 461,
    "media_session_id": 6586,
    "src": "12124537768",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 5408
  },
  "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": 8175,
      "call_id": "value",
      "created_at": "2020-06-08 05:46:52",
      "dst": "12124537768",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 1241,
      "media_session_id": 1381,
      "src": "44203846719",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 6565
    }
  ],
  "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/67.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": 7561,
    "caller": "44203846719",
    "callerid": "44203846719",
    "dialled": "44203844711",
    "duration": 3975,
    "extension_id": 179,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2019-04-12 09:57:25",
    "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": 2592,
      "caller": "32179243705",
      "callerid": "32179243705",
      "dialled": "44779243705",
      "duration": 2872,
      "extension_id": 5451,
      "folder": "DELETED",
      "is_new": true,
      "origtime": "2016-10-02 19:36:54",
      "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": 786,
    "folder": "abcd"
  },
  {
    "id": 5230,
    "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": 8479,
    "caller": "12124537768",
    "callerid": "44203844711",
    "dialled": "44779243705",
    "duration": 9554,
    "extension_id": 7218,
    "folder": "INBOX",
    "is_new": true,
    "origtime": "2018-03-07 08:10:52",
    "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/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": 2989,
    "caller": "13103345244",
    "callerid": "44203846719",
    "dialled": "44779243705",
    "duration": 1142,
    "extension_id": 2857,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2018-02-18 23:13:42",
    "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": 9734,
      "call_id": "value",
      "created_at": "2017-01-02 14:14:04",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 9084,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2017-01-02 14:13:17",
      "user": 1017
    }
  ],
  "total": 59
}