...
| Code Block | ||
|---|---|---|
| ||
{
"users": [
{
"integration_id": null,
"company": null,
"integration": null,
"defaultsender": null,
"balance": "1.2400000",
"use_currency": 0,
"max_forbrug": "999999",
"forbrug": "131",
"deactivated": null,
"created": "07-12-2015 08:23:57",
"parent": 0,
"id": 10281,
"username": "here_be_username",
"apikey": "---",
"materialized_path": "7xl",
"prefixes": "",
"iprange": "",
"aclBilling": true,
"aclBillingHigh": true,
"aclCharity": true,
"aclIncoming": true,
"aclSmsinbox": true,
"aclHlr": true,
"aclAdmin": true,
"enabled": true,
"credits": 999868
}
],
"status": 200
} |
On failure the response request will return a status 400 or 401 (depending on the error), with a message explaining the problem:
| Code Block | ||
|---|---|---|
| ||
{
"status": 401,
"message": "Access denied [abcd] authentication failed"
} |
Fields returned by
...
a successfull request
| Name | Description |
|---|---|
| integration_id | Used by resellers to identify users in their own CRM systems |
| company | Primarily used by resellers to identify company names |
| integration | Used by resellers to identify the customers integration type |
| defaultsender | Default sender value on the receiving device |
| balance | ??? |
| use_currency | ??? |
| max_forbrug | Maximum number of messages a user can send |
| forbrug | Amount of messages a user has sent |
| deactivated | If the user is disabled, then this indicates when the user was closed |
| created | Indicates the date the user was created |
| parent | ID of the parent user |
| apikey | The users apikey |
| materialized_path | Used to identify where the user is in the hierarchy related to it's parents |
| prefixes | A list of prefixes the user is allowed to send to |
| iprange | A list of IPs the user is allowed to use the api from |
| aclBilling | Allows the user to send premium messages |
| aclBillingHigh | Allows the user to send premium messages at higher values than DKK 12 |
| aclCharity | Allows the user to send premium messages for charity |
| aclIncoming | Allows the user to receive messages |
| aclSmsinbox | Allows the user to user smsinbox.dk |
| aclHlr | Allows the user to make HLR lookups |
| aclAdmin | Allows the user to create/edit/delete users |
| enabled | Indicates wether the user is enabled or disabled |
...