Twimi
API Twimi v1
API Twimi v1

Voix

Server
Download schema

Faire parler l'avatar (texte → MP3) et transcrire la question orale du visiteur. Formules Avatar Widget et Avatar Agent.

Texte → voix de l'avatar

POST
https://api-dev.atwimi.com
/v1/conversations/{conversation_id}/speech
Bearer (JWT)

Avec le jeton de conversation. Formules Avatar Widget et Avatar Agent. Renvoie le son en MP3 (binaire), avec l'en-tête X-Twimi-Chars (caractères lus). Envoyez une réponse longue par phrases : la première se fait entendre pendant que la suivante se prépare, en donnant à chaque morceau le même turn. Décompte : chaque réponse parlée (un turn) compte une fois ; 5 réponses parlées = 1 conversation (réglable par déploiement). Un tour reçoit au plus 1 500 caractères de voix, tous morceaux compris. Refus 409 voice_limit_reached (en-tête X-Twimi-Voice-Reason) : forfait du mois atteint pour une nouvelle tranche, plafond de la conversation, fusible, ou réponse parlée trop longue (reponse). 60 morceaux par minute et par conversation.

Texte → voix de l'avatar › path Parameters

conversation_id
​string · required

Texte → voix de l'avatar › Request Body

SpeechIn
text
​string · minLength: 1 · maxLength: 2000 · required

Texte à dire (2 000 caractères au plus ; liens et Markdown retirés).

lang
​string | null · maxLength: 8

Langue du texte : choisit la voix déclarée par le client pour cette langue, si l'avatar du déploiement est celui du client ; sinon, la voix de l'avatar.

turn
​integer | null · min: 0

Numéro du tour (champ turn de l'événement done de /messages) : tous les morceaux d'une même réponse portent le même numéro et ne comptent qu'une fois. Absent : le dernier tour de la conversation (0 avant la première question, ex. l'accueil). Un tour reçoit au plus 1 500 caractères de voix, tous morceaux compris.

Texte → voix de l'avatar › Responses

Le son en MP3.

string · binary

Voix du visiteur → texte

POST
https://api-dev.atwimi.com
/v1/conversations/{conversation_id}/transcriptions
Bearer (JWT)

Avec le jeton de conversation. Formules Avatar Widget et Avatar Agent. Le son n'est jamais conservé. Une question orale dure 30 secondes au plus (offre) : coupez l'enregistrement au-delà. 20 transcriptions par minute et par conversation.

Voix du visiteur → texte › path Parameters

conversation_id
​string · required

Voix du visiteur → texte › Request Body

QuestionOrale
audio
​string · binary · required

Son de la question : webm, ogg, mp4, m4a, wav ou mp3 ; 5 Mo au plus

lang
​string | null

Langue parlée (indice pour la transcription)

Voix du visiteur → texte › Responses

Question transcrite.

Questions et réponses