Queues

List the environment's queues (active versions)

GET /v1/queues flows:read

Responses

• 200

  Queues

  Fields

  • data Queue[] required
    Fields

    • name string required
    • version string required

      A hash of the definition

    • environment "live" | "test" required
    • definition object required
    • hours object required

      As deployed; null: always open

    • open boolean required

      Within its hours now

    • nextChangeAt string | null required

      When open next flips: null without hours, or if nothing changes for 14 days

    • createdAt string required
    • activatedAt string required
    • lastSeenAt string required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code

Register queue definitions

PUT /v1/queues flows:write

Like PUT /v1/flows: hcc.serve reports its queues on startup (mode: "report" only activates versions never seen before) and hcc.queues.deploy activates them from CI. With a live key, alsoTest: true registers them in test too.

Body

• queues object[] required
  Fields

  • name string required
  • displayName string
  • skills object

    Default {}.

  • priority integer

    Default 0. 0 to 100.

  • maxWaitSeconds integer

    Default 300. 10 to 86400.

  • holdMusicUrl string
  • announcePositionSeconds integer | null

    Default null. 15 to 600.

  • overflow object
    Fields

    agent

    • type "agent" required
    • agentId string required
    • provider string

    queue

    • type "queue" required
    • queue string required

    number

    • type "number" required
    • to string required

    voicemail

    • type "voicemail" required
  • wrapUpSeconds integer

    Default 0. 0 to 3600.

  • strategy "longest_idle" | "round_robin"

    Default "longest_idle".

  • serviceLevel object
    Fields

    • seconds integer required

      1 to 3600.

    • target number required

      0 to 1.

  • recording false
  • hours object
    Fields

    • timezone string required
    • weekly object required
    • exceptions object[]
    • atClose "drain" | "turn_away"

      Default "drain".

• mode "report" | "deploy"

  Default "report".

• alsoTest boolean

  Live keys only: also register the same versions in test (the simulator) Default false.

Responses

• 200

  Registered versions

  Fields

  • data Queue[] required
    Fields

    • name string required
    • version string required

      A hash of the definition

    • environment "live" | "test" required
    • definition object required
    • hours object required

      As deployed; null: always open

    • open boolean required

      Within its hours now

    • nextChangeAt string | null required

      When open next flips: null without hours, or if nothing changes for 14 days

    • createdAt string required
    • activatedAt string required
    • lastSeenAt string required
  • test object

    With alsoTest: the versions registered in test

    Fields

    • data Queue[] required
• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code

Live numbers of a queue

GET /v1/queues/{name}/stats flows:read

Path

• name string required

Responses

• 200

  Queue stats

  Fields

  • data QueueStats required
    Fields

    • name string required
    • waiting integer required
    • longestWaitSeconds integer required
    • repsAvailable integer required
    • repsLoggedIn integer required

      Reps with the skills who are not offline

    • hours object required

      As deployed; null: always open

    • open boolean required

      Within its hours now

    • nextChangeAt string | null required

      When open next flips: null without hours, or if nothing changes for 14 days

• 400

  Invalid request

• 401

  Missing or invalid API key

• 404

  Not found

• 429

  rate_limited, or another limit named by error.code