Send session transcription

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationEmail": "jsmith@example.com",
  "attachTranscription": true,
  "includeContactHistory": false
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send"

payload = {
    "destinationEmail": "jsmith@example.com",
    "attachTranscription": True,
    "includeContactHistory": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destinationEmail: 'jsmith@example.com',
    attachTranscription: true,
    includeContactHistory: false
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'destinationEmail' => 'jsmith@example.com',
    'attachTranscription' => true,
    'includeContactHistory' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send"

	payload := strings.NewReader("{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}"

response = http.request(request)
puts response.read_body

{
  "attached": true,
  "destinationEmail": "jsmith@example.com",
  "includedContactHistory": true,
  "providerMessageID": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "sessionID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transcriptionURL": "<string>"
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "SessionNotFoundError",
      "error_code": 1060,
      "message": "Session not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

{
  "errors": [
    {
      "error": "StorageUploadError",
      "error_code": 5008,
      "message": "Failed to upload file to storage.",
      "statusCode": 502
    }
  ]
}

Sessions

Send session transcription

Envia a conversa por e-mail para o endereço informado. O corpo do e-mail traz a conversa renderizada; o arquivo .txt só é gerado e anexado quando attachTranscription é true (padrão) — com false, nada é gravado no storage.

O transcriptionURL da resposta (quando há anexo) é uma URL privada e assinada, válida por 30 dias; o arquivo permanece, só o link expira. Depois de 30 dias, chame o endpoint de transcrição de novo para obter um link novo.

Com includeContactHistory em true, a transcrição deixa de ser só desta sessão e passa a cobrir todas as conversas que o contato já teve com o tenant, unificadas em ordem cronológica.

A conversa é carregada antes do envio: se isso falhar, nenhum e-mail sai.

POST

tenants

{tenantID}

sessions

{sessionID}

transcription

send

Send session transcription

curl --request POST \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationEmail": "jsmith@example.com",
  "attachTranscription": true,
  "includeContactHistory": false
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send"

payload = {
    "destinationEmail": "jsmith@example.com",
    "attachTranscription": True,
    "includeContactHistory": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    destinationEmail: 'jsmith@example.com',
    attachTranscription: true,
    includeContactHistory: false
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'destinationEmail' => 'jsmith@example.com',
    'attachTranscription' => true,
    'includeContactHistory' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send"

	payload := strings.NewReader("{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/sessions/{sessionID}/transcription/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destinationEmail\": \"jsmith@example.com\",\n  \"attachTranscription\": true,\n  \"includeContactHistory\": false\n}"

response = http.request(request)
puts response.read_body

{
  "attached": true,
  "destinationEmail": "jsmith@example.com",
  "includedContactHistory": true,
  "providerMessageID": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "sessionID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transcriptionURL": "<string>"
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "SessionNotFoundError",
      "error_code": 1060,
      "message": "Session not found.",
      "statusCode": 404
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

{
  "errors": [
    {
      "error": "StorageUploadError",
      "error_code": 5008,
      "message": "Failed to upload file to storage.",
      "statusCode": 502
    }
  ]
}

Authorizations

Authorization

string

header

required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID

string<uuid>

required

The tenant the session belongs to.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

sessionID

string<uuid>

required

The session to transcribe and send.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

destinationEmail

string<email>

required

Recipient address for the transcription e-mail.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

attachTranscription

boolean

default:true

Whether to also generate the .txt transcript and attach it. Defaults to true.

includeContactHistory

boolean

default:false

Whether to widen the transcript to every session this contact ever had with the tenant, merged chronologically. Defaults to false (this session only).

Response

Response for status 200.

attached

boolean

required

Whether the .txt transcript was attached.

destinationEmail

string<email>

required

Address the conversation was sent to.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

includedContactHistory

boolean

required

Whether the transcript covered the contact full history instead of a single session.

providerMessageID

string | null

required

Provider-side id of the accepted message.

sentAt

string<date-time>

required

When the e-mail was handed to the provider.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

sessionID

string<uuid>

required

The transcribed session.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

transcriptionURL

string<uri> | null

required

Private signed URL of the attached transcript, valid 30 days; null when no attachment was requested.

⌘I

Real Time API

Services API

Helpdesk API

Send session transcription

Authorizations

Path Parameters

Body

Response