Skip to content
Vocapable Developers

Read privacy-safe live receptionist operations by business number

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

Return operational facts, not a second agent/policy/calling-control surface.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileReceptionistHub

Live Receptionists hub data for Admins and Managers.

object
generated_at
required
Generated At
string format: date-time
items
Items
Array<object>
<= 100 items
MobileReceptionistHubItem

A privacy-safe, per-number receptionist operations card.

object
phone_number_id
required
Phone Number Id
string
phone_e164
required
Phone E164
string
/^\+[1-9]\d{6,14}$/
published_state
required
Published State
string
Allowed values: published not_published
schedule
required
MobileReceptionistScheduleSummary

The authoritative policy schedule answer when this line has one.

A direct-agent line has no tenant business-hours document, and a malformed/stale policy is not safe to interpret in the app. Both are intentionally unavailable.

object
state
required
State
string
Allowed values: open closed unavailable
emergency_override
required
MobileReceptionistEmergencyOverrideSummary

Current override state without its routing mode, destination, or control id.

object
state
required
State
string
Allowed values: none active cleared expired invalid unavailable
expires_at
Any of:
string format: date-time
coverage
required
MobileReceptionistCoverageSummary

Current direct-rep coverage, after the runtime’s safety gates are intersected.

object
state
required
State
string
Allowed values: covered uncovered not_configured unavailable
active_rep_count
Any of:
integer
<= 20
last_authorized_mobile_test
Any of:
MobileReceptionistAuthorizedTest

Evidence that mobile opened an authorized system-dialer test target.

Authorization does not prove that the carrier call connected, much less that the receptionist completed it. result therefore stays nullable until a distinct, durable carrier-result evidence path exists.

object
authorized_at
required
Authorized At
string format: date-time
result
Any of:
string
Allowed values: passed failed
open_follow_up_count
required
Open Follow Up Count
integer
Example
{
  "items": [
    {
      "published_state": "published",
      "schedule": {
        "state": "open"
      },
      "emergency_override": {
        "state": "none"
      },
      "coverage": {
        "state": "covered"
      },
      "last_authorized_mobile_test": {
        "result": "passed"
      }
    }
  ]
}