Skip to content
vocapable.Docs

What a caller would experience now - a configuration preview, not a phone test

POST
/v1/workspace/routing/preview
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/routing/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "strategy": "company_owner_first", "member_user_ids": [ "example" ], "ring_seconds": 1, "fallback": "ai_receptionist", "after_hours": "ai_receptionist", "phone_number_id": "example", "scenario": "business_hours", "organization_id": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceRoutingPreviewRequest
object
strategy
required
Strategy
string
Allowed values: company_owner_first longest_available ring_together
member_user_ids
Member User Ids
Array<string>
<= 10 items
ring_seconds
required
Ring Seconds
integer
fallback
required
Fallback
string
Allowed values: ai_receptionist callback
after_hours
required
After Hours
string
Allowed values: ai_receptionist voicemail
phone_number_id
Any of:
string
<= 64 characters
scenario
required
Scenario
string
Allowed values: business_hours owner_unavailable nobody_available after_hours
organization_id
Any of:
string
<= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceRoutingPreview
object
label
required
Label
string
matches_saved_draft
required
Matches Saved Draft
boolean
steps
required
Steps
Array<object>
WorkspaceRoutingPreviewStep
object
title
required
Title
string
detail
required
Detail
string
tone
required
Tone
string
Allowed values: green neutral amber
outcome
required
Outcome
string
evaluated_at
required
Evaluated At
string format: date-time
hours_label
required
Any of:
string
in_hours_now
required
Any of:
boolean
Example
{
  "steps": [
    {
      "tone": "green"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}