Triggering recordings from your app
https://app.siro.ai/record?action={action}&redirectUrl={redirectUrl}
action
(required) can be one of the following: start | stop | restart
start
starts a new recording, or opens the siro app and continues a recording if one is paused or is already recording.
stop
fully stops a recording in progress. This will skip past the paused state, and end the recording entirely. This will skip past any post recording debrief screenβs as well.
restart
fully stops a recording, and restarts a brand new recording.
opportunityId
Optional
The opportunityId
param accepts a string and will automatically link this recording with the associated opportunity in Siro. Opportunities are deals that can stretch over multiple appointments.
Important Note: This Parameter is only valid for start
and restart
actions. If used with a restart action, the new recording that is started will be linked to that opportunity.
See PUT Sync Opportunities:
Deprecated: the jobId
param can also be used. Siro treats this as the opportunityId
redirectUrl
(optional) is an optional encoded url that the app will use to redirect after the given action is performed.
Important Notes:
/
character becomes %2f
.yourApp://
), you will need to ask the Siro team to whitelist your app in our next deployment. Please reach out to vince@siro.ai
. It may take weeks to get your app whitelisted, so plan accordingly.title
Optional
The title
param accepts a string and will set the recording title.
Important Note: This Parameter is only valid for start
actions.
appointmentId
Optional
The appointmentId
param accepts a string and will automatically link this recording with the associated appointment in Siro.
Important Note: This Parameter is only valid for start
and restart
actions. If used with a restart action, the new recording that is started will be linked to that opportunity.