Choose a chapter

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/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": 728,
    "billsec": 4258,
    "calldate": "2019-04-08 06:33:11",
    "charge": 3.11,
    "clid": "value",
    "destination": "webcall",
    "disposition": "U",
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 9220,
    "live_id": 4879,
    "rate": 5.11,
    "server_id": 7151,
    "sip_endpoint_id": 9597,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "M"
  },
  "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/18.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": 1474,
    "billsec": 3690,
    "calldate": "2016-10-28 00:04:34",
    "charge": 3.2,
    "clid": "value",
    "destination": "out",
    "disposition": "O",
    "dst": "44203846719",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 8804,
    "live_id": 8498,
    "rate": 8.5,
    "server_id": 572,
    "sip_endpoint_id": 114,
    "src": "13103345244",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "O"
  },
  "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": 3094,
      "billsec": 9524,
      "calldate": "2020-03-19 08:09:45",
      "charge": 8.1,
      "clid": "value",
      "destination": "webcall",
      "disposition": "M",
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 6485,
      "live_id": 8227,
      "rate": 8.13,
      "server_id": 1062,
      "sip_endpoint_id": 8870,
      "src": "44779243705",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "U"
    }
  ],
  "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/7 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": 7885,
    "billsec": 6621,
    "calldate": "2018-03-20 04:21:13",
    "charge": 6.14,
    "clid": "value",
    "destination": "webcall",
    "disposition": "U",
    "dst": "12124537768",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 5394,
    "live_id": 1582,
    "rate": 9.5,
    "server_id": 6968,
    "sip_endpoint_id": 4053,
    "src": "12124537768",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "I"
  },
  "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": 7439,
      "billsec": 4730,
      "calldate": "2018-08-16 06:30:13",
      "charge": 4.5,
      "clid": "value",
      "destination": "out",
      "disposition": "O",
      "dst": "44779243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 1727,
      "live_id": 7842,
      "rate": 7.17,
      "server_id": 8123,
      "sip_endpoint_id": 1897,
      "src": "44203844711",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "U"
    }
  ],
  "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/96.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": 8977,
    "called": "44779243705",
    "caller": "44779243705",
    "duration": 4767,
    "live_id": 5560,
    "sip_endpoint_id": 4944,
    "size": 4110,
    "timestamp": "2017-07-13 00:12:21",
    "user_id": 3894
  },
  "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": 9669,
      "called": "44203844711",
      "caller": "13103345244",
      "duration": 3393,
      "live_id": 9419,
      "sip_endpoint_id": 5096,
      "size": 9379,
      "timestamp": "2019-08-19 22:18:59",
      "user_id": 8343
    }
  ],
  "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/43 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": 9983,
    "called": "44203846719",
    "caller": "13103345244",
    "duration": 5648,
    "live_id": 8766,
    "sip_endpoint_id": 9652,
    "size": 5349,
    "timestamp": "2018-07-10 06:38:35",
    "user_id": 3935
  },
  "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/90,148,414 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/59.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": 7377,
    "call_id": "value",
    "created_at": "2017-11-16 13:14:28",
    "dst": "44203846719",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 7361,
    "media_session_id": 9455,
    "src": "44203844711",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 7465
  },
  "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/46.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": 2424,
    "call_id": "value",
    "created_at": "2016-09-28 08:59:04",
    "dst": "12124537768",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 3868,
    "media_session_id": 5741,
    "src": "44203846719",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 9100
  },
  "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": 4636,
      "call_id": "value",
      "created_at": "2019-05-16 11:04:23",
      "dst": "44203846719",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 9477,
      "media_session_id": 3526,
      "src": "12124537768",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 2056
    }
  ],
  "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/84 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": 6226,
    "call_id": "value",
    "created_at": "2019-02-25 04:32:07",
    "dst": "12124537768",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 1893,
    "media_session_id": 1574,
    "src": "44203846719",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 2745
  },
  "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": 9427,
      "call_id": "value",
      "created_at": "2018-05-14 17:25:15",
      "dst": "13103345244",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 7878,
      "media_session_id": 4688,
      "src": "12124537768",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 6477
    }
  ],
  "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/53.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": 899,
    "caller": "12124537768",
    "callerid": "44779243705",
    "dialled": "13103345244",
    "duration": 9011,
    "extension_id": 9276,
    "folder": "value",
    "is_new": true,
    "origtime": "2017-09-20 07:30:19",
    "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": 560,
      "caller": "32179243705",
      "callerid": "32179243705",
      "dialled": "12124537768",
      "duration": 7862,
      "extension_id": 4240,
      "folder": "value",
      "is_new": true,
      "origtime": "2018-02-23 17:35:20",
      "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": 214,
    "folder": "abcd"
  },
  {
    "id": 6911,
    "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": 5928,
    "caller": "32179243705",
    "callerid": "32179243705",
    "dialled": "32179243705",
    "duration": 8748,
    "extension_id": 5155,
    "folder": "value",
    "is_new": true,
    "origtime": "2016-10-18 07:12:26",
    "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/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": 6967,
    "caller": "12124537768",
    "callerid": "44203846719",
    "dialled": "12124537768",
    "duration": 4595,
    "extension_id": 774,
    "folder": "value",
    "is_new": true,
    "origtime": "2018-12-01 01:15:21",
    "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": 5670,
      "call_id": "value",
      "created_at": "2018-11-08 14:14:04",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 3912,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2018-11-08 14:23:14",
      "user": "value"
    }
  ],
  "total": 59
}

Documentación REST API

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