Twimi
API Twimi v1
API Twimi v1

Conversations

Server
Download schema

Ouvrir une conversation à la première action du visiteur, renouveler son jeton, la terminer. Une conversation dure 10 minutes au plus depuis son ouverture.

Ouvrir ou reprendre une conversation

POST
https://api-dev.atwimi.com
/v1/conversations
Bearer (pk_test_… / pk_live_…)
or
Bearer (sk_test_… / sk_live_…)

Clé publique (depuis une page déclarée) ou secrète. Renvoie un jeton de conversation valable 30 min.

Avec resume : si la conversation appartient au même déploiement, n'est pas terminée et a servi il y a moins de 30 minutes, elle est reprise (réponse 200, counted: false). Sinon, une nouvelle est ouverte (réponse 201, counted: true). Au-delà du forfait du mois, la conversation s'ouvre quand même, en écrit seul (voice.allowed: false, reason: "forfait") : jamais de blocage.

Ouvrir ou reprendre une conversation › Request Body optional

ConversationIn
avatar_id
​string | null · maxLength: 64

Avatar du déploiement (facultatif : celui du déploiement par défaut).

lang
​string | null · maxLength: 8

Langue souhaitée, parmi celles du déploiement.

resume
​string | null · maxLength: 64

Identifiant d'une conversation à reprendre (moins de 30 min d'inactivité).

Ouvrir ou reprendre une conversation › Responses

Conversation reprise avec resume : pas de nouveau décompte.

conversation_id
​string
token
​string

Jeton de conversation, valable 30 minutes.

expires_at
​string · date-time
counted
​boolean

true : nouvelle conversation, décomptée du forfait.

​object
​object

Disponibilité de la voix pour cette conversation.

Terminer une conversation

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

Facultatif. La conversation ne peut plus être reprise et son jeton n'est plus accepté.

Terminer une conversation › path Parameters

conversation_id
​string · required

Terminer une conversation › Responses

Conversation terminée.

Renouveler le jeton d'une conversation

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

Avec le jeton encore valide (Authorization: Bearer <jeton>). Pas de nouveau décompte. Refusé si la clé qui a ouvert la conversation a été révoquée (401 invalid_key), ou au-delà de 10 min de conversation (410 conversation_expired : en ouvrir une nouvelle).

Renouveler le jeton d'une conversation › path Parameters

conversation_id
​string · required

Renouveler le jeton d'une conversation › Responses

Nouveau jeton de 30 minutes.

AvatarsQuestions et réponses