Konto

Saldo i ustawienia konta

Saldo, cennik (w tym price_per_hlr_grosze za sprawdzenie numeru), tryb konta, model rozliczenia (billing_mode: prepaid domyślnie, postpaid włączany na życzenie po weryfikacji firmy), domyślny nadpis, domyślne okno godzin wysyłki (send_window), numer odbiorczy do odpowiedzi 2-way (inbound_number; null, dopóki odbiór nie jest uruchomiony na życzenie dla konta), Twoje słowo kluczowe do odpowiedzi (inbound_prefix) i zakresy użytego klucza (scopes). Wymaga zakresu read.

get/v1/account

Request

  • Base URL: https://api.przypominamy.com
  • URL: https://api.przypominamy.com/v1/account
  • Auth: HTTP bearer

Response

Konto

country_ratesobject

Indywidualne stawki zagraniczne: prefiks numeru → ceny kanałów w groszach netto. Bez pasującej stawki SMS kosztuje 2× krajową cenę konta; MMS i głos wymagają osobnej wyceny. Najdłuższy prefiks wygrywa. Polska używa standardowej ceny konta.

idstring
namestring
sender_namestring nullable
balance_groszeinteger
credit_limit_groszeinteger
price_per_part_groszeinteger
price_per_mms_groszeinteger
price_per_vms_groszeinteger
price_per_hlr_groszeinteger

Cena sprawdzenia numeru (HLR) w groszach

rate_limit_per_minuteinteger
webhook_urlstring nullable
status'active' | 'suspended' | 'closed'
mode'test' | 'live'

test - tylko zweryfikowane numery, koszt z puli testowej

test_creditsinteger

Pozostałe darmowe wiadomości (tylko w trybie test)

send_windowstring nullable

Domyślne okno godzin wysyłki konta (czas polski) lub null

billing_mode'prepaid' | 'postpaid'

prepaid (domyślnie) - saldo doładowane z góry. postpaid - włączany przez nas na życzenie po weryfikacji firmy: saldo może zejść poniżej zera do credit_limit_grosze, 1. dnia miesiąca wystawiamy zestawienie za poprzedni miesiąc (14 dni na przelew, tytuł = id zestawienia), po terminie wysyłki są wstrzymane (402 insufficient_funds) do zaksięgowania wpłaty.

inbound_numberstring nullable

Numer odbiorczy, na który odbiorcy mogą odpisać (2-way). Odbiór uruchamiamy na życzenie - null, dopóki nie jest włączony dla konta

inbound_prefixstring nullable

Twoje słowo kluczowe: SMS zaczynający się od niego trafia do Twojego konta niezależnie od wcześniejszych wysyłek (PATCH /v1/account)

scopesstring[]

Zakresy klucza użytego w tym żądaniu

Example response

{
  "id": "cl_3W4997VtDI8fG1hM",
  "sender_name": "ZDROWKO",
  "balance_grosze": 4982,
  "price_per_part_grosze": 9,
  "price_per_mms_grosze": 35,
  "price_per_vms_grosze": 25,
  "price_per_hlr_grosze": 5,
  "rate_limit_per_minute": 120,
  "send_window": "08:00-20:00",
  "billing_mode": "prepaid",
  "inbound_number": "+48799000000",
  "inbound_prefix": "ZDROWKO",
  "scopes": [
    "send",
    "read",
    "manage"
  ],
  "international_sms": {
    "default_multiplier": 2,
    "price_per_part_grosze": 30,
    "currency": "PLN"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.