Skip to content
vocapable.Docs

Your lines, default line and calling preferences

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCallingProfile

What the person reading needs to place a call: their lines and preferences.

object
default_line_id
required
Any of:
string
default_line_set_by
required
Any of:
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
effective_line
required
Any of:
WorkspaceCallLine

The business line a call came from (E12-R1): the company’s own number, named.

object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
permitted_line_ids
required
Permitted Line Ids
Array<string>
call_mode_preference
required
Call Mode Preference
string
Allowed values: app carrier_callback
callback_phone_hint
required
Any of:
string
settings
required
WorkspaceCallingSettings

The owner’s calling choices for the whole company. Every one defaults to off.

object
allow_personal_phone
required
Allow Personal Phone
boolean
allow_dial_pad
required
Allow Dial Pad
boolean
show_customer_numbers
required
Show Customer Numbers
boolean
revision
required
Revision
integer
updated_by
required
Any of:
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
updated_at
required
Any of:
string format: date-time
allow_supervision
Allow Supervision
boolean
summary_language
Summary Language
string
default: spoken
Allowed values: spoken en es
allow_offline_text_queue
Allow Offline Text Queue
boolean
revision
required
Revision
integer
ring_preference
Ring Preference
string
default: app_then_phone
Allowed values: app_then_phone phone_only app_only
working_hours
Any of:
WorkspaceWorkingHours

The person’s own weekly hours. A day that is absent or empty is not worked. time_off lists date ranges off (at most 24, each at most a year); past ranges may stay and simply no longer match.

object
timezone
required
Timezone
string
>= 1 characters <= 64 characters
days
Days
object
key
additional properties
Array<object>
WorkspaceWorkingWindow

One span of a working day, local to the hours’ timezone. 24:00 ends at midnight; a shift across midnight is two windows.

object
start
required
Start
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
End
string
/^(([01]\d|2[0-3]):[0-5]\d|24:00)$/
time_off
Time Off
Array<object>
<= 24 items
WorkspaceTimeOff

Whole days off - a holiday, leave (PRD E11-R2). Local dates in the hours’ timezone, both inclusive; on these days the person is never rung, whatever the weekly hours say.

object
start
required
Start
string format: date
end
required
End
string format: date
label
Any of:
string
>= 1 characters <= 80 characters
dnd_until
Any of:
string format: date-time
availability
Any of:
WorkspaceAvailability

What the dispatcher, the receptionist’s transfer and the team page all read.

object
state
required
State
string
Allowed values: available away offline do_not_disturb off_hours after_call_work
presence_state
required
Any of:
string
Allowed values: available away offline
presence_until
required
Any of:
string format: date-time
dnd_until
required
Any of:
string format: date-time
in_working_hours
required
Any of:
boolean
changes_at
required
Any of:
string format: date-time
time_off_until
Any of:
string format: date-time
ring_preference
required
Ring Preference
string
Allowed values: app_then_phone phone_only app_only
app_ready
required
App Ready
boolean
phone_ready
required
Phone Ready
boolean
rings_app
required
Rings App
boolean
rings_phone
required
Rings Phone
boolean
Example
{
  "call_mode_preference": "app",
  "settings": {
    "allow_supervision": false,
    "summary_language": "spoken",
    "allow_offline_text_queue": false
  },
  "ring_preference": "app_then_phone",
  "availability": {
    "state": "available",
    "presence_state": "available",
    "ring_preference": "app_then_phone"
  }
}