Customer module
Endpoints for managing customers and users
GET
/queuegroups Returns collection of QueueGroup resources
Example Request
GET /v1.1/voipstudio/queuegroups HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 9168,
"name": "value"
}
],
"total": 59
}
POST
/queuegroups Creates new QueueGroup resource
Example Request
POST /v1.1/voipstudio/queuegroups HTTP/1.1
Host: l7api.com
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 8154,
"name": "value"
},
"links": {}
}
GET
/queuegroups/{id} Returns QueueGroup resource for given Id
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
GET /v1.1/voipstudio/queuegroups/40 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": 7519,
"name": "value"
},
"links": {}
}
PATCH
/queuegroups/{id} Updates existing QueueGroup resource
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
PATCH /v1.1/voipstudio/queuegroups/60 HTTP/1.1
Host: l7api.com
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7311,
"name": "value"
},
"links": {}
}
DELETE
/queuegroups/{id} Deletes existing QueueGroups resources
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
DELETE /v1.1/voipstudio/queuegroups/42 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
DELETE
/customers/{id} Deletes customer account
Parameters
Endpoint URL:
{id} integer
Resource identifier
Example Request
DELETE /v1.1/voipstudio/customers/5 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
GET
/users Returns collection of User resources
Example Request
GET /v1.1/voipstudio/users HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 6154,
"active": true,
"created_at": "2023-04-30 09:58:17",
"customer": 3438,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
}
],
"total": 59
}
PATCH
/users [BULK] Updates location and/or teams of existing User resources
Parameters
JSON body attributes:
id integer
location_id integer
groups array
Example Request
PATCH /v1.1/voipstudio/users HTTP/1.1
Host: l7api.com
[
{
"id": 944,
"location_id": 378,
"groups": "abcd"
},
{
"id": 5222,
"location_id": 378,
"groups": "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": 505,
"active": true,
"created_at": "2024-03-07 14:26:50",
"customer": 162,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}
GET
/users/{id} Returns User resource for given Id
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/58 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": 7416,
"active": true,
"created_at": "2021-12-01 05:44:12",
"customer": 2282,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
},
"links": {}
}
DELETE
/users/{id} Deletes existing User resource
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
DELETE /v1.1/voipstudio/users/49 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
GET
/me Returns User metadata
Example Request
GET /v1.1/voipstudio/me HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
403 Access denied
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "value",
"balance": 9.14,
"cc": "value",
"cli": "value",
"currency_iso": "value",
"is_root": "value",
"language": "value"
}
],
"total": 59
}
GET
/users/{id}/contacts Returns collection of Contact resources only for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/52/contacts HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 7431,
"active": true,
"created_at": "2016-09-15 21:49:35",
"customer": 9998,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
},
"links": {}
}
GET
/users/{id}/cdrs Returns collection of Cdr resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/52/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": 6614,
"active": true,
"created_at": "2019-09-02 19:10:50",
"customer": 2572,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}
GET
/users/{id}/chatmsgs Returns collection of Chat nessage resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/67/chatmsgs HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8926,
"active": true,
"created_at": "2024-03-09 22:49:39",
"customer": 2952,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
},
"links": {}
}
GET
/users/{id}/calls Returns collection of Call resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/38/calls HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 8080,
"active": true,
"created_at": "2023-05-21 07:05:18",
"customer": 1826,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
},
"links": {}
}
GET
/usergroups Returns collection of UserGroup resources
Example Request
GET /v1.1/voipstudio/usergroups HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 3553,
"color": "value",
"name": "value"
}
],
"total": 59
}
POST
/usergroups Creates new UserGroup resource
Parameters
JSON body attributes:
name string
color string
Example Request
POST /v1.1/voipstudio/usergroups HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 6356,
"color": "value",
"name": "value"
},
"links": {}
}
GET
/usergroups/{id} Returns UserGroup resource for given Id
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
GET /v1.1/voipstudio/usergroups/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": 1664,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH
/usergroups/{id} Updates existing UserGroup resource
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
JSON body attributes:
name string
color string
Example Request
PATCH /v1.1/voipstudio/usergroups/79 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9384,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE
/usergroups/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergroups/84 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
GET
/usergrouppolicies Returns collection of UserGroup resources
Example Request
GET /v1.1/voipstudio/usergrouppolicies HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": 613,
"color": "value",
"name": "value"
}
],
"total": 59
}
POST
/usergrouppolicies Creates new UserGroup resource
Parameters
JSON body attributes:
name string
color string
Example Request
POST /v1.1/voipstudio/usergrouppolicies HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 9776,
"color": "value",
"name": "value"
},
"links": {}
}
GET
/usergrouppolicies/{id} Returns UserGroup resource for given Id
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
GET /v1.1/voipstudio/usergrouppolicies/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": 6252,
"color": "value",
"name": "value"
},
"links": {}
}
PATCH
/usergrouppolicies/{id} Updates existing UserGroup resource
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
JSON body attributes:
name string
color string
Example Request
PATCH /v1.1/voipstudio/usergrouppolicies/47 HTTP/1.1
Host: l7api.com
{
"name": "abcd",
"color": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9874,
"color": "value",
"name": "value"
},
"links": {}
}
DELETE
/usergrouppolicies/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergrouppolicies/5 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
GET
/users/{id}/audio Returns User resource for given Id
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/63/audio 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": 1645,
"active": true,
"created_at": "2020-11-08 10:25:10",
"customer": 1514,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}
DELETE
/users/{id}/audio Reset existing User audio resource
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
DELETE /v1.1/voipstudio/users/12/audio HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
GET
/users/{id}/smsthreads/{from}/{to} Returns collection of grouped SMS resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/30/smsthreads/{from}/{to} HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 378,
"active": true,
"created_at": "2017-05-15 09:30:19",
"customer": 9693,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 1,
"visited_apps": "value"
},
"links": {}
}
GET
/users/{id}/sms/threads/{from}/{to} Returns collection of grouped SMS resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/43/sms/threads/{from}/{to} HTTP/1.1
Host: l7api.com
Responses
200 Success
401 Unauthorized
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 1177,
"active": true,
"created_at": "2019-08-03 05:41:41",
"customer": 5340,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}