Send a Message
This service enables various types of message to be sent from a single call e.g. send the same message to:
The devices of 1 Resource Group
The mobile phones identified by 3 Resource Ids
The JobWatch Messages inbox of 3 web users identified by web user Ids
The mobile phones identified by 2 telephone numbers
Two email addresses
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | MessageSend | Required |
Body | String | Message body text - Maximum length: 1000 | Required |
ResourceIdsDevice | String | A comma delimited list of resource Ids to send device message to | Optional |
ResourceIdsMobile | String | A comma delimited list of resource Ids to send SMS to | Optional |
WebUserIds | String | A comma delimited list of user Ids to send JobWatch message to | Optional |
MobileNumbers | String | A comma delimited list of mobile numbers in format +447954012012, to send SMS to (numbers don't have to be assigned to a web user) | Optional |
ResourceGroupIds | String | A comma delimited list of resource group Ids to send device message to | Optional |
Emails | String | A comma delimited list of email addresses to send email to (don't have to be assigned to a web user) | Optional |
AllResources | Bool | A flag determining if the message is sent to all devices belonging to Resources - Defaults to false | Optional |
Answers | String | A comma delimited list of buttons to show on a device message - e.g. "Yes,No" | Optional |
Subject | String | Subject field of message - Maximum length: 50 | Optional |
ThreadId | Int | Message thread Id | Optional |
ParentId | Int | Message parent Id | Optional |
EntityType | Int | Entity type relating to message - Job = 1, ContactNote = 2 | Optional |
EntityId | Int | Entity Id relating to message | Optional |
Urgent | Bool | A flag determining if the message is treated as urgent - Defaults to false | Optional |
DateTimeToSend | DateTime | A future UTC date & time to send the message | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | null | |
2 | msg.Error | |
2 | Misc.Lang(misc_noRight | |
2 | An error occurred |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=messagesend
Response Data
{ "Code": 0, "Result": [ { "ResourceId": "12345" } ] }