MessageML supports the following tags to embed additional information into messages:
Tag
Description
Optional attributes
<mention uid="123456789"/>
Insert a mention for the user whose Symphony userid is 123456789.
<mention email="user@music.org"/>
Insert a mention for the user whose email address is user@music.org.
• strict=true, the API will throw an error if no user of that email address exists. (default)
• strict=false . Message is accepted even if the user cannot be resolved.
<hash tag="label"/>
Insert "label" as a free-text hashtag.
<cash tag="ticker"/>
Insert "ticker" as a free-text cashtag. Important: when sending numeric cashtags as signals, add a * after the $ sign, for example, $_122450. <messageML> `<cash tag="$_122450"/> `\
Note: Cashtags are deprecated. Please use the <tag /> notation for financial instruments.
<tag />
Note: This feature is not yet available in production. It will be released in the coming months.
Insert a financial instrument (enhanced tag) in your message, coming from our reference database.
To identify an instrument, you'll need to provide at least one identifier (e.g. an ISIN), and optionally some filters if your identifier is not specific enough.
You can also specify a fallback-ticker that will act as a free-text tag (workaround) if we are not able to find the instrument referenced.
Identifiers:
fullbbgcompticker
figi
bbgcompticker
us-code
isin
local-code
Filters:
instrument-class
bbgmarket-sector
return-main-listing
country-code
operational-mic
Others:
fallback-ticker
<chime />
Send a chime alert.
Note: No other content (even line breaks) is permitted with a <chime/> tag. Please see an example of the messageML to send a chime below.
Examples
Here after you can find an example of a message sent by a bot and containing these tags specific to Symphony as well as the structure of the messageML sent:
Mentions
<messageML> <br/><span>Mention with an email: </span> <mentionemail="pierre.neu@symphony.com"/> <br/><span>Mention with a user Id: </span> <mentionuid="71811853190567"/></messageML>
Below several examples of financial instruments, using different types of identifiers and filters.
When identifiers and filters are not sufficient to identify a unique match, or when an instrument is not found in our reference database, an error is returned, except if a fallback-ticker is specified.
<messageML> <tableclass="pasted-table"> <thead> <tr> <th>Identifiers and filters</th> <th>Tag</th> <th>Comment</th> </tr> </thead> <tbody> <tr> <td>FullBBGCompTicker</td> <td><tagfullbbgcompticker="TSLA US Equity"/></td> <td># unique if found</td> </tr> <tr> <td>Figi</td> <td><tagfigi="BBG000N9P426"fallback-ticker="TSLA"/></td> <td># unique if found</td> </tr> <tr> <td>BBG Comp ticker on Market sector</td> <td><tagbbgcompticker="TSLA US"bbgmarket-sector="Equity"fallback-ticker="TSLA"/></td> <td># unique if found</td> </tr> <tr> <td>Figi ticker</td> <td><tagfigi-ticker="TSLA UW"fallback-ticker="TSLA"/></td> <td># likely unique, may need filters</td> </tr> <tr> <td>BBG Comp ticker</td> <td><tagbbgcompticker="TSLA US"fallback-ticker="TSLA"/></td> <td># likely unique, may need filters</td> </tr> <tr> <td>US Code</td> <td><tagus-code="88160R101"fallback-ticker="TSLA"/></td> <td># likely NOT unique listing for stocks, need filters.</td> </tr> <tr> <td>US Code on Main listing</td> <td><tagus-code="88160R101"return-main-listing="true"fallback-ticker="TSLA"/></td> <td># ask SYM to return the instrument listed on primary exchange</td> </tr> <tr> <td>ISIN</td> <td><tagisin="US88160R1014"fallback-ticker="TSLA"/></td> <td># likely NOT unique listing for stocks, need filters.</td> </tr> <tr> <td>ISIN on Main listing</td> <td><tagisin="US88160R1014"return-main-listing="true"fallback-ticker="TSLA"/></td> <td># ask SYM to return the instrument listed on primary exchange</td> </tr> <tr> <td>Local code</td> <td><taglocal-code="TSLA"fallback-ticker="TSLA"/></td> <td># likely NOT unique listing for stocks, need filters.</td> </tr> <tr> <td>Local code with Country</td> <td><taglocal-code="TSLA"country-code="US"fallback-ticker="TSLA"/></td> <td># likely unique listing for US stocks</td> </tr> <tr> <td>Local code with MIC</td> <td><taglocal-code="TSLA"operational-mic="XNAS"fallback-ticker="TSLA"/></td> <td># likely unique listing</td> </tr> <tr> <td>Local code with MIC and instrument class</td> <td><taglocal-code="TSLA"operational-mic="XNAS"instrument-class="equity"fallback-ticker="TSLA"/></td> <td># likely unique listing</td> </tr> <tr> <td>Fallback ticker</td> <td><tagfallback-ticker="TSLA"/></td> <td>Always include a fall back to ensure the message will be accepted.</td> </tr> </tbody> </table></messageML>