Een chat is een getypt gesprek met dezelfde agent die je gesprekken aanneemt: zijn instructies, functies, kennis en doorverbindregels gelden allemaal, alleen wordt er niets uitgesproken. Je server stuurt elk bericht en krijgt het hele antwoord van de agent terug in de respons. Chats worden afgerekend per bericht dat de persoon stuurt, en elke chat is een gespreksrecord: hij staat onder Gesprekken (gemarkeerd als Tekst), wordt geanalyseerd, naar je webhooks gestuurd en met de gegevens van een beller verwijderd zoals elk gesprek.
curl https://evasay.com/api/v1/voice/chats \
-X POST \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "agent_id": "AGENT_ID", "message": "Do you deliver on Sundays?", "user_id": "u_42" }'
{
"data": {
"chat_id": "vc_…",
"reply": "We do, between 10 am and 4 pm. Would you like to book a slot?",
"cards": [],
"quick_replies": [],
"ended": false
}
}
user_id (jouw id voor de persoon) en variables (waarden die de agent en zijn functies mogen vertrouwen) werken zoals bij webgesprektokens.cards en quick_replies zijn wat de agent in een webgesprek zou tonen (zie Gesprekken op je website en in je app).curl https://evasay.com/api/v1/voice/chats/CHAT_ID/messages \
-X POST \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "message": "Yes, this Sunday at noon." }'
De respons heeft dezelfde velden. Een bericht is hoogstens 500 tekens. Stuur er één tegelijk en wacht op het antwoord: een bericht dat wordt gestuurd terwijl de agent nog antwoordt krijgt 409 chat_busy, en een bericht minder dan een seconde na het vorige krijgt 429 rate_limited.
Als de worker die de chat draait weg is (een herstart), zet een nieuwe chat hem voort met het gesprek tot dan toe en beantwoordt je bericht; de respons bevat dan continued_from met het id van de oude chat. Gebruik vanaf dan de nieuwe chat_id.
Een chat eindigt na 30 minuten zonder bericht, twee uur na de start, bij 100 berichten, als de agent hem beëindigt of als jij hem beëindigt:
curl https://evasay.com/api/v1/voice/chats/CHAT_ID/end \
-X POST \
-H "Authorization: Bearer sk-your-key"
Hij wordt dan geanalyseerd, als call.ended naar je webhooks gestuurd en afgerekend. Een bericht aan een beëindigde chat krijgt 409 chat_ended. Om verder te gaan start je een nieuwe chat met previous_chat_id: de agent krijgt het eerdere gesprek (de laatste 50 berichten), en het record van de nieuwe chat begint leeg. ended: true in een antwoord betekent dat de agent de chat met dat antwoord heeft beëindigd. human: true betekent dat een lid van je team het gesprek heeft overgenomen in de Inbox: de agent antwoordt niet en reply is leeg.
Een workspace mag een aantal chats tegelijk open hebben, los van zijn gesprekken; als ze allemaal open zijn, krijgt een nieuwe chat 429 chat_limit tot er één eindigt.
| Code | Status | Wanneer |
|---|---|---|
invalid_message | 400 | Geen bericht, of langer dan 500 tekens |
chat_not_found | 404 | Zo'n chat bestaat niet in de workspace (of previous_chat_id is er geen) |
chat_busy | 409 | De agent beantwoordt nog het laatste bericht |
chat_ended | 409 | De chat is voorbij; start een nieuwe met previous_chat_id |
chat_message_limit | 409 | De chat heeft 100 berichten gehad |
rate_limited | 429 | Minder dan een seconde na het laatste bericht |
chat_limit | 429 | De workspace heeft zoveel chats open als hij mag |
insufficient_credits | 402 | Niet genoeg credits om een chat te starten |
chat_timeout | 504 | De agent had zijn antwoord niet op tijd af; probeer het opnieuw |
chat_unavailable | 503 | De agent kon nu niet antwoorden; probeer het opnieuw |
De widget en de gehoste pagina bieden praten en typen aan; in Agents → Implementeren kun je er maar één aanbieden. Getypte gesprekken op een pagina worden per bericht afgerekend zoals chats. Zie Gesprekken op je website en in je app.