Skip to content
vocapable.Docs

Accept terms and request a company number

POST
/v1/mobile/managed-numbers/requests
curl --request POST \
  --url https://api.vocapable.com/v1/mobile/managed-numbers/requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "request_key": "example", "phone_e164": "example", "terms_version": "example", "terms_sha256": "example", "accept_terms": true }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ManagedNumberRequestCreate
object
request_key
required
Request Key
string
/^[A-Za-z0-9_:.\-]{1,128}$/
phone_e164
required
Phone E164
string
/^\+1[2-9][0-9]{9}$/
terms_version
required
Terms Version
string
>= 1 characters <= 128 characters
terms_sha256
required
Terms Sha256
string
/^[0-9a-f]{64}$/
accept_terms
required
Accept Terms
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ManagedNumberSetupSnapshot
object
company_id
required
Company Id
string
acquisitions
required
Acquisitions
Array<object>
ManagedAcquisitionStatus

Acquisition evidence only. Acquired does not mean routed or activated.

object
id
required
Id
string
kind
required
Kind
string
Allowed values: subaccount number
state
required
State
string
Allowed values: pending started acquired refused cancelled
phone_e164
required
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
can_cancel
required
Can Cancel
boolean
selected_request
Any of:
ManagedNumberRequestStatus
object
id
required
Id
string
phone_e164
required
Phone E164
string
terms_version
required
Terms Version
string
state
required
State
string
Allowed values: pending confirming acquired action_needed cancelled
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
can_cancel
required
Can Cancel
boolean
Example
{
  "acquisitions": [
    {
      "kind": "subaccount",
      "state": "pending"
    }
  ],
  "selected_request": {
    "state": "pending"
  }
}

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": {}
    }
  ]
}