PUT
/
api
/
v1
/
bot
/
voice
/
{id}
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>"
}'
{
  "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,
  "transcriptionCredentialId": "<string>",
  "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
    }
  }
}

​
Parameters Description

​
id
string

Id of the bot

​
visualIconId
string

Optional ID of the visual icon.

​
visualType
string

Optional type of the visual representation.

​
transcriptionCredentialId
string

Optional credential ID for transcription services.

​
voiceCredentialId
string

Optional credential ID for voice services.

​
language
string

Language setting for the voice assistant.

​
voiceId
string

Optional ID of the voice used.

​
voiceImage
string

Optional image representing the voice.

​
voiceName
string

Optional name of the voice profile.

​
voiceDescription
string

Optional description of the voice profile.

​
insertedLabsId
string

Optional ID for lab insertion reference.

​
model
string

Model of the bot.

​
primaryColor
string

Optional primary color configuration.

​
buttonColor
string

Optional button color configuration.

​
webPrimaryColor
string

Optional primary color for web interface.

​
webButtonColor
string

Optional button color for web interface.

​
theme
string

Optional theme identifier or setting.

​
textTitle
string

Optional title text displayed in the UI.

​
textDescription
string

Optional description text displayed in the UI.

​
waitTime
string

Wait time setting for interactions.

​
callTime
string

Optional call time duration setting.

​
Response Description

Below you will see the description of the update voice response

​
id
uuid
required

Unique identifier of the voice configuration.

​
botId
uuid
required

Identifier of the associated bot.

​
visualIconId
uuid

ID of the icon used for visual representation.

​
visualType
string

Type of visual layout applied (e.g., complete, minimal).

​
language
string

Language code for voice interaction (e.g., ptbr).

​
voiceId
string

ID of the selected voice.

​
voiceName
string

Display name of the selected voice (optional).

​
voiceDescription
string

Description for the voice (optional).

​
insertedLabsId
string

Voice ID from integrated lab services.

​
model
string

Model configuration for the voice (may be empty).

​
primaryColor
string

Primary color for voice UI.

​
buttonColor
string

Color used for action buttons.

​
webPrimaryColor
string

Primary web color.

​
webButtonColor
string

Web button color.

​
theme
string

Theme of the UI (e.g., light, dark).

​
textTitle
string

Title displayed in the voice interface.

​
textDescription
string

Description displayed under the title.

​
waitTime
number

Delay before interaction starts (in seconds).

​
callTime
number

Maximum call duration (in seconds).

​
transcriptionCredentialId
uuid

Credential ID for transcription service (optional).

​
voiceCredentialId
uuid

Credential ID for voice synthesis service.

​
bot
Bot
required
​
visualIcon
File
required
​
voiceCredential
Credential
required

​
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.