Phone features switched on for this company, and its entitlements

GET

/v1/mobile/workspace/phone/capabilities

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

Authorizations

MobileBearer

Responses

200

Successful Response

application/json

PhoneCapabilities

object

features

required

Features

object

key

additional properties

boolean

entitlements

required

PhoneEntitlements

object

calling

required

PhoneEntitlement

object

entitled

required

Entitled

boolean

reason

required

Any of:

string
null

string

Allowed values: plan_required addon_required registration_required

recording_transcription

required

PhoneEntitlement

object

entitled

required

Entitled

boolean

reason

required

Any of:

string
null

string

Allowed values: plan_required addon_required registration_required

texting

required

PhoneEntitlement

object

entitled

required

Entitled

boolean

reason

required

Any of:

string
null

string

Allowed values: plan_required addon_required registration_required

settings

PhoneCapabilitySettings

The owner’s choices the phone itself must honour while it cannot ask the server.

object

offline_text_queue

Offline Text Queue

boolean

Example

{
  "entitlements": {
    "calling": {
      "reason": "plan_required"
    },
    "recording_transcription": {
      "reason": "plan_required"
    },
    "texting": {
      "reason": "plan_required"
    }
  },
  "settings": {
    "offline_text_queue": false
  }
}