The calling window your company applies

GET

/v1/workspace/calling-policy

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

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceCallingPolicy

The company’s calling window and the rules layered on it.

window_*_local is what binds before any state rule: the owner’s window when one is set (owner_set), else the product default. revision is 0 until the owner saves one; send it back as expected_revision.

object

window_start_local

required

Window Start Local

string format: time

window_end_local

required

Window End Local

string format: time

default_window_start_local

required

Default Window Start Local

string format: time

default_window_end_local

required

Default Window End Local

string format: time

owner_set

required

Owner Set

boolean

revision

required

Revision

integer

updated_at

required

Any of:

string
null

string format: date-time

updated_by

required

Any of:

WorkspacePersonRef
null

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

rules_version

required

Rules Version

string

default_citation

required

Default Citation

string

state_rules

required

State Rules

Array<object>

WorkspaceStateCallingRule

One state’s encoded rule, with the primary source it came from.

object

jurisdiction

required

Jurisdiction

string

channels

required

Channels

Array<string>

Allowed values: voice sms

window_start_local

required

Window Start Local

string format: time

window_end_local

required

Window End Local

string format: time

sunday_window_start_local

required

Any of:

string
null

string format: time

sunday_window_end_local

required

Any of:

string
null

string format: time

frequency_cap

required

Any of:

integer
null

integer

frequency_cap_period_hours

required

Any of:

integer
null

integer

citation

required

Citation

string

effective_from

required

Effective From

string format: date

notes

required

Notes

string

Example

{
  "state_rules": [
    {
      "channels": [
        "voice"
      ]
    }
  ]
}