Send Message To Sessions

Send Message To Sessions

Sends the message to user sessions

Request
URI
POST
https://{api_host}//localhost/rest/inventory/v1/sessions/action/send-message
COPY
Request Body

Message information object to be sent to sessions.

SessionSendMessageSpec of type(s) application/json
Required 
{
    "message": "Sample Info Message",
    "message_type": "INFO",
    "session_ids": [
        "7cdd624f-37d1-46c1-ab96-695a5d13956f"
    ]
}
string
message
Required

Message to be sent to session(s).

string
message_type
Required

Type of message to be sent to session(s).

  • ERROR: Message is of error type.
  • WARNING: Message is of warning type.
  • INFO: Message is of information type.
Possible values are : ERROR, WARNING, INFO,
array of string
session_ids
Required

List of session ids to which message is to be sent

Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "error_messages": [
            "Entity does not exists.",
            "Property is mandatory."
        ],
        "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
        "status_code": 200,
        "timestamp": 1561939200000
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

On This Page
Inventory Operations
POST
Add Machines
POST
Add Machines By Name
POST
Assign Users
POST
Create Application Pool
DELETE
Delete Application Pool
DELETE
Delete Machine
DELETE
Delete Machines
POST
Disconnect Sessions
POST
Enter Maintenance
POST
Exit Maintenance
GET
Get Application Icon
GET
Get Application Pool
GET
Get Desktop Pool
GET
Get Desktop Pool V2
GET
Get Farm
GET
Get Machine Using GET
GET
Get Session Info
GET
List Application Icons
GET
List Application Pools
GET
List Desktop Pools
GET
List Desktop Pools V2
GET
List Farms
GET
List Installed Applications
GET
List Installed Applications 1
GET
List Machines Using GET
GET
List Session Info
POST
Log Off Sessions
POST
Rebuild Machines
POST
Recover Machines
POST
Remove Machines
POST
Reset Machines
POST
Reset Sessions
POST
Restart Machines
POST
Restart Sessions
POST
Send Message To Sessions
POST
Unassign Users
PUT
Update Application Pool