assistant

Ask a person

Send a message to a human support agent, optionally with the assistant conversation attached. The assistant never does this by itself: it can say a person should take over, and this is the customer pressing the button. The request is WRITTEN DOWN before the email is attempted, so a mail outage delays it rather than losing it — ticket.status is sent when the support inbox already has it and queued when it is still being delivered, and in both cases the reference is final and the request needs no resending. The transcript, when attached, is the conversation as the SERVER stored it, not as the client claims it happened. A successful same-key retry reads the original ticket's current delivery state without submitting it again; failed means automatic retries have ended.

post/assistant/handoffs

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/assistant/handoffs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

category'billing' | 'bug' | 'account' | 'feature_request' | 'other' required

What the request is about. It routes the email and is the customer's choice, never the assistant's.

conversationIdstring uuid

Attach this conversation. A conversation of another account is a 404. Omit for a request that started outside the assistant.

includeTranscriptboolean

Attach the conversation's last fifty turns to the ticket. Absent means NO: a conversation is only ever copied into a support ticket because the customer asked for it.

messagestring required

What the customer wants to say, in their own words. Stored and emailed as text.

subjectstring required

Response

Ask a person

contactEmailstring required

Where the reply will go — the address on the signed-in account, echoed back so the panel can say so.

expectedReplystring required

How long an answer usually takes.

Changes

No recorded changes to this operation across all 1 revision of this API.