PUT
/
api
/
v1
/
bot
/
voice
/
{id}
Atualizar Voice
curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/bot/voice/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "visualIconId": "<string>",
  "visualType": "<string>",
  "transcriptionCredentialId": "<string>",
  "voiceCredentialId": "<string>",
  "language": "<string>",
  "voiceId": "<string>",
  "voiceImage": "<string>",
  "voiceName": "<string>",
  "voiceDescription": "<string>",
  "insertedLabsId": "<string>",
  "model": "<string>",
  "primaryColor": "<string>",
  "buttonColor": "<string>",
  "webPrimaryColor": "<string>",
  "webButtonColor": "<string>",
  "theme": "<string>",
  "textTitle": "<string>",
  "textDescription": "<string>",
  "waitTime": "<string>",
  "callTime": "<string>",
  "voicePrompt": "<string>"
}'
{
  "id": "<string>",
  "botId": "<string>",
  "visualIconId": "<string>",
  "visualType": "<string>",
  "language": "<string>",
  "voiceId": "<string>",
  "voiceName": "<string>",
  "voiceDescription": "<string>",
  "insertedLabsId": "<string>",
  "model": "<string>",
  "primaryColor": "<string>",
  "buttonColor": "<string>",
  "webPrimaryColor": "<string>",
  "webButtonColor": "<string>",
  "theme": "<string>",
  "textTitle": "<string>",
  "textDescription": "<string>",
  "waitTime": 123,
  "callTime": 123,
  "voiceCredentialId": "<string>",
  "bot": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "prompt": "<string>",
    "tags": {},
    "hasVoice": true,
    "isAdvancedBot": true
  },
  "voiceCredential": {
    "id": "<string>",
    "name": "<string>",
    "integrationId": "<string>",
    "status": true,
    "integration": {
      "name": "<string>",
      "type": "<string>",
      "status": true
    },
    "transcriptionCredential": "<string>",
    "voicePrompt": "<string>"
  }
}

Corpo da Requisição

id
string
ID do agente
visualIconId
string
ID opcional do ícone visual.
visualType
string
Tipo opcional de representação visual.
transcriptionCredentialId
string
ID opcional da credencial para serviços de transcrição.
voiceCredentialId
string
ID opcional da credencial para serviços de voz.
language
string
Configuração de idioma para o assistente de voz.
voiceId
string
ID opcional da voz utilizada.
voiceImage
string
Imagem opcional representando a voz.
voiceName
string
Nome opcional do perfil de voz.
voiceDescription
string
Descrição opcional do perfil de voz.
insertedLabsId
string
ID opcional de referência de laboratório.
model
string
Modelo do agente.
primaryColor
string
Configuração opcional de cor primária.
buttonColor
string
Configuração opcional de cor do botão.
webPrimaryColor
string
Cor primária opcional para interface web.
webButtonColor
string
Cor do botão opcional para interface web.
theme
string
Identificador ou configuração de tema opcional.
textTitle
string
Título opcional exibido na interface.
textDescription
string
Descrição opcional exibida na interface.
waitTime
string
Configuração de tempo de espera para interações.
callTime
string
Configuração opcional de duração da chamada.
voicePrompt
string
Configuração opcional de como o seu agente de voz deve se comportar durante a chamada.

Descrição da Resposta

Abaixo você verá a descrição da resposta da atualização de voz
id
uuid
required
Identificador único da configuração de voz.
botId
uuid
required
Identificador do agente associado.
visualIconId
uuid
ID do ícone usado para representação visual.
visualType
string
Tipo de layout visual aplicado (ex: completo, minimalista).
language
string
Código do idioma para interação por voz (ex: ptbr).
voiceId
string
ID da voz selecionada.
voiceName
string
Nome exibido da voz selecionada (opcional).
voiceDescription
string
Descrição para a voz (opcional).
insertedLabsId
string
ID da voz de serviços de laboratório integrados.
model
string
Configuração de modelo para a voz (pode estar vazio).
primaryColor
string
Cor primária para UI de voz.
buttonColor
string
Cor usada para botões de ação.
webPrimaryColor
string
Cor primária web.
webButtonColor
string
Cor do botão web.
theme
string
Tema da UI (ex: claro, escuro).
textTitle
string
Título exibido na interface de voz.
textDescription
string
Descrição exibida abaixo do título.
waitTime
number
Tempo de espera antes de iniciar a interação (em segundos).
callTime
number
Duração máxima da chamada (em segundos).
voiceCredentialId
uuid
ID da credencial para serviço de síntese de voz.
bot
Bot
required
visualIcon
File
required
voiceCredential
Credential
required
transcriptionCredential
uuid
ID da credencial para serviço de transcrição (opcional).
voicePrompt
string
Configuração opcional de como o seu agente de voz deve se comportar durante a chamada.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.