Rivier/ Reference/ voice

Create a call flow

post/calls/flows

Create a call flow. It is checked in full first: every node a step names must exist, numbers must be valid, audio must be a public https address, and a recording step must say the call is recorded.

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:write
Graphql
Mutation.voiceCallFlowCreate
Sdk
calls.flows.create
Cli
calls flow-create

Request bodyapplication/json, required

  • namestringrequired
    At most 80 characters.
  • flow
    The flow: { language, voice, start, nodes: { name: [steps] } }. Steps: say, play, pause, gather, dial, record, hours (branch on opening hours), redirect, hangup, reject. Checked in full before it is stored.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown