klink-developers-logo

CX Log

Get the live transcript

GET/api/v1/cx-logs/{id}/transcript

Returns one line per customer or agent message, oldest first, in the form [<ISO 8601 timestamp, UTC>] <name>(customer|agent): <text>. System events and internal comments are left out. A message with no text shows as [<type>], for example [image]. An empty string means the room has no messages yet.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Path Params
  • idstringrequired

    The CX log id (UUID) or its numeric case id.

    Example:5b0c8f9e-1d2a-4c3b-9e8f-7a6b5c4d3e2f

Responses

200

The transcript.

  • requestIdstring<uuid>required
  • dataCxLogTranscriptrequired
    Child attributes
    • cxLogIdstring<uuid>required
    • caseIdinteger<int64>required
    • roomIdstring<uuid>required

      The chat room the case belongs to.

    • channelstring | nullrequired

      Example:line

    • transcriptstringrequired

      Newline-separated transcript lines, oldest first.

400

id is not a UUID or a numeric case id.

  • messagearray[string]required
  • errorstringoptional
  • statusCodeintegerrequired
401

The API token is missing or invalid.

404

No CX log with this id exists for the token's tenant, or its chat room was not found.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
422

The CX log is not a chat case (for example a call or an email).

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired
429

Too many requests.

502

The chat service could not be reached. Retry later.

  • messagestringrequired
  • errorstringoptional
  • statusCodeintegerrequired