Skip to content

Enabling virtual numbers

Method enable.virtual_numbers
Description Enabling virtual numbers
Who has access Agent, Customer

Parameters of a request

Title Type Required Description
access_token string yes Authentication session key
virtual_phone_number string yes Virtual number
user_id number no Unique user ID of an agent's customer who makes request
Is required for agent

JSON request structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "enable.virtual_numbers",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "virtual_phone_number": "string"
  }
}

JSON reply structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "success": true
  }
}

List of returning errors

Error text Error code Error mnemonics
Action is not allowed for your tariff plan. You need contact support service or change your tariff plan settings in your account -32602 tariff_restrictions
Virtual phone number {virtual_phone_number} not found. -32007 virtual_phone_number_not_found

Refer to the section "List of errors for the methods with the verb get"