cic-docs/spec/014_notification_api_extension.md
2020-08-10 09:25:11 +02:00

709 B

API EXTENSIONS FOR VIEWING NOTIFICATION DATABASE

NOMENCLATURE

Values enclosed with <> are required.

Values enclosed with [] means optional.

No enclosure means literal.

ADDED METHODS

Endpoints added are found under /api/ext/

/api/ext/sms/ /api/ext/sms/user/<user_id>/ /api/ext/sms/<phone_number>/

GET

Returns a list of latest sms notifications sent by the platform.

If user_id or phone_number is given, only entries for the affected user will be returned.

Accepts one query string:

	limit: [uint] - maximum items to return (default: 100)

Response payload:

[
	{
		datetime: <string>,
		number: <string>,
		message: <string>,	
	},
	...
]