DumGumDocs
Search documentation

Loading search…

Guides

Automate Engagement

Engage lets a Persona send a message first, instead of waiting for the user. Use it to open a new chat, to follow up when someone goes quiet, or to answer a message that was left waiting. It is off by default: a Persona only reaches out when you ask it to.

You control it with two values:

  • the mode: the kind of message to send;
  • the angle (engageType): what the message opens on. Optional.
{
  "replyParameters": {
    "action": {
      "type": "ENGAGE",
      "engage": { "mode": "ICEBREAKER", "type": "PHOTO_COMMENT" }
    }
  }
}

The five modes

ModeUse it whenWhat the Persona does
AUTOYou'd rather not decidePicks the right mode from the conversation. Never picks LATE_REPLY.
ICEBREAKERThere is no conversation yetWrites a first message based on the user's profile
NUDGEThe user went quiet recentlyFollows up gently, on the same topic
REVIVEThe conversation died a while agoRestarts it, on the old topic or a new one
LATE_REPLYYour Persona left a message unansweredOwns the delay, then answers what the user said

AUTO is the easy choice: no timing to track on your side. The other four force that mode, whatever the conversation looks like.

The angles (engageType)

The angle picks what the message opens on. Leave it out, or set AUTO, and the Persona chooses.

engageTypeThe message opens onWorks with
AUTOWhatever fits bestEvery mode
GENERICA simple, universal openerICEBREAKER, AUTO
NO_PHOTOThe user having no photoICEBREAKER, AUTO
PHOTO_COMMENTThe user's main profile pictureICEBREAKER, AUTO
MISSING_DETAILA missing profile detail (age, interests…)ICEBREAKER, AUTO
MUCH_YOUNGERThe user being much youngerICEBREAKER, AUTO
MUCH_OLDERThe user being much olderICEBREAKER, AUTO
NEARBYThe two of them being close byICEBREAKER, AUTO
USER_ONLINEThe user being online right nowICEBREAKER, AUTO
USER_OFFLINEThe user being awayICEBREAKER, AUTO
JUST_JOINEDThe user having just signed upICEBREAKER, AUTO
EROTICA strongly erotic openerICEBREAKER, NUDGE, REVIVE, AUTO
HAPPY_BIRTHDAYBirthday wishesICEBREAKER, NUDGE, REVIVE, AUTO

Only EROTIC and HAPPY_BIRTHDAY work outside icebreakers. No angle applies to LATE_REPLY.

Automatic behaviour to know about

An angle is never an error. When it doesn't apply, the Persona quietly falls back to AUTO and still sends the message:

  • The angle doesn't match the mode (for example NEARBY with NUDGE) → AUTO.
  • PHOTO_COMMENT but the user has no main pictureAUTO.
  • An angle sent with no mode at all → it is checked against ICEBREAKER.

LATE_REPLY has two conditions of its own:

  • A user message must actually be waiting for an answer.
  • It must have waited at least 3 hours of the user's waking time. Hours between 22:00 and 07:00 in the user's own timezone don't count. A message sent at bedtime and answered at breakfast kept nobody waiting.

If either condition fails, the engagement is skipped and the user simply gets an ordinary reply. The message is never dropped, and the Persona never apologises out of proportion to the delay. When it does run, the delay the Persona mentions is the real one.

Full parameter details are in the API reference.