Storage module
Endpoints for managing Voicemails, SMS and FAXes
GET
/sms Returns collection of inbound and outbound SMS resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/sms HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 1496,
"created_at": "2018-05-08 23:37:48",
"from": "13103345244",
"message": "value",
"result": "value",
"to": "12124537768",
"type": "value",
"user_id": 2628
}
],
"total": 59
}
POST
/sms Send new SMS resource
Parameters
JSON body attributes:
to string
Destination number in e164 format
Destination number in e164 format
from string
From number in e164 format (optional)
From number in e164 format (optional)
message string
Message to send
Message to send
Example Request
POST /v1.1/voipstudio/sms HTTP/1.1
Host: l7api.com
{
"to": "12123455483",
"from": "12123455483",
"message": "Hello World!"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8268,
"created_at": "2019-07-31 00:26:09",
"from": "44203846719",
"message": "value",
"result": "value",
"to": "44203844711",
"type": "value",
"user_id": 3759
},
"links": {}
}
DELETE
/sms Deletes collection of SMS resources
Parameters
No parameters
Example Request
DELETE /v1.1/voipstudio/sms HTTP/1.1 Host: l7api.com
Responses
202 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 202 OK
GET
/sms/{id} Returns SMS resource for given Id
Parameters
Endpoint URL:
{id} integerSms identifier
Example Request
GET /v1.1/voipstudio/sms/13 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 2912,
"created_at": "2021-01-30 08:02:50",
"from": "44203846719",
"message": "value",
"result": "value",
"to": "13103345244",
"type": "value",
"user_id": 5271
},
"links": {}
}
GET
/faxes Returns collection of Fax resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/faxes HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 540,
"charge": 7.14,
"created_at": "2017-03-31 02:14:09",
"filename": "value",
"from": "44203846719",
"pages": 5914,
"status": 1,
"to": "13103345244",
"type": 1
}
],
"total": 59
}
GET
/vmannouncements Returns collection of sent voicemail announcements
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/vmannouncements HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 5931,
"created_at": "2017-10-08 12:39:33",
"description": "value",
"extension": 1346
}
],
"total": 59
}
POST
/vmannouncements Creates new voicemail announcement resource
Parameters
JSON body attributes:
extension_id integer
description string
data string
Base64 encoded file. Allowed data types for upload: MP3, MP4, WAV and AAC (Android).
Base64 encoded file. Allowed data types for upload: MP3, MP4, WAV and AAC (Android).
Example Request
POST /v1.1/voipstudio/vmannouncements HTTP/1.1
Host: l7api.com
{
"extension_id": 673,
"description": "abcd",
"data": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 5458,
"created_at": "2019-11-01 05:08:59",
"description": "value",
"extension": 4943
},
"links": {}
}
GET
/vmannouncements/{id} Returns voicemail announcement resource for given Id
Parameters
Endpoint URL:
{id} integerVmAnnouncement identifier
Example Request
GET /v1.1/voipstudio/vmannouncements/12 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6466,
"created_at": "2017-10-13 01:55:31",
"description": "value",
"extension": 8936
},
"links": {}
}
PATCH
/vmannouncements/{id} Updates existing voicemail announcement resource
Parameters
Endpoint URL:
{id} integerVmAnnouncement identifier
JSON body attributes:
extension_id integer
description string
data string
Base64 encoded file. Allowed data types for upload: MP3, MP4, WAV and AAC (Android).
Base64 encoded file. Allowed data types for upload: MP3, MP4, WAV and AAC (Android).
Example Request
PATCH /v1.1/voipstudio/vmannouncements/9 HTTP/1.1
Host: l7api.com
{
"extension_id": 846,
"description": "abcd",
"data": "abcd"
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
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": 3667,
"created_at": "2018-01-11 21:18:16",
"description": "value",
"extension": 8946
},
"links": {}
}
DELETE
/vmannouncements/{id} Deletes existing Announcement resources
Parameters
Endpoint URL:
{id} integerVmAnnouncement identifier
Example Request
DELETE /v1.1/voipstudio/vmannouncements/68 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 204 OK
GET
/sms/cannedresponses Returns collection of Canned response resources
Parameters
No parameters
Example Request
GET /v1.1/voipstudio/sms/cannedresponses HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 2546,
"created_at": "2017-03-20 09:25:19",
"from": "44203844711",
"message": "value",
"result": "value",
"to": "44779243705",
"type": "value",
"user_id": 501
}
],
"total": 59
}
POST
/sms/cannedresponses Creates new CannedResponse resource
Parameters
JSON body attributes:
name string
text string
Example Request
POST /v1.1/voipstudio/sms/cannedresponses HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"text": "abcd"
}
Responses
201 Created
400 Validation error
401 Unauthorized
400 Validation error
401 Unauthorized
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8816,
"created_at": "2020-01-09 19:36:22",
"from": "13103345244",
"message": "value",
"result": "value",
"to": "13103345244",
"type": "value",
"user_id": 6675
},
"links": {}
}
GET
/sms/cannedresponses/{id} Returns CannedResponse resource for given Id
Parameters
Endpoint URL:
{id} integerSms identifier
Example Request
GET /v1.1/voipstudio/sms/cannedresponses/55 HTTP/1.1 Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
404 Resource not found
401 Unauthorized
403 Access denied
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9326,
"created_at": "2018-07-16 20:21:41",
"from": "44203844711",
"message": "value",
"result": "value",
"to": "44203844711",
"type": "value",
"user_id": 7736
},
"links": {}
}
PATCH
/sms/cannedresponses/{id} Updates existing CannedResponse resource
Parameters
Endpoint URL:
{id} integerSms identifier
JSON body attributes:
name string
text string
Example Request
PATCH /v1.1/voipstudio/sms/cannedresponses/14 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"text": "abcd"
}
Responses
200 Success
400 Validation error
401 Unauthorized
403 Access denied
404 Resource not found
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": 8108,
"created_at": "2020-05-19 05:51:09",
"from": "44203844711",
"message": "value",
"result": "value",
"to": "44203844711",
"type": "value",
"user_id": 1298
},
"links": {}
}
DELETE
/sms/cannedresponses/{id} Deletes existing /CannedResponse resource
Parameters
Endpoint URL:
{id} integerSms identifier
Example Request
DELETE /v1.1/voipstudio/sms/cannedresponses/16 HTTP/1.1 Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
401 Unauthorized
403 Access denied
Example Response
HTTP/1.1 204 OK