POST api/v3/Messages/SendMessage

Sends a new message to users in the system

Request Information

URI Parameters

None.

Body Parameters

Input data to send a new message

NewMessageInputV3
NameDescriptionTypeAdditional information
Ttl

The title/subject of the message

string

None.

Bdy

The body/content of the message

string

None.

Typ

Type type of the message (0 = Normal\Message, 1 = Callback, 2 = Poll)

integer

None.

Rcps

Who to send the message to

Collection of RecipientResultV3

None.

Request Formats

application/json

Sample:
{
  "Ttl": "sample string 1",
  "Bdy": "sample string 2",
  "Typ": 3,
  "Rcps": [
    {
      "Id": "sample string 1",
      "Typ": 2,
      "Nme": "sample string 3"
    },
    {
      "Id": "sample string 1",
      "Typ": 2,
      "Nme": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<NewMessageInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Messages">
  <Bdy>sample string 2</Bdy>
  <Rcps>
    <RecipientResult>
      <Id>sample string 1</Id>
      <Nme>sample string 3</Nme>
      <Typ>2</Typ>
    </RecipientResult>
    <RecipientResult>
      <Id>sample string 1</Id>
      <Nme>sample string 3</Nme>
      <Typ>2</Typ>
    </RecipientResult>
  </Rcps>
  <Ttl>sample string 1</Ttl>
  <Typ>3</Typ>
</NewMessageInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Created result if the message was sent

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.