White-label domains and embedded access

Manage reseller domains and open the GetVoiceBot application inside a trusted customer experience.

White-label domains and application embedding are optional reseller capabilities. They are not required for an organization operating its own Agents.

Manage reseller domains

The White-label Domains API operates on the authenticated reseller:

  1. Read GET /api/v2/domains.
  2. Register a domain with POST /api/v2/domain after completing the domain setup provided during GetVoiceBot onboarding.
  3. Re-read the list and confirm the domain appears.
  4. Select it with POST /api/v2/domain/default when it should become the reseller's default.
  5. Re-read the list and verify exactly one intended domain is marked default:true.

The current default domain cannot be removed. Select another registered default first, then use DELETE /api/v2/domain with the exact domain in the domain query parameter. Re-read the domain list after removal.

Domain registration does not prove DNS, certificate, or application availability. Open the final HTTPS URL and verify the customer-facing experience before announcing it.

Embed authenticated GetVoiceBot access

Generate one-time authentication tokens only from your trusted backend:

  1. Resolve the customer organization using your stored GetVoiceBot account ID or externalAccountId.
  2. Verify that the signed-in user belongs to that customer in your own system.
  3. Call GET /api/v2/auth/account/oneTimeAuthToken with the user's email and, when needed, the customer's external account ID.
  4. Return only the short-lived token and required embed data to your frontend.
  5. Load https://<your-gvb-domain>/app/embed with the URL-encoded authToken and email query values.

Never send your long-lived GetVoiceBot API token to the browser. The embedded user's email must match the account authenticated by the one-time token.

The embed page also accepts documented onboarding prefill values and a same-origin GetVoiceBot application redirectUrl. Treat every prefill value as a suggestion: the resulting organization and Agent still need normal read, test, publish, and verification steps.

For a complete integration example, see Embed the GetVoiceBot app.

Open the app All docs