Skip to main content

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

NameTypeDescriptionRequired
ActionStringMessageSendRequired
BodyStringMessage body text - Maximum length: 1000Required
ResourceIdsDeviceStringA comma delimited list of resource Ids to send device message toOptional
ResourceIdsMobileStringA comma delimited list of resource Ids to send SMS toOptional
WebUserIdsStringA comma delimited list of user Ids to send JobWatch message toOptional
MobileNumbersStringA 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
ResourceGroupIdsStringA comma delimited list of resource group Ids to send device message toOptional
EmailsStringA comma delimited list of email addresses to send email to (don't have to be assigned to a web user)Optional
AllResourcesBoolA flag determining if the message is sent to all devices belonging to Resources - Defaults to falseOptional
AnswersStringA comma delimited list of buttons to show on a device message - e.g. "Yes,No"Optional
SubjectStringSubject field of message - Maximum length: 50Optional
ThreadIdIntMessage thread IdOptional
ParentIdIntMessage parent IdOptional
EntityTypeIntEntity type relating to message - Job = 1, ContactNote = 2Optional
EntityIdIntEntity Id relating to messageOptional
UrgentBoolA flag determining if the message is treated as urgent - Defaults to falseOptional
DateTimeToSendDateTimeA future UTC date & time to send the messageOptional

Response Codes

CodeMessageInformation
0null
2msg.Error
2Misc.Lang(misc_noRight
2An error occurred

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=messagesend