Read a conversation with Rosie

GET

/public/assistant/sessions/{id}

curl --request GET \
  --url https://example.com/public/assistant/sessions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

The conversation so far, its guide links and any register interest draft, for showing it again on a new page.

Authorizations

• assistantSession

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The conversation

Media typeapplication/json

object

sessionId

required

string format: uuid

surface

required

string

Allowed values: website support

status

required

string

Allowed values: open ended

expiresAt

required

string format: date-time

turnsLeft

required

integer

messages

required

Array<object>

<= 40 items

object

id

required

string format: uuid

role

required

string

Allowed values: visitor assistant

text

required

string

<= 4000 characters

sources

required

Array<object>

<= 3 items

object

title

required

string

>= 1 characters <= 400 characters

url

required

string format: uri

<= 2048 characters

createdAt

required

string format: date-time

interestDraft

required

object

name

string

>= 1 characters <= 120 characters

business

string

>= 1 characters <= 160 characters

email

string format: email

<= 254 characters

phone

string

>= 1 characters <= 40 characters

vans

string

Allowed values: 1 2-5 6-20 20+

current_system

string

Allowed values: paper rba spreadsheets other

accounting

string

Allowed values: xero sage quickbooks other none

online_shop

string

Allowed values: shopify woocommerce other none

biggest_pain

string

>= 1 characters <= 1000 characters

Example

{
  "surface": "website",
  "status": "open",
  "messages": [
    {
      "role": "visitor"
    }
  ],
  "interestDraft": {
    "vans": "1",
    "current_system": "paper",
    "accounting": "xero",
    "online_shop": "shopify"
  }
}

401

Missing, wrong or expired session token

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Rosie is not set up here

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}