RillaRilladevelopers
Go to Rilla
DocumentationGuidesFull reference

Mobile deep links

Start, stop, pause, and resume recordings from your app.

Open Rilla with a URL

The mobile URL scheme is com.rillavoice://recording. Open the link with your platform’s URL-opening API. No Rilla API key is required for the URL scheme.

ActionURL
startcom.rillavoice://recording?start=true
stopcom.rillavoice://recording?stop=true
pausecom.rillavoice://recording?pause=true
resumecom.rillavoice://recording?resume=true
Build a recording link
const parameters = new URLSearchParams({
  start: 'true',
  event_id: 'appt-1234',
  title: 'Home estimate — Jordan Lee',
  deep_link: 'yourapp://home',
});
const url = `com.rillavoice://recording?${parameters}`;
// Open url using your mobile platform's URL-opening API.

Return to your app

Pass a callback URL as deep_link. After the action, Rilla opens it with c__status=success or c__status=error, plus action and error details when applicable.

Callback examples
yourapp://home?c__status=success&c__action=start

The error example is wrapped for readability. Parse query parameters rather than comparing the entire URL string.

Error handling

Handle errors such as microphone access denied, no active recording, or a recording already in progress. Use c__errorType for programmatic handling and present a useful next step in your app.

All mobile errors & recovery guidance
On this page
← WebhooksErrors & troubleshooting