Whether your company can call from the browser

GET

/v1/workspace/voice

const url = 'https://api.vocapable.com/v1/workspace/voice';
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/workspace/voice \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceVoiceStatus

Whether this company’s people can call from the browser, and what is missing.

object

state

required

State

string

Allowed values: ready needs_setup unavailable

code

required

Code

string

Allowed values: ready voice_plane_unavailable no_byo_account account_unverified no_voice_number not_provisioned provisioning_failed

message

required

Message

string

recovery

required

Recovery

string

can_set_up

required

Can Set Up

boolean

caller_id

required

Any of:

string
null

string

telephony_account_id

required

Any of:

string
null

string

last_error

Any of:

string
null

string

incoming_push

Any of:

WorkspaceIncomingPush
null

WorkspaceIncomingPush

Whether a backgrounded or locked phone can be rung, per platform. Non-fatal: browser calling works whatever this says.

object

apns

required

Apns

string

Allowed values: ready missing_material failed not_provisioned

fcm

required

Fcm

string

Allowed values: ready missing_material failed not_provisioned

errors

Errors

object

key

additional properties

string

Example

{
  "state": "ready",
  "code": "ready",
  "incoming_push": {
    "apns": "ready",
    "fcm": "ready"
  }
}