Texa DeskDevelopers

Texa API · Conversations

Open a conversation

POST/v1/conversations

Connected actions in the answer run by themselves and are marked "handled_by": "texa".

Takes an Idempotency-Key header.

Authorization

Authorizationheaderrequired

A Texa API key, texa_test_… for the sandbox or texa_live_…, made in Texa Desk under Texa AI → Developers → API keys. Keep it on your server.

Headers

Idempotency-Keystring

Run this request once; a retry with the same key and body gets the same answer.

Body application/json

channelstringrequired

One of: whatsapp, web, sms, instagram, facebook, telegram, line, tiktok, email, voice, phone.

customer_refstringrequired

your own reference for this customer

first_namestring
known_factsstring

what your record says about them Default "".

languagestring

Default "en".

objectivestring

objective: e.g. checkin

outboundboolean

objective over a thread: the business writes first Default false.

procedure_setstring

support: which set

procedure_versioninteger

SANDBOX ONLY: run this version instead of the live one

purposestring

One of: support, objective. Default "support".

reply_audioboolean

each reply also carries audio_media_id: an OGG/Opus voice note of it Default false.

scenariostring

SANDBOX: which fixtures answer actions

shadowboolean

your shadow mode: people answer and Texa AI drafts (/assist); its handovers stay out of handover rates Default false.

subjectstring

email: the subject

Responses

201

Successful Response

400

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
401

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
402

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
403

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
404

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
409

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
422

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
429

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring
503

400: The request is not valid; error.field names the part / 401: No key, or not a live one / 402: The account's prepaid credits are used up; top up in Texa Desk / 403: The key cannot do this (a sandbox route needs a test key) / 404: No such route, or nothing with that id in this account / 409: A conflict: the conversation's state, or an Idempotency-Key reused / 422: The body is not what this route takes / 429: Too many requests: wait Retry-After seconds / 503: Texa AI is not answering right now: retry after Retry-After seconds

errorobject
error.codestring
error.fieldstring
error.messagestring
error.typestring