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": 4830,
"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": 8521,
"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/39 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": 8525,
"name": "value"
},
"links": {}
}
PATCH
/queuegroups/{id} Updates existing QueueGroup resource
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
PATCH /v1.1/voipstudio/queuegroups/36 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": 1049,
"name": "value"
},
"links": {}
}
DELETE
/queuegroups/{id} Deletes existing QueueGroups resources
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
DELETE /v1.1/voipstudio/queuegroups/67 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/74 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": 8832,
"active": true,
"created_at": "2024-02-23 08:21:51",
"customer": 2059,
"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": 661,
"location_id": 415,
"groups": "abcd"
},
{
"id": 4153,
"location_id": 415,
"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": 3514,
"active": true,
"created_at": "2022-09-16 09:03:48",
"customer": 6032,
"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/60 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": 8611,
"active": true,
"created_at": "2023-07-13 15:42:37",
"customer": 1568,
"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} Deletes existing User resource
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
DELETE /v1.1/voipstudio/users/33 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": 5.1,
"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/27/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": 2696,
"active": true,
"created_at": "2018-03-16 07:38:26",
"customer": 6366,
"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/80/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": 7518,
"active": true,
"created_at": "2022-04-06 22:15:31",
"customer": 5689,
"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}/chatmsgs Returns collection of Chat nessage resources for given user
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/51/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": 2219,
"active": true,
"created_at": "2016-11-15 08:32:14",
"customer": 8912,
"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/96/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": 6443,
"active": true,
"created_at": "2020-05-22 10:31:37",
"customer": 5158,
"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
/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": 8610,
"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": 2234,
"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/99 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": 7086,
"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/73 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": 7834,
"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/24 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": 2509,
"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": 9223,
"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/52 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": 8228,
"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/28 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": 7510,
"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/19 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/57/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": 5680,
"active": true,
"created_at": "2016-10-01 05:26:25",
"customer": 3650,
"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/22/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/26/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": 5391,
"active": true,
"created_at": "2018-06-07 01:04:44",
"customer": 2054,
"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/66/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": 9631,
"active": true,
"created_at": "2018-03-29 03:54:05",
"customer": 6283,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"two_factor_auth": 0,
"visited_apps": "value"
},
"links": {}
}