Create Message

Posts a message to an existing stream.

Last updated 8 months ago

Was this helpful?

Create Message

Posts a message to an existing stream.

You can specify one or more attachments to the message. The attachment file can be uploaded along with the message using this endpoint.
You can also specify as part of the message, and use with these objects. See Use Apache FreeMarker Templates section below.
Interactive Elements can be sent with your messages. See Sending messages with Symphony Elements section below.
For authentication, you must either use the sessionToken that was created for delegated application access, or both the sessionToken and keyManagerToken together.
When calling this as an , use the token for sessionToken.

🚧 Known Limitations
You can’t send a message that contains only an attachment without any message content. message must contain a least one space.
DLP (Expression Filters) only works with 1.53 version onwards.
Symphony Elements only works with 1.55.3 version onwards.
To send messages to not public rooms, the caller needs to be part of the stream.
Attachments: The limit is set to 30Mb total size; also, it is recommended not to exceed 25 files.

Sending messages with Symphony Elements

Sending Symphony Elements is only supported for SYSTEM users (Service Accounts).

Use Apache FreeMarker Templates

Important! To support the use of Freemarker variables, the top-level variable name in the div or span tag in <messageML> must be $entity or $data.

See also cURL - Message + Data in the examples below.

<messageML>
	<div>Messages for user <b>${data["messageList"].user.userName}</b>:</div>
	<table>
		<#list data["messageList"].messages as msg>
		<tr>
			<td>${msg.timestamp}</td>
			<td>${msg.text}</td>
		</tr>
		</#list>
	</table>
</messageML>

{
  "messageList": {
    "version": "1.0",
    "user": {
      "id": 123456,
      "userName": "bot.user01"
    },
    "messages": [
      {
        "timestamp": "1504736061894",
        "text": "Ping"
      },
      {
        "timestamp": "1504736023993",
        "text": "Pong"
      }
    ]
  }
}

<div data-format="PresentationML" data-version="2.0">
   <div>Messages for user <b>bot.user01</b>:</div>
   <table>
      <tr>
         <td>1504736061894</td>
         <td>Ping</td>
      </tr>
      <tr>
         <td>1504736023993</td>
         <td>Pong</td>
      </tr>
   </table>
</div>

Other request examples

curl -X POST \
  https://acme.symphony.com/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \
  -H 'Content-Type: multipart/form-data' \
  -H 'sessionToken: SESSION_TOKEN' \
	-H 'keyManagerToken: KEY_MANAGER_TOKEN' \
  --form-string 'message=<messageML>Hello world!</messageML>'

curl -X POST \
  https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \
  -H 'content-type: multipart/form-data' \
  -H 'keyManagerToken: KEY_MANAGER_TOKEN' \
  -H 'sessionToken: SESSION_TOKEN' \
  --form-string 'message=<messageML>Hello world!</messageML>' \
  -F 'attachment=@image1.png' \
  -F 'attachment=@image2.png'

curl -X POST \
https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \
  -H 'Content-Type: multipart/form-data' \
  -H 'keyManagerToken: KEY_MANAGER_TOKEN' \
  -H 'sessionToken: SESSION_TOKEN' \
  --form-string 'message=<messageML>This is an <div class="entity" data-entity-id="object001"><b>important</b></div> message.</messageML>' \
  -F 'data={
    "object001":
    {
        "type":     "org.symphonyoss.taxonomy",
        "version":  "0.1",
        "id":
        [
            {
                "type":     "org.symphonyoss.taxonomy.keyword",
                "value":    "important"
            }
        ]
    }
}'

curl -X POST \
  https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \

-H "sessionToken: SESSION_TOKEN" \
-H "keyManagerToken: KEY_MANAGER_TOKEN" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "message='<messageML>Hello world</messageML>'&data='{'foo':'bar'}'"

curl -X POST \
  https://acme.symphony.com:443/agent/v4/stream/xFfPil_o26qXzGwWvcw5RH___qQr0W7EdA/message/create \

-H "sessionToken: SESSION_TOKEN" \
-H "keyManagerToken: KEY_MANAGER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
        "message": "<messageML>Hello world</messageML>",
        "data": "{\"foo\":\"bar\"}"
    }'

📘 See also

Last updated 8 months ago

Was this helpful?

POST /agent/v4/stream/{sid}/message/create HTTP/1.1 Host: youragentURL.symphony.com sessionToken: text Content-Type: multipart/form-data Accept: */* Content-Length: 90 { "message": "text", "data": "text", "version": "text", "attachment": "binary", "preview": "binary" }

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

🚧 Known Limitations

Sending messages with Symphony Elements

Use Apache FreeMarker Templates

Other request examples

🚧 Known Limitations

Sending messages with Symphony Elements

Use Apache FreeMarker Templates

Other request examples

Post a message to one existing stream.