Lesson 1 - My First Flow

For this lesson we're going to jump right in and create an inbound call flow that looks just like what the Architect UI would create if you created a new inbound call flow.

inboundCall:
  name: Archy Demo
  defaultLanguage: en-us
  startUpRef: ./menus/menu[mainMenu]
  initialGreeting:
    tts: Hello, this is the initial greeting.
  menus:
    - menu:  
        name: Main Menu
        audio:
          tts: You are at the Main Menu, press 9 to disconnect.
        refId: mainMenu        
        choices:
          - menuDisconnect:
              name: Disconnect
              dtmf: digit_9

As you can see, at the very root of the YAML is the flow type where we specify 'inboundCall'. Underneath inbound call you will set properties about the flow such as the flow's name, default language tag, initial audio and more. This example is very basic. You do have the ability to specify other settings such as a flow's division which is not shown above. If you do not specify a division, Archy will create the flow in the organization's home division.

Assuming the above YAML was in a file named:

archyDemoFlow.yaml

and you were running Archy from the same directory where the archyDemoFlow.yaml is located, you would run:

archy create --file archyDemoFlow.yaml

and Archy would create the flow. You can also use a fully qualified file path when specifying the --file parameter value.

Tutorial Main | Next Lesson

Archy - Ver. 2.33.1, generated on January 3, 2025