New Subscription - IVR Activate

IVR Menu для активации подписки
Если данная подписка была активирована Абоненту на основании IVR menu и отправляется только после успешной активации подписки на платформе VASMS (после получения успешного подтверждения команды API:Subscription/General/AddNew).

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

Request

POST http://<APIURL:PORT>/Subscription/IVR/ActivateMenu

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/IVR/ActivateMenu resource, containing the following writable properties:

{
    "ARTRID": "uint64",
    "CPID": "uint",
    "IVRDate": "datetime",
    "IVRMenu": "string",
    "IVRSN": "uint",
    "MSISDN": "string",
    "PSID": "uint64",
    "VASID": "uint"
}

Properties

Name Type Description Additional
ARTRID uint64

API Request Transaction ID
Генерируется на стороне КП и должен быть уникальным:
- или для группы: Subscription/IVR.
- или глобально для всех API-запросов на усмотрение Контент Провайдера.
CPID uint

Content Provider ID
Уникальный код Контент Провайдера. Предоставляется со стороны VASMS.
IVRDate datetime

Дата и время IVR звонка
UTC timezone RFC3339 format - ex: 2025-02-15T10:11:20Z.

 Optional
IVRMenu string

IVR Menu
IVR Menu на основании которого Абонент активировал подписку. К примеру 1-3-2
IVRSN uint

IVR Short Number
Короткий номер IVR VAS-сервиса, в меню которого Абонент активировал подписку.
MSISDN string

Мобильный номер Абонента
Только цифры в формате: 998xxxxxxxxx.
PSID uint64

Provider Subscription ID
Генерируется на стороне КП и должно быть уникальным в области действия всех сервисов.
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

Системная ошибка на стороне сервера.