Sign in

Post v0 city by city name extmsg bind

post/v0/city/{cityName}/extmsg/bind

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-GC-Request

Path parameters

cityNamestring required

City name.

Headers

X-GC-Requeststring required

Anti-CSRF header required on mutation requests. Any non-empty value is accepted; the header's presence is what the server checks.

Request body

agent_namestring

Configured agent identity to bind; its live session is resolved at delivery time, cold-waking one when none is live (mutually exclusive with session_id).

metadataobject

Optional binding metadata.

replaceboolean

Rebind (handoff) a conversation whose active binding targets someone else instead of returning a conflict.

session_idstring

Session ID to bind (mutually exclusive with agent_name).

Response

OK

AgentNamestring required
BindingGenerationinteger required
BoundAtstring date-time required
ExpiresAtstring date-time nullable required
IDstring required
Metadataobject required
SchemaVersioninteger required
SessionIDstring required
SessionNamestring required
Status'active' | 'ended' required

Lifecycle state of a session binding.

Changes

No recorded changes to this operation across all 50 revisions of this API.