diff --git a/README.md b/README.md index c98b40c..cd8c3c7 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,33 @@ Ex: "username":"voipms-email", "password":"voipms-api-password" } -``` \ No newline at end of file +``` + + +## 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 \ No newline at end of file