Storefront APIEngagement
Get the chat
Path Parameters
key*string
The chat channel's public key (data-key of the embed script)
conversation_id*string
Conversation id
Format
uuidQuery Parameters
token?string
The token POST /widget/{key}/conversations returned. Prefer the
X-Visitor-Token header; the query parameter is for clients that
cannot set headers.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/widget/string/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"assigned": true,
"bot_active": true,
"contact_email": "string",
"contact_name": "string",
"contact_phone": "string",
"created_at": "2019-08-24T14:15:22Z",
"csat_score": 0,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "open",
"unread_for_visitor": 0
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}