Sign in

v1

latestOpenAPI 3.1.02026-07-24174964.1 KB
Contas

Criar conta

A organização pode ter várias contas, permitindo separar scripts e convites por produto, time ou necessidade específica. O organizationId da conta é definido a partir do token (credenciais da organização).

post/api/v1/account

Request body

biometricProvider'idwall' | 'serpro'

Provedor biométrico principal

colorstring

Cor em hexadecimal para personalização visual. Necessário informar color ou styleId

companyIdstring

Identificador da empresa no Nuvidio Call para redirecionamento em transbordo

contractedIntelligencesstring[]

Lista de inteligências contratadas

idstring

Identificador da conta

logostring required

Logo da conta (URL ou Base64)

namestring required

Nome da conta

organizationIdstring

Identificador da organização. Substituído pelo ID da organização do token

slugstring required

Identificador amigável para o cliente no acesso ao convite

styleIdstring

ID do template de estilo. Alternativa ao color

transcriptionProvider'bot_runner'

Provedor de transcrição. Padrão: bot_runner

videoProvider'daily'

Provedor de vídeo. Padrão: daily

Example request

{
  "biometricProvider": "idwall",
  "color": "#112233",
  "companyId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "contractedIntelligences": [
    "lipsync"
  ],
  "id": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "logo": "https://exemplo.com/logo.png",
  "name": "Minha Empresa",
  "organizationId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "slug": "minha-empresa",
  "styleId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "transcriptionProvider": "bot_runner",
  "videoProvider": "daily",
  "whatsappConfig": {
    "apiKey": "abc123",
    "apiSecret": "secret456",
    "pathParams": {
      "nome": "João"
    },
    "template": "meu_template"
  }
}

Response

Conta criada com sucesso

biometricProvider'idwall' | 'serpro'

Provedor biométrico

colorstring

Cor em hexadecimal

companyIdstring

Identificador da empresa no Nuvidio Call para redirecionamento em transbordo

contractedIntelligencesContractedIntelligence[]

Lista de inteligências contratadas

createdAtstring

Data e hora de criação

idstring

Identificador da conta

logostring

Logo da conta

namestring

Nome da conta

organizationIdstring

Identificador da organização

slugstring

Identificador amigável da conta

styleIdstring

Identificador do template de estilo

transcriptionProvider'bot_runner'

Provedor de transcrição

updatedAtstring

Data e hora da última modificação

videoProvider'daily'

Provedor de vídeo

Example response

{
  "biometricProvider": "idwall",
  "color": "#112233",
  "companyId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "contractedIntelligences": [
    "lipsync"
  ],
  "createdAt": "2025-03-01T10:00:00Z",
  "id": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "logo": "https://exemplo.com/logo.png",
  "name": "Minha Empresa",
  "organizationId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "slug": "minha-empresa",
  "styleId": "878a4881-8fd3-46ce-91ad-06f37256b62e",
  "transcriptionProvider": "bot_runner",
  "updatedAt": "2025-03-01T10:00:00Z",
  "videoProvider": "daily",
  "whatsappConfig": {
    "apiKey": "abc123",
    "apiSecret": "secret456",
    "pathParams": {
      "nome": "João"
    },
    "template": "meu_template"
  }
}