Calls Service
POST /api/v1/call/groups
Calls all users from the specified call groups.
note
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
| Property | Type | Description |
|---|---|---|
userIds | array of uint | List of user IDs to call. |
msgText | string | Text message to send. |
msgNum | uint | Message number. |
msgAudio | string | Audio message content (optional). |
msgFile | string | Path 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.
note
The full parameter list and detailed endpoint documentation will be available in a future release.