Claim an available dedicated line

Add a dedicated number to your workspace. Messages to it come to you through the API and webhooks. This has to be turned on for your workspace, or you get 403 line_claim_not_allowed. Scope: comms_lines_write.

post/lines/claim

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/lines/claim
  • Auth: HTTP bearer

Request body

e164string

The number to claim, in E.164 format. Leave it out to get the next free number.

Response

Line claimed

e164string
inbound_mode'api' | 'agent'
statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.