Aller au contenu principal
Version: v4 (Stable)

Calls Service

POST /api/v1/call/groups

Calls all users from the specified call groups.

remarque

The full parameter list and detailed endpoint documentation will be available in a future release.

POST /api/v1/call/users

Calls the specified users directly.

Request

  • Content-Type: application/json
PropertyTypeDescription
userIdsarray of uintList of user IDs to call.
msgTextstringText message to send.
msgNumuintMessage number.
msgAudiostringAudio message content (optional).
msgFilestringPath to a message file (optional).

Response

HTTP 200 OK — A boolean (true if succeeded, false if failed).

Example

Request:

POST /localhost/alertws/api/v1/call/users
Authorization: Bearer {access_token}
Content-Type: application/json

Body:

{
"userIds": [1, 3],
"msgText": "Test call users 1 and 3",
"msgNum": 1,
"msgAudio": null,
"msgFile": null
}

Response:

true

GET /api/v1/call/histories

Retrieves the list of call histories.

remarque

The full parameter list and detailed endpoint documentation will be available in a future release.