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/75.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": 9236,
    "billsec": 2065,
    "calldate": "2019-09-16 05:00:13",
    "charge": 8.1,
    "clid": "value",
    "destination": 1,
    "disposition": 1,
    "dst": "13103345244",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 40,
    "live_id": 4439,
    "rate": 9.14,
    "server_id": 2379,
    "sip_endpoint_id": 8754,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 0
  },
  "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/23.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": 9647,
    "billsec": 9752,
    "calldate": "2019-08-27 10:16:17",
    "charge": 9.17,
    "clid": "value",
    "destination": 1,
    "disposition": 3,
    "dst": "44779243705",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 7615,
    "live_id": 4732,
    "rate": 5.11,
    "server_id": 6465,
    "sip_endpoint_id": 9797,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 0
  },
  "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": 7042,
      "billsec": 6601,
      "calldate": "2016-09-26 04:15:19",
      "charge": 6.2,
      "clid": "value",
      "destination": 2,
      "disposition": 0,
      "dst": "32179243705",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 647,
      "live_id": 7289,
      "rate": 3.33,
      "server_id": 6055,
      "sip_endpoint_id": 8336,
      "src": "44203846719",
      "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/64 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": 4266,
    "billsec": 4439,
    "calldate": "2018-09-10 22:58:07",
    "charge": 3.13,
    "clid": "value",
    "destination": 0,
    "disposition": 2,
    "dst": "13103345244",
    "dst_codec": "value",
    "dst_id": "value",
    "dst_name": "value",
    "dst_ua": "value",
    "duration": 9364,
    "live_id": 7028,
    "rate": 8.25,
    "server_id": 7764,
    "sip_endpoint_id": 4551,
    "src": "32179243705",
    "src_codec": "value",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": 0
  },
  "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": 3667,
      "billsec": 7480,
      "calldate": "2020-06-06 00:47:06",
      "charge": 8.17,
      "clid": "value",
      "destination": 0,
      "disposition": 2,
      "dst": "44203844711",
      "dst_codec": "value",
      "dst_id": "value",
      "dst_name": "value",
      "dst_ua": "value",
      "duration": 7902,
      "live_id": 7391,
      "rate": 5.1,
      "server_id": 5235,
      "sip_endpoint_id": 7884,
      "src": "44203844711",
      "src_codec": "value",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": 1
    }
  ],
  "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/93.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": 7874,
    "called": "12124537768",
    "caller": "13103345244",
    "duration": 2786,
    "live_id": 1722,
    "sip_endpoint_id": 9676,
    "size": 4022,
    "timestamp": "2017-10-12 23:31:05",
    "user_id": 6005
  },
  "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": 2922,
      "called": "44203846719",
      "caller": "44779243705",
      "duration": 8585,
      "live_id": 1006,
      "sip_endpoint_id": 8795,
      "size": 2429,
      "timestamp": "2019-12-07 13:58:57",
      "user_id": 443
    }
  ],
  "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/28 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": 8288,
    "called": "12124537768",
    "caller": "32179243705",
    "duration": 8347,
    "live_id": 9683,
    "sip_endpoint_id": 1210,
    "size": 7887,
    "timestamp": "2016-09-29 23:39:36",
    "user_id": 9527
  },
  "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/70,104,479 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/74.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": 8028,
    "call_id": "value",
    "created_at": "2018-03-17 03:01:58",
    "dst": "44203846719",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 6316,
    "media_session_id": 5406,
    "src": "13103345244",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 2261
  },
  "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/29.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": 1564,
    "call_id": "value",
    "created_at": "2017-07-06 12:13:13",
    "dst": "12124537768",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 9421,
    "media_session_id": 3103,
    "src": "13103345244",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 7906
  },
  "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": 5138,
      "call_id": "value",
      "created_at": "2019-07-29 18:41:36",
      "dst": "44203846719",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 9308,
      "media_session_id": 5052,
      "src": "44203844711",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 8564
    }
  ],
  "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/42 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": 4093,
    "call_id": "value",
    "created_at": "2020-02-27 04:45:43",
    "dst": "13103345244",
    "dst_id": "value",
    "dst_ua": "value",
    "duration": 8992,
    "media_session_id": 1732,
    "src": "44203844711",
    "src_id": "value",
    "src_ua": "value",
    "t_cause": "value",
    "type": "value",
    "user_id": 7854
  },
  "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": 5394,
      "call_id": "value",
      "created_at": "2017-06-26 02:19:04",
      "dst": "12124537768",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 8152,
      "media_session_id": 3625,
      "src": "44203844711",
      "src_id": "value",
      "src_ua": "value",
      "t_cause": "value",
      "type": "value",
      "user_id": 6818
    }
  ],
  "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/60.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": 2634,
    "caller": "13103345244",
    "callerid": "44779243705",
    "dialled": "44779243705",
    "duration": 5716,
    "extension_id": 249,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2017-08-05 01:32:16",
    "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": 6778,
      "caller": "44779243705",
      "callerid": "44203846719",
      "dialled": "44203846719",
      "duration": 8867,
      "extension_id": 9844,
      "folder": "SAVED",
      "is_new": true,
      "origtime": "2017-05-04 05:05:48",
      "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": 259,
    "folder": "abcd"
  },
  {
    "id": 9348,
    "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": 2470,
    "caller": "12124537768",
    "callerid": "44203844711",
    "dialled": "12124537768",
    "duration": 1826,
    "extension_id": 534,
    "folder": "DELETED",
    "is_new": true,
    "origtime": "2019-11-29 19:54:29",
    "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/14 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": 3877,
    "caller": "12124537768",
    "callerid": "44203846719",
    "dialled": "44203846719",
    "duration": 5023,
    "extension_id": 5572,
    "folder": "SAVED",
    "is_new": true,
    "origtime": "2016-11-18 16:32:37",
    "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": 7207,
      "call_id": "value",
      "created_at": "2018-04-21 01:35:39",
      "dst_id": "value",
      "dst_ua": "value",
      "duration": 6563,
      "src_id": "value",
      "src_ua": "value",
      "status": "value",
      "type": "value",
      "updated_at": "2018-04-21 01:48:47",
      "user": 2241
    }
  ],
  "total": 59
}

Documentación REST API

Elige un tema

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