Import audio for Insight

Import audio for Insight. See the OpenAPI-defined parameters, request body, and responses below.

POST /Insight/audio

Import audio for Insight. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint cria uma conversa a partir de um arquivo de audio e metadados.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

This operation has no path, query, or header parameters.

Request body

Content type: multipart/form-data · Schema: object

PropertyTypeRequiredDescriptionConstraints
audiostring · binaryNo——
ConversationIntegrationTypeConversationIntegrationTypeNo——
FromstringNo——
UserIdinteger · int32No——
UserNamestringNo——
UserAgentCodestringNo——
CommunicationChannelCommunicationChannelNo——
ChecklistIdinteger · int32No——
QueueIdinteger · int32No——
CreatedAtstring · date-timeNo——
ConversationIdinteger · int32No——
AudioChannelsinteger · int32No——

Example request

curl --request POST \
  --url 'https://api.zild.ai/Insight/audio' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --form 'audio=@audio' \
  --form 'ConversationIntegrationType={ConversationIntegrationType}' \
  --form 'From={From}' \
  --form 'UserId={UserId}' \
  --form 'UserName={UserName}' \
  --form 'UserAgentCode={UserAgentCode}' \
  --form 'CommunicationChannel={CommunicationChannel}' \
  --form 'ChecklistId={ChecklistId}' \
  --form 'QueueId={QueueId}' \
  --form 'CreatedAt={CreatedAt}' \
  --form 'ConversationId={ConversationId}' \
  --form 'AudioChannels={AudioChannels}'

Responses

StatusDescriptionResponse body
200Conversa criada com sucessoNo response body is defined.

Data models

CommunicationChannel

0 = Default; 1 = WhatsApp; 2 = Telefonia; 3 = Email; 4 = WebChat; 5 = InstagramDirectMessage; 6 = FacebookMessenger; 7 = MicrosoftTeams; 8 = ZildCoach

integer

ConversationIntegrationType

0 = None; 1 = Olus; 2 = TotalIP; 3 = MicrosoftTeams; 4 = Fluctus; 5 = OpaSuite; 6 = ChatMix; 7 = MKBOOT; 8 = FocusChat; 9 = Tallos; 10 = SZFortics; 11 = James; 12 = MatrixGo; 13 = Twilio; 14 = Native; 15 = Internal; 16 = RetellAI; 17 = ElevenLabs; 18 = Email; 19 = WhatsAppApi; 20 = WebChat

integer