Додавання номерів до підписки

Додати номери до існуючої підписки

post

/tracking-push/subscribers/{id}/numbers

Цей метод дозволяє додавати номери відправлень до підписки типу numbers.

Додаються лише ті номери, які вже існують у системі Nova Post. Номер, якого ще немає в системі, до підписки не потрапить — його потрібно буде додати повторно після того, як відправлення буде створено. Код 200 означає, що додано щонайменше один номер, а не обов’язково всі передані. Завжди перевіряйте вміст missedNumbers.

Кількість номерів відправлень, які можна додати до підписки типу numbers, не обмежена.

Після досягнення відправленням фінального статусу видаляти його номер із підписки не обов’язково. Водночас рекомендуємо видаляти завершені відправлення, щоб підтримувати список номерів у підписці актуальним.

Authorizations

AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Path parameters

idstringRequired

Унікальний ідентифікатор підписки, до якої будуть додані номери відправлень. Це обов’язковий параметр шляху.

Example: a866fe22-8134-45c7-bfe9-3cf348415e26

Body

numbersstring[]Optional

Список номерів відправлень, які необхідно додати до підписки.

Example: ["20600000179995","20600000179992"]

Responses

200

Усі або частину номерів успішно додано до підписки.

application/json

messagestringOptional

Текстовий опис результату операції.

addedNumbersstring[]Optional

Список номерів, які успішно додано до підписки.

missedNumbersstring[]Optional

Список номерів, які не було додано. Ці номери не знайдено в системі або вони вже прив’язані до цієї підписки.

400

Жодного номера не додано до підписки.

application/json

401

Unauthorized

application/json

404

The specified resource was not found

application/json

422

Validation error

application/json

503

Connection time-out

application/json

post/tracking-push/subscribers/{id}/numbers

POST /v.1.0/tracking-push/subscribers/{id}/numbers HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "numbers": [
    "20600000179995",
    "20600000179992"
  ]
}

{
  "message": "Numbers successfully added to the subscription.",
  "addedNumbers": [
    "SHPL8642391238"
  ],
  "missedNumbers": [
    "SHPL8642391237"
  ]
}