Skip to content
vocapable.Docs

Spam screening (owner/manager)

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
InboundScreening
object
settings
required
InboundScreeningSettings
object
screening_enabled
required
Screening Enabled
boolean
lookup_enabled
required
Lookup Enabled
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
blocked
required
Blocked
Array<object>
InboundNumberRule
object
id
required
Id
string
action
required
Action
string
Allowed values: block allow
number_display
required
Number Display
string
reason
required
Any of:
string
created_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
created_at
required
Created At
string format: date-time
allowed
required
Allowed
Array<object>
InboundNumberRule
object
id
required
Id
string
action
required
Action
string
Allowed values: block allow
number_display
required
Number Display
string
reason
required
Any of:
string
created_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
created_at
required
Created At
string format: date-time
recent
required
Recent
Array<object>
InboundScreenedCall
object
id
required
Id
string
decision
required
Decision
string
Allowed values: blocked screened screen_unavailable
reasons
required
Reasons
Array<string>
reason_labels
required
Reason Labels
Array<string>
line_name
required
Any of:
string
caller_display
required
Caller Display
string
current_rule
required
Any of:
string
Allowed values: block allow
can_set_rule
required
Can Set Rule
boolean
created_at
required
Created At
string format: date-time
can_manage
required
Can Manage
boolean
Example
{
  "blocked": [
    {
      "action": "block"
    }
  ],
  "allowed": [
    {
      "action": "block"
    }
  ],
  "recent": [
    {
      "decision": "blocked",
      "current_rule": "block"
    }
  ]
}