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": 4568,
"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": 1667,
"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/74 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": 1384,
"name": "value"
},
"links": {}
}
PATCH
/queuegroups/{id} Updates existing QueueGroup resource
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
PATCH /v1.1/voipstudio/queuegroups/49 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": 1664,
"name": "value"
},
"links": {}
}
DELETE
/queuegroups/{id} Deletes existing QueueGroups resources
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
DELETE /v1.1/voipstudio/queuegroups/11 HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied
404 Resource not found
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": 3582,
"active": true,
"created_at": "2021-07-23 23:32:03",
"customer": 4071,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"visited_apps": "value"
}
],
"total": 59
}
GET
/users/{id} Returns User resource for given Id
Parameters
Endpoint URL:
{id} integer
User identifier
Example Request
GET /v1.1/voipstudio/users/65 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": 3637,
"active": true,
"created_at": "2020-04-12 06:47:28",
"customer": 8783,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"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/39 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": 8.5,
"cc": "value",
"cli": "value",
"currency_iso": "value",
"is_root": "value",
"language": "value"
}
],
"total": 59
}
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/16/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": 5807,
"active": true,
"created_at": "2019-06-23 08:41:52",
"customer": 2214,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"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/79/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": 9268,
"active": true,
"created_at": "2022-03-04 01:33:36",
"customer": 2936,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"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": 5847,
"name": "value"
}
],
"total": 59
}
POST
/usergroups Creates new UserGroup resource
Parameters
JSON body attributes:
name string
Example Request
POST /v1.1/voipstudio/usergroups HTTP/1.1
Host: l7api.com
{
"name": "abcd"
}
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 6784,
"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/33 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": 847,
"name": "value"
},
"links": {}
}
PATCH
/usergroups/{id} Updates existing UserGroup resource
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
JSON body attributes:
name string
Example Request
PATCH /v1.1/voipstudio/usergroups/19 HTTP/1.1
Host: l7api.com
{
"name": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 6604,
"name": "value"
},
"links": {}
}
DELETE
/usergroups/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergroups/76 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": 9146,
"name": "value"
}
],
"total": 59
}
POST
/usergrouppolicies Creates new UserGroup resource
Parameters
JSON body attributes:
name string
Example Request
POST /v1.1/voipstudio/usergrouppolicies HTTP/1.1
Host: l7api.com
{
"name": "abcd"
}
Responses
201 Created
400 Validation error
Example Response
HTTP/1.1 201 OK
Content-Type: application/json
{
"data": {
"id": 1567,
"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/74 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": 7425,
"name": "value"
},
"links": {}
}
PATCH
/usergrouppolicies/{id} Updates existing UserGroup resource
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
JSON body attributes:
name string
Example Request
PATCH /v1.1/voipstudio/usergrouppolicies/90 HTTP/1.1
Host: l7api.com
{
"name": "abcd"
}
Responses
200 Success
400 Validation error
404 Resource not found
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": 9590,
"name": "value"
},
"links": {}
}
DELETE
/usergrouppolicies/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergrouppolicies/40 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/21/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": 8523,
"active": true,
"created_at": "2020-05-20 07:13:55",
"customer": 3154,
"email": "value",
"first_name": "value",
"is_initial": true,
"is_root": true,
"last_name": "value",
"roles": "value",
"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/7/audio HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied