Passer à la navigation

API Reception

Créez et gérez les Workspaces Reception.ai de vos clients depuis vos propres systèmes.

L’API Reception permet à un revendeur Reception.ai d’effectuer par code ce que le panneau d’administration du revendeur permet de faire manuellement : créer un Workspace pour chaque client, lui vendre l’un de vos forfaits, configurer sa réceptionniste et suivre les montants facturés sur votre carte. Chaque endpoint se trouve sous https://api.elevenlabs.io/v1/reception et est disponible dans les SDK Python et TypeScript sous le nom reception.

Le panneau d’administration des revendeurs, et donc l’API Reception, est réservé aux partenaires Reception.ai. Si vous souhaitez devenir partenaire, contactez notre équipe commerciale.

Authentification

Créez une clé API dans le panneau d’administration du revendeur. Seules les clés créées à cet endroit peuvent appeler l’API Reception ; toute autre clé API ElevenLabs est rejetée avec not_a_reseller_api_key. La clé n’est affichée qu’une fois, conservez-la donc dans un gestionnaire de secrets.

Envoyez la clé dans l’en-tête xi-api-key, ou définissez ELEVENLABS_API_KEY pour que le SDK la lise.

Endpoints des revendeurs et des Workspaces

L’API agit à deux niveaux.

NiveauAgit surGroupes SDK
RevendeurVotre compte revendeurworkspaces, tiers, subscriptions, billing
WorkspaceLe Workspace d’un client, indiqué dans xi-workspace-idbusiness_profile, receptionists, phone_numbers, services, staff, locations, holidays, products, assets, knowledge_sources, team

Les endpoints de Workspace nécessitent l’en-tête xi-workspace-id, défini sur l’ID d’un Workspace que vous avez créé. Une requête sans cet en-tête, ou visant un Workspace appartenant à un autre revendeur, est rejetée. Dans les SDK, cet en-tête correspond à l’argument xi_workspace_id en Python et au champ xiWorkspaceId en TypeScript.

from elevenlabs import ElevenLabs
elevenlabs = ElevenLabs()
workspaces = elevenlabs.reception.workspaces.list(page_size=50)
for workspace in workspaces.workspaces:
print(workspace.workspace_id, workspace.business_name, workspace.billing_tier)
staff = elevenlabs.reception.staff.list(
xi_workspace_id=workspaces.workspaces[0].workspace_id,
)

Pagination

workspaces.list et billing.list_invoices renvoient une page à la fois. Transmettez le next_cursor d’une réponse comme cursor pour obtenir la page suivante, puis arrêtez-vous lorsque has_more est false.

Limites de débit

Les limites s’appliquent par revendeur, pour l’ensemble de ses clés API :

RequêtesLimite
Lectures (GET)600 par minute
Écritures (toutes les autres méthodes)120 par minute

Toute requête dépassant la limite renvoie 429. Attendez, puis réessayez.

Étapes suivantes

  • Guide de démarrage : créez le Workspace d’un client et attribuez un numéro de téléphone à sa réceptionniste.
  • Provisionnement et intégration : exemples pour créer des Workspaces en masse et ajouter les établissements, le personnel, les services et les paramètres de réceptionniste d’une entreprise.
  • Abonnements et facturation : modifiez le forfait d’un client et consultez les montants facturés sur votre carte.