Skip to content
vocapable.Docs

Call routing: the draft, what is live, and who can be rung

GET
/v1/workspace/routing
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/routing \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceRouting
object
draft
required
Any of:
WorkspaceRoutingPlan
object
id
required
Id
string
status
required
Status
string
Allowed values: draft live superseded
version
required
Version
integer
strategy
required
Strategy
string
Allowed values: company_owner_first longest_available ring_together
member_user_ids
required
Member User Ids
Array<string>
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
required
Any of:
string
published_at
required
Any of:
string format: date-time
published_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
publish_report
required
Any of:
WorkspaceRoutingPublishReport
object
phone_number_id
required
Phone Number Id
string
phone_e164
required
Phone E164
string
rung
required
Rung
Array<object>
WorkspaceRoutingRung
object
user_id
required
User Id
string
name
required
Name
string
rep_id
required
Rep Id
string
excluded
required
Excluded
Array<object>
WorkspaceRoutingExcluded
object
user_id
required
User Id
string
name
required
Name
string
reason
required
Reason
string
live_behaviour
required
Live Behaviour
string
answering_policy_version
required
Answering Policy Version
integer
agent_id
required
Any of:
string
phone_test
required
Any of:
WorkspaceRoutingPhoneTest
object
verified_at
required
Verified At
string format: date-time
verified_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
outcome
required
Outcome
string
Allowed values: person_answered ai_answered voicemail_captured
call_ref
required
Call Ref
string
occurred_at
required
Occurred At
string format: date-time
detail
required
Detail
string
revision
required
Revision
integer
updated_at
required
Updated At
string format: date-time
live
required
Live
Array<object>
WorkspaceRoutingPlan
object
id
required
Id
string
status
required
Status
string
Allowed values: draft live superseded
version
required
Version
integer
strategy
required
Strategy
string
Allowed values: company_owner_first longest_available ring_together
member_user_ids
required
Member User Ids
Array<string>
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
required
Any of:
string
published_at
required
Any of:
string format: date-time
published_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
publish_report
required
Any of:
WorkspaceRoutingPublishReport
object
phone_number_id
required
Phone Number Id
string
phone_e164
required
Phone E164
string
rung
required
Rung
Array<object>
WorkspaceRoutingRung
object
user_id
required
User Id
string
name
required
Name
string
rep_id
required
Rep Id
string
excluded
required
Excluded
Array<object>
WorkspaceRoutingExcluded
object
user_id
required
User Id
string
name
required
Name
string
reason
required
Reason
string
live_behaviour
required
Live Behaviour
string
answering_policy_version
required
Answering Policy Version
integer
agent_id
required
Any of:
string
phone_test
required
Any of:
WorkspaceRoutingPhoneTest
object
verified_at
required
Verified At
string format: date-time
verified_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
outcome
required
Outcome
string
Allowed values: person_answered ai_answered voicemail_captured
call_ref
required
Call Ref
string
occurred_at
required
Occurred At
string format: date-time
detail
required
Detail
string
revision
required
Revision
integer
updated_at
required
Updated At
string format: date-time
members
required
Members
Array<object>
WorkspaceRoutingMember
object
user_id
required
User Id
string
name
required
Name
string
role
required
Role
string
presence_label
required
Presence Label
string
ready
required
Ready
boolean
skipped_because
required
Any of:
string
phone_ready
required
Phone Ready
boolean
phone_exclusion_reason
required
Any of:
string
numbers
required
Numbers
Array<object>
WorkspaceRoutingNumber
object
id
required
Id
string
phone_e164
required
Phone E164
string
route
required
Route
string
hours_label
required
Any of:
string
timezone
required
Any of:
string
in_hours_now
required
Any of:
boolean
ai_agent_id
required
Any of:
string
follow_up_owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
can_edit
required
Can Edit
boolean
ring_choices
required
Ring Choices
Array<integer>
Example
{
  "draft": {
    "status": "draft",
    "strategy": "company_owner_first",
    "fallback": "ai_receptionist",
    "after_hours": "ai_receptionist",
    "phone_test": {
      "outcome": "person_answered"
    }
  },
  "live": [
    {
      "status": "draft",
      "strategy": "company_owner_first",
      "fallback": "ai_receptionist",
      "after_hours": "ai_receptionist",
      "phone_test": {
        "outcome": "person_answered"
      }
    }
  ]
}