mirror of
https://github.com/nerzhul/ocsms.git
synced 2025-10-31 02:17:38 +00:00
59 lines
1.2 KiB
YAML
59 lines
1.2 KiB
YAML
swagger: "2.0"
|
|
|
|
info:
|
|
version: 2.0.0
|
|
title: OcSMS API
|
|
description: OcSMS API specification
|
|
|
|
schemes:
|
|
- https
|
|
host: nextcloud.example.org
|
|
basePath: /apps/ocsms
|
|
|
|
paths:
|
|
/get/apiversion:
|
|
get:
|
|
summary: Retrieve API version
|
|
description: Returns the current API version.
|
|
responses:
|
|
200:
|
|
description: OcSMS API version
|
|
schema:
|
|
required:
|
|
- version
|
|
properties:
|
|
version:
|
|
type: integer
|
|
# TODO: complete this
|
|
/push:
|
|
post:
|
|
summary: Push messages to server
|
|
description: Push a list of messages to the server
|
|
responses:
|
|
200:
|
|
# TODO: complete this
|
|
/replace:
|
|
post:
|
|
summary: Replace messages to server
|
|
description: Push a list of messages to replace on the server
|
|
responses:
|
|
200:
|
|
# TODO: complete this
|
|
/get/smsidlist:
|
|
get:
|
|
# TODO: complete this
|
|
/get/lastmsgtime:
|
|
get:
|
|
# TODO: complete this
|
|
/api/v2/phones/list:
|
|
get:
|
|
# TODO: complete this
|
|
/api/v2/messages/{start}/{limit}:
|
|
get:
|
|
# TODO: complete this
|
|
/api/v2/messages/count:
|
|
get:
|
|
# Not implemented
|
|
/api/v4/messages/sendqueue:
|
|
get:
|