Retrieve the most recent context for an Engagement.

GET /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context
Account sid auth token

[DEPRECATED] JSON context for engagements

Retrieve the most recent context for an Engagement.

Path parameters

  • FlowSid string Required

    The SID of the Flow.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

  • EngagementSid string Required

    The SID of the Engagement.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FN[0-9a-fA-F]{32}$.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • context

      As your flow executes, we save the state in what's called the Flow Context. Any data in the flow context can be accessed by your widgets as variables, either in configuration fields or in text areas as variable substitution.

    • engagement_sid string | null

      The SID of the Engagement.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FN[0-9a-fA-F]{32}$.

    • flow_sid string | null

      The SID of the Flow.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

    • url string(uri) | null

      The URL of the resource.
GET /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context 
curl \
 --request GET 'https://studio.twilio.com/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context",
  "context": {
    "foo": "bar"
  },
  "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "engagement_sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}