IVR

Get or create the inbound call's engagement at the start of the IVR

Changed on

GE-3578. Called by the engagement-init Twilio Function before ani-lookup.

Twilio's studio.started event is what normally creates the inbound engagement, and it can reach MC2 well after the IVR has already asked for the engagement id. This creates the row first, with the same defaults, so the late event finds it. Idempotent: a repeat for the same callSid returns the same engagement with created: false.

post/api/v1/ivr/engagement

Request

  • Base URL
    https://api.cloverhealth.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.cloverhealth.com/api/v1/ivr/engagement
  • Auth
    API key in header X-MC2-Signature

Request body

callSidstring required
anistring nullable
dnisstring nullable

Response

OK

engagementIdstring required
createdboolean required

Changes