voicebot@v1

- action: voicebot@v1
  params:
    initialMessages:
      - role: system
        content: You are a smart AI agent on the phone. Make short replies
      # all assistant initial messages will be said by the bot
      - role: assistant
        content: Hello there. How can I help?
    engine:
      name: OpenAI # the only supported engine for now
      model: gpt-5.4-mini
      auth: ${{ $openai_key }} # use your OpenAI key

- action: voicebot@v1
  params:
    initialMessages:
      - role: system
        content: You are a smart AI agent on the phone. Make short replies
      - role: system
        content: >
          If the call wants to speak to a human, call the "dial" function with phone_number='+15559824200'.
          If the user says goodbye or if the conversation is over, call the hangup function.
      - role: assistant
        content: Hello there. How can I help?
    engine:
      name: OpenAI
      model: gpt-5.4-mini
      auth: ${{ $openai_key }}
  result: $bot

- if: $bot?.exitTool === 'dial'
  then:
    - action: dial@v2
      params:
        targets:
          - number: ${{ $bot?.payload }}
            timeout: 30

- if: $bot?.exitTool === 'hangup'
  then:
    - action: play@v3
      params:
        tts:
          text: Thank you, goodbye!
    - action: hangup@v1

variables:
  $model: gpt-5.4
  $openai_key: "your OpenAI key"
  $url: "https://api.example.com"

branches:
  inbound-call:
    actions:
      - action: voicebot@v1
        params:
          initialMessages:
            - role: system
              content: You are an AI agent on the phone. Make short replies
            - role: system
              content: >
                If the call wants to speak to a human, call the "dial" function with phone_number='+15559824200'.
                If the user says goodbye or if the conversation is over, call the hangup function.
            - role: assistant
              content: Hello there. How can I help?
          engine:
            name: OpenAI
            model: ${{ $model }}
            auth: ${{ $openai_key }}
            params:
              temperature: 0.2 # default value
              maxCompletionTokens: 0 # default value
          pleaseWait:
            enabled: true
            delay: 2.5
            sentences:
              - Please wait
          tools:
            - name: search_knowledge_base
              url: ${{ $url }}/search_knowledge_base
              description: >
                Search into the knowledge base (RAG). Do not call this function when
                looking for the next available slot.
              method: GET # GET is the default if you do not specify a method
              params: # parameters will be filled by the LLM
                # in case of a GET, they will be sent as query args
                - name: query
                  type: string
                  description: User query
            - name: get_next_available_slot
              url: ${{ $url }}/get_next_available_slot?from=${{ encodeURIComponent(call.fromNumber) }}
              description: >
                Returns the next available slot.
            - name: book_slot
              url: ${{ $url }}/book_slot
              description: >
                Books the slot.
              method: POST
              headers:
                # you can specify custom HTTP headers
                X-CallerID: ${{ call.fromNumber }}
                Authorization: Bearer <token>
              params:
                # those parameters will be sent as a JSON body (because method != GET)
                # and filled by the LLM
                - name: name
                  type: string
                  description: Firstname and lastname
                - name: object
                  type: string
                  description: Type of appointment
                - name: slot
                  type: string
                  description: ISO 8601 date-time "YYYY-MM-DDTHH:MM:SSZ"
        result: $bot

{
  "ok": true,
  "timeout": false,
  "exitTool": "dial",
  "payload": "+33199004242",
  "messages": [
    {
      "role": "assistant",
      "content": "Hello, how can I help you?"
    },
    {
      "role": "user",
      "content": "I'd like to talk to sales"
    }
  ],
  "values": {
    "topic": "sales"
  },
  "totalTokens": 1234
}