How to get Twilio Studio Flow execution via call sid

Question

We're trying to include the IVR steps in our UI, but to get the steps I have to make several API calls. That's fine, except the only way I can seem to get the relevant info is to load all flow executions.

If I could pass the flow.sid via the HTTP Request widget then I could go fetch the info I need later instead of having to iterate through all the previous executions. I tried passing {{flow.data}} as the request body, thinking it was JSON, but it ends up being empty.

Here's a spike that someone wrote for us, modified to just work with a single execution.

require "httparty"

STUDIO_FLOW_SID = "FW***"
AUTH = {username: ENV["TWILIO_ACCOUNT_SID"], password: ENV["TWILIO_AUTH_TOKEN"]}
DATE_CREATED_FROM = "2019-09-01T000000Z"
DATE_CREATED_TO = "2019-10-01T000000Z"

# Retrieves all executions in the given date range
executions_url = "https://studio.twilio.com/v1/Flows/#{STUDIO_FLOW_SID}/Executions?DateCreatedFrom=#{DATE_CREATED_FROM}&DateCreatedTo=#{DATE_CREATED_TO}"
response = HTTParty.get(executions_url, basic_auth: AUTH)

# If I can get the individual execution from the IVR {{flow.data}}
# that would be ideal
execution = response.parsed_response["executions"].first

execution_context_url = execution["links"]["execution_context"]
execution_context = HTTParty.get(execution_context_url, basic_auth: AUTH)

# Or, if I could work backwards and get the execution context ID from
# the call somehow, that would work too.
call_sid = execution_context.parsed_response["context"]["trigger"]["call"]["CallSid"]

steps = HTTParty
  .get(execution["links"]["steps"], basic_auth: AUTH)
  .parsed_response["steps"]
  .sort_by { |step| step["date_created"] }
  .map { |step| step["transitioned_to"] }
  .select { |step| step.include?("option") || step.include?("menu") }

puts [call_sid, steps].inspect

tl;dr - I either need the Flow execution info passed in an HTTP Request widget or I need to work backwards from a CallSid to get the execution steps.

philnash · Answer 1 · 2019-10-08T21:49:32.070

1

Twilio developer evangelist here.

The execution Sid can be accessed in the flow's data, under flow.sid.

This was missing in the documentation, but I've just added it here: https://www.twilio.com/docs/studio/user-guide#context-variables

Note: {{flow.sid}} doesn't currently appear in Studio's autocomplete, but it's there, I promise!

edited Oct 08 '19 at 21:49

answered Oct 08 '19 at 00:33

philnash

70,667
10
60
88

Is there a way to work backwards from the call to the execution? I'm not seeing anything in the API docs. – jc00ke Nov 26 '19 at 00:18
There is not I'm afraid. – philnash Nov 27 '19 at 00:26

score 0 · Answer 2 · edited Dec 02 '20 at 07:34

I found a way to get the execution from the call:

Get the list of incoming phone numbers: https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource#read-multiple-incomingphonenumber-resources
Search for the number using the destination of the call
Then you can get the flowid by parsing voice_url
With this flow_id and the date the call arrived, you can get the list of executions: https://www.twilio.com/docs/studio/rest-api/v2/execution#read-a-list-of-executions
If you have more than one, you can use the calling number to search in the list.

Anyway, if you are calling the function from Studio, philnash answer is better :)

How to get Twilio Studio Flow execution via call sid

2 Answers2