Skip to content
vocapable.Docs

Block or allow a caller's number

POST
/v1/workspace/phone-screening/rules
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/phone-screening/rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "block", "phone_e164": "example", "from_decision_id": "example", "reason": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InboundNumberRuleCreate

Block or allow a number - typed in, or the caller of a screened call (so the phone never needs the full number to block it).

object
action
required
Action
string
Allowed values: block allow
phone_e164
Any of:
string
/^\+[1-9][0-9]{6,14}$/
from_decision_id
Any of:
string
>= 1 characters <= 64 characters
reason
Any of:
string
<= 200 characters

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
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
Example
{
  "action": "block"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}