Blast Message

Posts a message to multiple existing streams.

Available on Agent 2.62.0 and above. Starting with Agent 23.6, this endpoint is OBO-enabled.

Post a message to multiple existing streams.

Post a new message to the given list of streams. The stream can be a chatroom, an IM or a multiparty IM.

You may include an attachment on the message.

The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.

The optional parameter "data" can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in "data-entity-id" element attributes), this parameter is required.

If the message is in MessageML and fails schema validation a client error results

This endpoint is idempotent, it means that a 200 response will be returned even if the message has not been delivered to some streams. Check the errors map from the response in order to see on which stream(s) the message has not been delivered.

The maximum number of streams where the message can be sent is limitted to 100.

Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together.

POSTyouragentURL.symphony.com/agent/v4/message/blast

Header parameters

Body

multipart/form-data

sids*array of string

A comma-separated list of Stream IDs

messagestring

The message payload in MessageML.

datastring

Optional message data in EntityJSON.

versionstring

Optional message version in the format "major.minor". If empty, defaults to the latest supported version.

attachmentstring (binary)

Optional file attachment.

previewstring (binary)

Optional attachment preview.

Response

200400401403451500

Blast message sent.

Body

application/json

messages*array of V4Message (object)

List of messages successfully sent

errors*object

List of streams where the messages ingestion has failed

Request

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v4/message/blast', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "sids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "messages": [
    {
      "messageId": "text",
      "parentMessageId": "text",
      "message": "text",
      "data": "text",
      "attachments": [
        {
          "id": "text",
          "name": "text",
          "images": [
            {
              "id": "text",
              "dimension": "text"
            }
          ]
        }
      ],
      "user": {
        "firstName": "text",
        "lastName": "text",
        "displayName": "text",
        "email": "text",
        "username": "text"
      },
      "stream": {
        "streamId": "text",
        "streamType": "text",
        "roomName": "text",
        "members": [
          {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        ],
        "external": false,
        "crossPod": false
      },
      "externalRecipients": false,
      "diagnostic": "text",
      "userAgent": "text",
      "originalFormat": "text",
      "disclaimer": "text",
      "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
      "replacing": "text",
      "replacedBy": "text",
      "initialMessageId": "text",
      "silent": false
    }
  ]
}

Blast Message enables you to post a new message to a given list of streams (each stream can either be a chatroom, an IM or a multiparty IM). It also includes all capabilities and limitations from Create Message V4 endpoint (i.e. using Symphony Elements, Apache FreeMarker Template, etc.) Please check Create Message V4 where you will find those capabilities and limitations

Please note that the blast message is not transactional, so you could have some failures sending some messages while others are successfully sent; for this reason, the service returns 200 OK even in case of error (i.e. there is an incorrect stream id within the list of sids provided). But in this case, each message failed is detailed.

🚧 Known Limitations

• Considering performance purposes for encryption/decryption, the maximum number of stream Ids is set to 100. In case you want to send more messages, you will need to perform multiple requests to the endpoint.

• See Create Message V4 for more information about other limitations

📘 See also

Create Message V4 Message MessageML Message ID Message Format - MessageML PresentationML Message Format - ExtensionML Colors Symphony Elements