ContentRunner Interaction (Stage) icon

ContentRunner Interaction (Stage)

Link user+bot (creates empty campaign), Get state, or Update state

Actions3

Get State

AI-generated

Summary

Retrieve interaction state for a user‑bot linkage, optionally filtered by campaign.

Inputs

  • identifyBy — Identifier mode: 'tg' for Telegram chat+bot ID, 'uuid' for user_id+bot_id
  • tgChatIdGet (required) — Telegram chat ID used when identifyBy='tg'.
  • tgBotIdGet (required) — Telegram bot ID used when identifyBy='tg'.
  • userId (required) — User ID used when identifyBy='uuid'.
  • botId (required) — Bot ID used when identifyBy='uuid'.
  • campaignIdFilter — Optional UUID to limit retrieval to a specific campaign.
  • continueOnNotFound — Whether to continue when interaction not found; default true.

Output shape

object containing found boolean and the full interaction record when found

If the interaction is not found, returns {found:false} when continueOnNotFound is true; otherwise throws an error. Errors are caught and returned as JSON with an error field.

Examples

Example 1: Fetch state using Telegram identifiers

Operation=Get State, identifyBy=tg, provide tgChatIdGet and tgBotIdGet, optional campaignIdFilter and continueOnNotFound.

Example 2: Fetch state using UUID identifiers

Operation=Get State, identifyBy=uuid, provide userId and botId, optional campaignIdFilter and continueOnNotFound.

Links

Discussion