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": 1515,
"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": 8738,
"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/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": 4291,
"name": "value"
},
"links": {}
}
PATCH
/queuegroups/{id} Updates existing QueueGroup resource
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
PATCH /v1.1/voipstudio/queuegroups/98 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": 1708,
"name": "value"
},
"links": {}
}
DELETE
/queuegroups/{id} Deletes existing QueueGroups resources
Parameters
Endpoint URL:
{id} integer
QueueGroup identifier
Example Request
DELETE /v1.1/voipstudio/queuegroups/63 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": 2188,
"active": true,
"created_at": "2016-05-21 08:58:08",
"customer": 8516,
"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": 6009,
"active": true,
"created_at": "2016-10-31 13:32:08",
"customer": 7273,
"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/37 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": 3.25,
"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/38/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": 1222,
"active": true,
"created_at": "2017-12-13 21:41:13",
"customer": 6724,
"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/28/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": 8300,
"active": true,
"created_at": "2020-10-03 23:58:38",
"customer": 9148,
"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": 8487,
"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": 1682,
"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/7 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": 8475,
"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/30 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": 4698,
"name": "value"
},
"links": {}
}
DELETE
/usergroups/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergroups/22 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": 9007,
"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": 4739,
"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/63 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": 748,
"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/46 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": 5618,
"name": "value"
},
"links": {}
}
DELETE
/usergrouppolicies/{id} Deletes existing UserGroups resources
Parameters
Endpoint URL:
{id} integer
UserGroup identifier
Example Request
DELETE /v1.1/voipstudio/usergrouppolicies/31 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/34/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": 3252,
"active": true,
"created_at": "2016-08-21 22:32:13",
"customer": 282,
"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/38/audio HTTP/1.1
Host: l7api.com
Responses
204 Success
401 Unauthorized
403 Access denied