posthttps://{ourserver.com}/api/auth/me

POST /api/auth/me

Change the list of the disabled services

This request allows to add services to the blacklist preventing them to be used for SMS activation on your numbers.

This request might come in handy when you use your numbers for SMS verification for your own purposes or projects. It will block these services on your account entirely assigning them USED status and preventing them to be issued to the clients.

Parameters

header1

Name	Type	Description
`Authorization`*	`string`	see more here

Request Body

Payload for saveConfig request

Content-Typeapplication/json

Schema

Bodyobject

disabled_serviceobject

An object where the keys and values are the slugs of services that should be disabled for sale on your account. The names must match theservices list

[additionalProperties]string

Short service name (slug)

Examples

Example payload for adding VKcom and Facebook to the blacklist

{
  "disabled_service": {
    "vkcom": "vkcom",
    "facebook": "facebook"
  }
}

Responses

200

Successful response with partner profile data

Content-Typeapplication/json

Schema

Responseobject

idinteger

Unique identifier of the partner

namestring

Display name of the user / Login

emailstring

Email address of the user

Format:email

groupinteger

ID of the group to which the current account belongs: 0 - common, 2 - partners providing numbers for the "SMS receiving" service, 3 - partners providing numbers for the "Number rental" service, 4 - partners providing numbers for the "Number rental with extension" service

blockboolean

Flag indicating whether the current account is blocked (true - account is blocked)

Default:false

telegramstring | nullNullable

Telegram username linked to the current account

telegram_keyinteger | nullNullable

ID of the link to the Telegram bot

commentstring | nullNullable

Comment for the current account

Default:null

apikeystring

API key of the user

allowed_ipsstring[]

List of IP addresses allowed for API access (see Access from IP field). By default, access is allowed from all IP addresses.

Default:[]

itemsstring

typeinteger

Hardware type. This field is a profile reference label and does not affect the number issuance logic

countrystring

Operator country, defaults to 0.This field is a profile reference label and does not affect the number issuance logic

referral_idinteger | nullNullable

Referrer ID

disabled_serviceobject

Object where keys and values are service slugs (according to the services list) that are disabled for sale on this account. The key and value are identical. When editing the list, you need to resend the sendNumbersOnline request for the changes to take effect.

[additionalProperties]string

disabled_service_adminstring[]

List of services disabled by the administrator for ordering on the provided numbers (empty array if none).

itemsstring

settingsobject

Settings of the current account

ussdCommandsobject

Dictionary of mapping IMSI masks for USSD commands, where the key is a string with the mask digits to be searched, and the value is a string with the USSD command that will be executed to determine the subscriber number

[additionalProperties]string

Operator/IMSI mask for setting the USSD command

logLevelstring

Logging level for the current account

Default:debug

number_notificationinteger

Income level of the SIM card in RUB, at which a notification is sent to the Telegram bot

Default:65

balance_notificationinteger

Balance income level of the profile, at which a notification is sent to the Telegram bot

Default:3500

disabled_templatesstring[]

List of custom message templates that are prohibited from being sent to the client

Default:[]

itemsstring

Group of disabled templates

created_atstring

Date and time of account creation

updated_atstring

Date and time of last account update

is_adminboolean

Flag indicating whether the current account is an administrator

Default:false

balanceobject

Account balance information

sumnumber

Accrued balance sum of the current account

blocknumber

Frozen balance sum for current operations

spendnumber

Spent/withdrawn balance sum of the current account

incomenumber

Current balance amount of the number provider (available for withdrawal in the PSA)

Format:float

sms_countinteger

Number of SMS received by the current account

pursestring | nullNullable

Account withdrawal details

additional_infostring | nullNullable

Wallet/bank name used for the withdrawal (if applicable)

teststring

Optional field for the request body of Reseller API v2. Allowed values are test1, test2.

While being assigned, test1 value will allow the request to be passed, however the data won't be saved by our server (the function will not be executed by this request).

While being assigned, test2 value will print out your request's payload in response.

Can be passed as query parameter (for GET) or as a field in request's body (for POST). Both ways are equivalent, but using them simultaneously is not recommended.

Enum:test1test2

Examples

Example response from Onlinesim server for successfuly modified service blacklist39 lines

{
  "id": 12345,
  "name": "partner_name",
  "email": "partner@example.com",
  "group": 3,
  "block": false,
  "telegram": null,
  "telegram_key": null,
  "comment": null,
  "apikey": "<api_key>",
  "allowed_ips": [],
  "type": 0,
  "country": "0",
  "referral_id": null,
  "disabled_service": {
    "vkcom": "vkcom",
    "facebook": "facebook"
  },
  "disabled_service_admin": [],
  "settings": {
    "ussdCommands": {},
    "logLevel": "debug",
    "number_notification": 65,
    "balance_notification": 3500,
    "disabled_templates": []
  },
  "created_at": "2024-01-15 10:00:00",
  "updated_at": "2026-08-26 12:00:00",
  "is_admin": false,
  "balance": {
    "sum": 100.5,
    "block": 0,
    "spend": 50,
    "income": 150.5,
    "sms_count": 10,
    "purse": null,
    "additional_info": null
  }
}

Incorrect key passed

[
  {
    "response": "ERROR_WRONG_KEY"
  }
]

400

Missing or incorred parameters (request must contain parameters in it's body with proper names as described in documentation)

Content-Typeapplication/json

Schema

Responseobject

responsestringRequired

Enum:ERROR_PARAMS

messagestringRequired

401

Unauthorized. The request is missing or uses an invalid API key. Some endpoints may return a 200 status with an ERROR_WRONG_KEY message instead of 401 — check the response body

Content-Typetext/plain

Schema

Responsestring

Enum:Unauthorized

403

Forbidden. The request was understood but refused due to insufficient permissions

Content-Typeapplication/json

Schema

Responseobject

errorobjectRequired

statusinteger

HTTP response code in text format

codestring

messagestring

Possible error codes: - ERROR_DISABLED - partner account is not activated - ERROR_IP - IP address is not in the list of allowed addresses - allowlist (see Access from IP field) - ERROR_RENT - account has no access to rent

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

messagestringRequired

Enum:ERROR_DISABLEDERROR_IPERROR_RENT

detailsobject[]Required

itemsobject

422

Unprocessable Entity. The request was well-formed but contained semantic errors.

The response and message fields contain the same JSON string with detailed error mapping. Parse this string as JSON to identify which fields failed validation.

Content-Typeapplication/json

Schema

Responseobject

responsestringRequired

Error code. Contains the same JSON string as message with field-specific validation errors.

messagestringRequired

Human-readable error message. Contains the same JSON string as response with field-specific validation errors. Parse this string as JSON to get detailed error mapping.

Code Samples

Generating examples...