Skip to main content
Version: v2

Assign Virtual Numbers

Assign or unassign virtual numbers to/from a user.

  • operation: add to assign, remove to unassign
  • outbound_cvn_ids: List of virtual number IDs for outbound calling
  • inbound_cvn_ids: List of virtual number IDs for inbound calling (user will be set as inbound_user)

POST/integrations/assign-virtual-numbers/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Payload

user_id
required
string

ID of the user to assign/unassign virtual numbers. Refers to the user_id retrieved via retrieve user API

operation
required
string
Enum: "add" "remove"

Operation to perform: 'add' to assign, 'remove' to unassign

  • add - add
  • remove - remove
outbound_cvn_ids
Array of strings

List of virtual number IDs for outbound calling

inbound_cvn_ids
Array of strings

List of virtual number IDs for inbound calling (user will be set as inbound_user)

Response

{
"success": true,
"message": "Successfully assigned virtual numbers"
}