Skip to content

The enter_queue method accepts a whisper_url field that the reference and JSON Schema do not declare #738

Description

@hey-august

Summary

The SWML enter_queue method accepts an optional whisper_url field that neither the reference page nor the generated JSON Schema declares. Customers cannot discover it, and the dashboard editor rejects it as an unknown parameter. Found while reviewing #709.

What the engine does

  • Accepted since mod_infrastructure #1710 (Jakub Karolczyk, 2026-03-10). The schema checker lists it as an optional string on enter_queue.
  • Executed on the queued caller when an agent connects, before the two legs are bridged. The agent leg waits until the whisper finishes.
  • Takes a URL or inline SWML. Despite the name, the engine tests cover both an https:// URL and an inline SWML document as a JSON string, the same two forms as execute_after_queue.

Affected files

  • specs/swml/calling/Methods/enter_queue/main.tsp: add the optional field with @doc and @example, then run yarn build:specs.
  • fern/products/swml/pages/reference/methods/calling/enter_queue.mdx: add a ParamField and an example.

Watch for

The existing Call whisper recipe plays a message to the person being called, via connect.confirm. This field plays to the caller who was waiting in the queue. The reference wording should make that direction explicit so the two are not confused.

Done when: whisper_url validates in the dashboard editor and appears on the enter_queue reference page with both accepted forms documented.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions