Getting sms provider creds

Метод	Путь	Описание
POST	/provider-creds-sms	Получение учетных данных SMS-провайдера.

Request body
*Required

{
     "AUTH": "test"
}

Request body schema	Тип	Пример значения	Описание
AUTH	string	`test`	Токен аутентификации/ключ, необходимый для доступа к API.

Request URL:
`http://<mapi.services>/provider-creds-sms`

Example request:

curl -X 'POST' \
     'http://<mapi.services>/provider-creds-sms' \
     -H 'accept: application/json' \
     -H 'Content-Type: application/json' \
     -d '{
     "AUTH": "test"
   }'

Responses:

200 Successful operation

Учетные данные SMS-провайдера получены.

Controls Accept header. Media type `application/json`

Example response:

{
    "status": "success",
    "info": [
       {
         "id": 1,
         "name": "PName",
         "code": "pname",
         "info": "{\"api_key\":{\"name\":\"API key\",\"position\":1,\"description\":\"Your API key\"}}",
         "is_active": null,
         "from": null,
         "param1": null,
         "param2": null
       }
    ]
}

Response schema	Тип	Описание	Пример
success	string	Указывает статус запроса. `success` или `error`.	success
info	array	Массив, содержит информацию о SMS-провайдере.
└─ id	integer	Уникальный идентификатор SMS-провайдера.	1
└─ name	string	Наименование SMS-провайдера.	PName
└─ code	string	Код SMS-провайдера.	pname
└─ info	string	JSON-кодированная строка, содержит дополнительные детали о ключе API провайдера. `api_key` - объект, содержит детали о ключе API: `name` (строка): название ключа, `position` (целое число): позиция ключа в конфигурации, `description` (строка): описание назначения ключа.	{\"api_key\": {\"name\":\"API key\", \"position\":1, \"description\":\"Your API key\"}}
└─ is_active	string/null	Статус активности провайдера (`1` - активен, `0` - неактивен).	null
└─ from	string/null	Идентификатор/наименование отправителя. Может быть `null`.	null
└─ param1	string/null	Дополнительный параметр для конфигурации. Может быть `null`.	null
└─ param2	string/null	Дополнительный параметр для конфигурации. Может быть `null`.	null

503 Error: Service Unavailable

Ошибка сервиса. Сервер временно недоступен для обработки запроса.

Media Type: `text/plain`

Example response:

No auth

Response schema	Тип	Описание
message	string	Описание ошибки. "No auth" - отсутствуют необходимые учетные данные для выполнения запроса.

29 September 2025