VASMS Content Provider API Documentation Ver:1.0.0: Add New Subscription

Запрос на активацию новой подписки
Отправляется со стороны Контент Провайдера по факту получения запроса от Абонента на активацию новой подписки на VAS-услугу.

Примечание: Общая схема взаимодействия.

Request

POST http://<APIURL:PORT>/Subscription/General/AddNew

Request headers

Parameter name	Value	Description	Additional
VASMS-CPID	<uint>	Content Provider ID Уникальный код Контент Провайдера. Предоставляется со стороны VASMS.	Required
VASMS-APIKey	<string>	Content Provider API Key Value Предоставляется со стороны VASMS.	Required
Content-type	application/json; charset=UTF-8		Required

Request body

The request body takes a complete Subscription/General/AddNew resource, containing the following writable properties:

{
    "ARTRID": "uint64",
    "B101": "uint",
    "B102": "uint",
    "B103": "string",
    "B105": "string",
    "B106": "string",
    "CPID": "uint",
    "HELPAT": "string",
    "MSISDN": "string",
    "PSID": "uint64",
    "RDate": "datetime",
    "VASID": "uint"
}

Properties

Name	Type	Description
ARTRID	uint64	API Request Transaction ID Генерируется на стороне КП и должен быть уникальным: - или для группы: Subscription/General. - или глобально для всех API-запросов на усмотрение Контент Провайдера.
B101	uint	Интервал периодической тарификации подписки в часах Possible values are: `6` `12` `24` `168` `720`
B102	uint	Trial-интервал подписки в часах. 0 - отсутствует В данном интервале после активации подписки периодическая тарификация не будет производиться.
B103	string	Канал активации подписки ХХХХ - краткая детализация канала. К примеру SMS:1234. Possible values are: `SMS:XXXX` `USSD:XXXX` `WEB:XXXX` `APP:XXXX` `CALL:XXXX` `CAB:XXXX` `SYS:XXXX`
B105	string	Канал доставки контента Строка которая содержит один или более каналов с использованием запятой в качестве раделителя. К примеру: - SMS - SMS,WEB Possible values are: `SMS` `USSD` `WEB` `APP` `IVR`
B106	string	Тип VAS контента подписки Possible values are: `Quiz` `Educational` `Entertaining` `Informative`
CPID	uint	Content Provider ID Уникальный код Контент Провайдера. Предоставляется со стороны VASMS.
HELPAT	string	Header Enrichment Landing Page Activation Token Токен Активации для запросмов клиентов, которые были предоставлены со стороны VASMS Header Enrichment Landing Page Activation процедуры. Пустое значение если данный параметр отсутствует.
MSISDN	string	Мобильный номер Абонента Только цифры в формате: 998xxxxxxxxx.
PSID	uint64	Provider Subscription ID Генерируется на стороне КП и должно быть уникальным в области действия всех сервисов.
RDate	datetime	Дата и время получения запроса об активации услуги со стороны Абонента UTC timezone RFC3339 format - ex: 2025-02-15T10:11:20Z.
VASID	uint	VAS Service ID Уникальный код VAS-услуги. Предоставляется со стороны VASMS.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	OK Успешная обработка запроса.
400	Bad Request Ошибочный запрос.	400[]
401	Unauthorized Отказ в доступе. Ошибочный VASMS-CPID и/или VASMS-APIKey.
409	Conflict Дубликат транзакции ARTRID.
429	Too Many Requests Слишком много паралельных запросов. (Anti-flood rate limiting).
500	Internal Server Error Системная ошибка на стороне сервера.