Triggers a new Engagement for the Flow

POST /v1/Flows/{FlowSid}/Engagements
Account sid auth token

[DEPRECATED] Excecutions of Studio flows

Triggers a new Engagement for the Flow

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

application/x-www-form-urlencoded

Body

  • To string(phone-number) Required

    The Contact phone number to start a Studio Flow Engagement, available as variable {{contact.channel.address}}.

  • From string(phone-number) Required

    The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable {{flow.channel.address}}

  • Parameters

    A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in Parameters={'name':'Zeke'} then inside a widget you can reference the variable {{flow.data.name}} which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.

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.
POST /v1/Flows/{FlowSid}/Engagements 
curl \
 --request POST 'https://studio.twilio.com/v1/Flows/{FlowSid}/Engagements' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'To=%2B18001234567&From=%2B18007654321&Parameters=%7B%22first_name%22%3A%22Foo%22%7D'
Request example 
{"To"=>"+18001234567", "From"=>"+18007654321", "Parameters"=>"{\"first_name\":\"Foo\"}"}
Response examples (200) 
{
  "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "steps": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",
    "engagement_context": "https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"
  },
  "status": "active",
  "context": {},
  "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "contact_sid": "FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "contact_channel_address": "+18001234567"
}