Skip to main content

Subscribe API (Beta)

In Beta Phase

This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai.

The Subscribe API allows you to connect to a conversation or a meeting in listen-only mode.

Using this API, you can allow users to subscribe to webinars or conferences where there are only a handful of speakers and most participants are only listening in.

While users connected on websocket are charged per user, the listen-only participants can stream the transcription and insight services at no cost.

This can be turned on or off for a conversation, on demand.

API Endpoint#

wss://api.symbl.ai/v1/subscribe/{connectionId}?access_token={accessToken}

This is a WebSocket endpoint that lets you subscribe to all the real-time updates. Often, this URL is auto-generated by services such as the inbound-stream-integeration.

ParameterRequiredValue
connectionIdMandatoryThe same connectionId that is generated with the Streaming API can be used to subscribe to this API.
accessTokenMandatoryThe Symbl's Authentication token you get from the Authentication process.

Response Body#

Example of the message_response object:

{
"type": "message_response",
"messages": [
{
"from": {
"name": "Jane",
"userId": "jane.doe@example.com"
},
"payload": {
"content": "I was very impressed by your profile, and I am excited to know more about you.",
"contentType": "text/plain"
}
},
{
"from": {
"name": "Jane",
"userId": "jane.doe@example.com"
},
"payload": {
"content": "So tell me, what is the most important quality that you acquired over all of your professional career?",
"contentType": "text/plain"
}
}
]
}

Example of the insight_response object:

{
"type": "insight_response",
"insights": [
{
"type": "question",
"text": "So tell me, what is the most important quality that you acquired over all of your professional career?",
"confidence": 0.9997962117195129,
"hints": [],
"tags": []
},
{
"type": "action_item",
"text": "Jane will look into the requirements on the hiring for coming financial year.",
"confidence": 0.9972074778643447,
"hints": [],
"tags": [
{
"type": "person",
"text": "Jane",
"beginOffset": 0,
"value": {
"value": {
"name": "Jane",
"alias": "Jane",
"userId": "jane.doe@example.com"
}
}
}
]
}
]
}