Ir para a navegação

API do Reception

Crie e gerencie os espaços de trabalho Reception.ai dos seus clientes usando seus próprios sistemas.

A API do Reception permite que um revendedor do Reception.ai faça por código o que o painel de administração do revendedor faz manualmente: criar um espaço de trabalho para cada cliente, vender a ele um dos seus planos, configurar sua recepcionista e acompanhar as cobranças no seu cartão. Todos os endpoints ficam em https://api.elevenlabs.io/v1/reception e estão disponíveis nos SDKs de Python e TypeScript como reception.

O painel de administração do revendedor e, com ele, a API do Reception estão disponíveis apenas para parceiros do Reception.ai. Se você tem interesse em ser nosso parceiro, entre em contato com nossa equipe de vendas.

Autenticação

Crie uma chave de API no painel de administração do revendedor. Apenas chaves criadas nele podem chamar a API do Reception; qualquer outra chave de API da ElevenLabs é rejeitada com not_a_reseller_api_key. A chave é exibida apenas uma vez, então armazene-a em um gerenciador de segredos.

Envie a chave no cabeçalho xi-api-key ou defina ELEVENLABS_API_KEY e deixe o SDK lê-la.

Endpoints de revendedor e espaço de trabalho

A API atua em dois níveis.

NívelAtua emGrupos do SDK
RevendedorSua conta de revendedorworkspaces, tiers, subscriptions, billing
Espaço de trabalhoEspaço de trabalho de um cliente, identificado em xi-workspace-idbusiness_profile, receptionists, phone_numbers, services, staff, locations, holidays, products, assets, knowledge_sources, team

Os endpoints de espaço de trabalho exigem o cabeçalho xi-workspace-id, definido como o ID de um espaço de trabalho que você criou. Uma solicitação sem ele, ou para um espaço de trabalho que pertence a outro revendedor, é rejeitada. Nos SDKs, o cabeçalho é o argumento xi_workspace_id em Python e o campo xiWorkspaceId em 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,
)

Paginação

workspaces.list e billing.list_invoices retornam uma página por vez. Passe o next_cursor de uma resposta como cursor para obter a próxima página e pare quando has_more for false.

Limites de taxa

Os limites se aplicam por revendedor, em todas as suas chaves de API:

SolicitaçõesLimite
Leituras (GET)600 por minuto
Gravações (todos os outros métodos)120 por minuto

Uma solicitação acima do limite retorna 429. Aguarde e tente novamente.

Próximas etapas

  • Início rápido: crie o espaço de trabalho de um cliente e coloque a recepcionista dele em um número de telefone.
  • Provisionamento e integração: exemplos para criar espaços de trabalho em massa e adicionar locais, equipe, serviços e configurações da recepcionista de uma empresa.
  • Assinaturas e cobrança: altere o plano de um cliente e veja as cobranças no seu cartão.