Overview
Send a notification to a User's device
Send a notification to a User's device
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/{reqUserId}/notify.html?token=XXXXXXXX&userId={userId}
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/user/{reqUserId}/notify.html?token=XXXXXXXX&userId={userId}
Arguments
| clientId required |
MobiWork assigned unique ID of the company |
| versionNumber required |
Version number of MobiWork API SDK release. Current version is: 10.0.78 |
| token required |
Part of URL as a request parameter and is required in every call to verify access to API calls |
| reqUserId required |
The identifier of the user to be notified |
| userId optional |
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID |
Return
Returns a success message on success or errors on fail.
Returns a success message on success or errors on fail.
Request Body XSD
Response Body XSD
Curl Example
| HTTP Method: | POST |
| Request: | curl -k -X POST "https://www.mobiwork.com/api/rest/12014/10.0.78/user/1224/notify.html?token=COJL8X2FKSLMMRTYCH2B" -data '<message>Test message</message>' |
| Response: | <?xml version="1.0" encoding="UTF-8" ?><response version="10.0.78" statusCode="1">Successfully sent notification.</response> |