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}$.

• Sid string Required

  The SID of the Engagement resource to fetch.

  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

  • sid string | null

    The unique string that we created to identify the Engagement resource.

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

  • account_sid string | null

    The SID of the Account that created the Engagement resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[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}$.

  • contact_sid string | null

    The SID of the Contact.

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

  • contact_channel_address string | null

    The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name.

  • context

    The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.

  • status string

    The status of the Engagement. Can be: active or ended.

    Values are active or ended.

  • date_created string(date-time) | null

    The date and time in GMT when the Engagement was created in ISO 8601 format.

  • date_updated string(date-time) | null

    The date and time in GMT when the Engagement was updated in ISO 8601 format.

  • url string(uri) | null

    The absolute URL of the resource.

  • links object(uri-map) | null

    The URLs of the Engagement's nested resources.