Praecise Platform
Menu

Rivier/ Reference/ voice

Place a phone call that runs a call flow when answered

post/calls

Place a phone call that runs a call flow when answered. Refused, with the reason, for an invalid or premium-rate number, a refused country, a number the project may not call from, an opted-out person (marketing), quiet hours (marketing), the hourly limit, or an exhausted plan allowance. Minutes are charged when the call ends.

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:write
Mcp
rivier_call_place
Graphql
Mutation.voiceCallPlace
Sdk
calls.place
Cli
calls place

Request bodyapplication/json, required

  • tostringrequired
    The number to call, written with its country code: +9609123456 At most 40 characters.
  • fromstring
    One of the project's calling numbers; the first one when left out At most 40 characters.
  • flowIdstring (uuid)required
    The call flow that runs when the call is answered
  • purposestring
    Marketing calls respect opt-outs and quiet hours One of: transactional, marketing.
  • varsobject
    Values the flow can speak, used as {{name}}
  • maxSecondsinteger
    The longest this call may run, in seconds; never more than the project's own maximum At least 30. At most 3600.
  • liveWordsboolean
    Send the words of the call as voice.call.words events while it runs
  • placedBystring
    At most 100 characters.

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