ANanyreach
Public Web Widgets

Create Public Widget Conversation

post/core/public/web-widgets/{id}/conversations

Request

  • Base URL
    https://api.anyreach.ai (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

idstring required

Headers

X-Anyreach-Identitystring nullable

Request body

user_idstring required

User ID (must be +E.164 phone number for telephony)

custom_metadataobject nullable

Optional custom metadata

conversation_idstring nullable

Existing conversation ID to resume

tokenstring nullable

Capability token for the conversation. Required to resume an existing conversation (issued once at creation).

opened_with_user_messageboolean

The visitor opened this conversation by sending a message (e.g. clicking a suggested question), so the agent must not open it with a greeting of its own. Makes the conversation user-initiated regardless of the agent's starting_message config. Ignored on resume.

identity_pendingboolean

Created without an identity token while the page's sign-in check was still running: the response carries a bind_ticket for it. Ignored on resume.

identity_checkstring nullable

The check_ticket of the page's last failed sign-in check: the new conversation's Verification panel lists that check. Ignored on resume and when the conversation starts signed in.

anonymous_idstring nullable

The embed loader's anonymous visitor id. While the widget has a running experiment, the server buckets it to pick the variant (and agent version) the conversation runs under. Ignored on resume.

page_valuesobject nullable

The page values the widget read for its conversation starters ({{name}} in their texts), by name. Ignored on resume.

localestring nullable

The visitor's locale as the widget resolved it (a BCP-47 tag). Kept to the widget's supported languages; ignored when the widget has none configured, and on resume.

locale_sourcestring nullable

What picked the locale: host, url_rule, page_lang, browser or default. Recorded with the conversation.

Response

Successful Response

connection_detailsobject nullable
capabilitiesobject nullable
conversation_tokenstring nullable
handoffobject nullable
identity_formobject nullable
transport'livekit' | 'http' nullable
greetingstring nullable
starting_widgetsobject[] nullable
rejectedboolean nullable
endedboolean nullable
identity_verifiedboolean nullable
identity_boundboolean nullable
bind_ticketstring nullable
latest_seqinteger nullable

Changes

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