added information about what the server serves
This commit is contained in:
parent
f794d5de2c
commit
9f800b4f99
1 changed files with 30 additions and 1 deletions
29
README.md
29
README.md
|
@ -37,3 +37,32 @@ Ex:
|
|||
"password":"voipms-api-password"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Endpoints
|
||||
|
||||
### /numbers
|
||||
|
||||
*Returns a list of numbers in use*
|
||||
|
||||
Supports: GET
|
||||
|
||||
Returns a list of javascript objects with keys: did (int as string), sms_available (boolean as int), mms_available (boolean as int)
|
||||
|
||||
### /sms
|
||||
|
||||
*Returns sms/mms messages for a given number*
|
||||
|
||||
Supports: GET,POST
|
||||
Expects: string `did`
|
||||
|
||||
Returns a list of javascript objects with keys: message (string), did (int as string), contact (string as int), date (date as string), media (list)
|
||||
|
||||
### /enablesms
|
||||
|
||||
*[DISABLED] Enables sms feature for a given number*
|
||||
|
||||
Supports: GET,POST
|
||||
Expects: string `did`
|
||||
|
||||
Returns a boolean as int
|
Loading…
Reference in a new issue