List active receptionist lines and their bounded mobile Studio state

GET

/v1/mobile/receptionist/studio

const url = 'https://api.vocapable.com/v1/mobile/receptionist/studio';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

Response List Receptionist Studio V1 Mobile Receptionist Studio Get

Array<object>

MobileReceptionistStudioSummary

One safe receptionist fact-draft projection for native operations views.

object

phone_number_id

required

Phone Number Id

string

has_published_receptionist

required

Has Published Receptionist

boolean

business_facts

Business Facts

object

key

additional properties

string

short_greeting

Any of:

string
null

string

escalation_preference

Escalation Preference

string

default: standard

Allowed values: standard handoff_when_available booking_first

temporary_status

Any of:

MobileTemporaryCustomerStatus
null

MobileTemporaryCustomerStatus

One bounded, expiring proposed public-status update.

The finite template is shown in the native preview and recorded in the audit trail. The message remains concise, cannot alter policy/tool wording, and must be reviewed in canonical intelligence before it can be spoken. Its expiry travels with the source evidence so reviewers do not mistake a temporary notice for durable business knowledge.

object

template

required

Template

string

Allowed values: service_update special_hours weather_delay

message

required

Message

string

>= 1 characters <= 180 characters

expires_at

required

Expires At

string format: date-time

version

required

Version

integer

>= 1

updated_at

Any of:

string
null

string format: date-time

Example

[
  {
    "escalation_preference": "standard",
    "temporary_status": {
      "template": "service_update"
    }
  }
]