Skip to main content

​
Overview

Sales is hard. Empower your sales team by giving them an automatic recording experience. The Siro app accepts deep links to start and stop recordings and then redirects you back to your app. This lets you create an experience for sales reps that starts and ends recordings nearly automatically.

​
Best Practices

Good 👍: Sales reps don’t need to change their current behavior, but suddenly all of their conversations are recorded for them. The experience feels magical. Bad 👎: Making your sales reps tap an extra button to start and stop recordings. This is a tedious experience that feels like more work. Worst of all, reps will sometimes forget to record and lose critical conversation intelligence.
  • If a recording is already in progress, it will not be interrupted
  • Deep links will skip all post-recording debrief screens

​
Recording Action Links

​
URL Format

https://app.siro.ai/record?action={action}&redirectUrl={redirectUrl}

​
Parameters

​
action (required)

Can be one of the following: start, stop, or restart
  • start - Starts a new recording, or opens the Siro app and continues a recording if one is paused or already recording
  • stop - Fully stops a recording in progress. This will skip past the paused state and end the recording entirely. This will also skip past any post-recording debrief screens
  • restart - Fully stops a recording and restarts a brand new recording

​
title (optional)

The title parameter accepts a string and will set the recording title. This parameter is only valid for start actions.

​
redirectUrl (optional)

An optional encoded URL that the app will use to redirect after the given action is performed. Important Notes:
  • All URL parameters in the link need to be URL encoded (e.g., the / character becomes %2F)
  • We recommend backlinking to your app using Universal Links (iOS) and App Links (Android). Otherwise, if you are using an app schema to redirect to your app (example: 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.

​
integrationConnectionId (optional)

An optional connection ID the app will use to identify the CRM integration. Organization admins can create integration connection IDs in the web app’s integrations page. Important Notes:
  • This is required for the crmObjects parameter to be accepted
  • This parameter is only valid for start and restart actions

​
crmObjects (optional)

A URL-encoded array of CRM objects that relate to the recording.

​
CRM Object Structure

type CRMObject = {
  objectType:
    | "Lead"
    | "Account"
    | "Contact"
    | "Opportunity"
    | "Event"
    | "ServiceAppointment";
  objectId: string;
};

​
Object Properties

  • objectType - The recording’s relationship to entities in the CRM. Must be one of: Lead, Account, Opportunity, Event, or ServiceAppointment
  • objectId - The ID of the entity in the CRM

​
Full Example:

// Before URL encoding
[
  {
    objectType: "Lead",
    objectId: "lead123"
  },
  {
    objectType: "Opportunity",
    objectId: "opp456"
  }
]

// After URL encoding
[{"objectType"%3A"Lead"%2C"objectId"%3A"lead123"}%2C{"objectType"%3A"Opportunity"%2C"objectId"%3A"opp456"}]
Note: The array must be URL-encoded to be properly accepted.
  • integrationConnectionId is required for the crmObjects parameter to be accepted
  • 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

​
opportunityId (optional) (deprecated)

The opportunityId parameter 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 Notes:
  • 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 parameter can also be used. Siro treats this as the opportunityId. Deprecated: The opportunityId parameter is also being replaced with integrationConnectionId and crmObjects. New integrations should use these parameters instead.
⌘I