POST restapi/personal/instantmessages/broadcast/v1

Send a broadcast instant message. Creates a new thread for a new broadcast message.

Request Information

URI Parameters

None.

Body Parameters

Itslearning.RestApi.Entities.BroadcastInstantMessageToSend

Name	Description	Type	Additional information
SenderName	The name of the sender (can be site or a school name or custromized by admin) to assign as the thread's name	string	None.
SenderHierarchyId	Id of sender's hierarchy	integer	None.
CourseIds	CourseIds to send instant message to.	Collection of integer	None.
ProjectIds	ProjectIds to send instant message to.	Collection of integer	None.
HierarchyIds	HierarchyIds to send instant message to.	Collection of integer	None.
RecipientRoles	The list of roles in specified hierarchies to send instant message to.	Collection of Itslearning.RestApi.Entities.InstantMessageRecipientRole	None.
ProfileIds	The list of person profile ids to send instant message to.	Collection of integer	None.
FileIds	Guids of files already uploaded to temporary file repo storage	Collection of string	None.
ToPersonIds	PersonIds to send instant message to. A new thread will be created if the persons don't have an existing thread already. The ToPersonIds or the InstantMessageThreadId or CourseIds or ProjectIds need to have a valid value.	Collection of integer	None.
InstantMessageThreadId	The thread to send to, if this is null or zero we will assume it's a new thread.	integer	None.
Text	The text of the message	string	None.
SendAsIndividualMessages	Gets whether a message to multiple recipients should be sent as individual messages	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SenderName": "sample string 1",
  "SenderHierarchyId": 2,
  "CourseIds": [
    1,
    2
  ],
  "ProjectIds": [
    1,
    2
  ],
  "HierarchyIds": [
    1,
    2
  ],
  "RecipientRoles": [
    "Guest",
    "Guest"
  ],
  "ProfileIds": [
    1,
    2
  ],
  "FileIds": [
    "sample string 1",
    "sample string 2"
  ],
  "ToPersonIds": [
    1,
    2
  ],
  "InstantMessageThreadId": 1,
  "Text": "sample string 3",
  "SendAsIndividualMessages": true
}

application/xml, text/xml

Sample:

<BroadcastInstantMessageToSend xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
  <InstantMessageThreadId>1</InstantMessageThreadId>
  <SendAsIndividualMessages>true</SendAsIndividualMessages>
  <Text>sample string 3</Text>
  <ToPersonIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ToPersonIds>
  <SenderHierarchyId>2</SenderHierarchyId>
</BroadcastInstantMessageToSend>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.