przypominamy-com Czarna lista API

openapi: 3.2.0
info:
  title: Przypominamy Com Czarna lista API
  version: 2.3.0
  contact:
    name: Wsparcie Przypominamy.com
    email: support@przypominamy.com
    url: https://przypominamy.com/api
  license:
    name: Proprietary
    url: https://przypominamy.com/regulamin
  termsOfService: https://przypominamy.com/regulamin
  x-audience: Polskie małe i średnie firmy integrujące SMS w CRM, e-commerce, aplikacjach 2FA, systemach umawiania wizyt i windykacji.
  x-llm-summary: 'Przypominamy.com to polskie REST API do wysyłki SMS. Jeden endpoint POST /v1/messages wysyła do jednego lub do 500 odbiorców (pole to: string, tablica albo "group:<nazwa>" - grupa kontaktów), z polami text (placeholdery {{imie}}, {{nazwisko}}, {{email}}, pola własne, {{opt_out}} = osobisty link wypisu), from (nadpis), send_at (ISO 8601, do 90 dni), send_window ("08:00-20:00", czas polski), expires_at (15 min – 72 h), reference. Zamiast text: template_id (szablon z GET/POST /v1/templates, {{klucz}} z params); priority: true = SMS priorytetowy, osobna kolejka, cena ×2. GET /v1/numbers/{msisdn}/lookup = HLR (status active/inactive/invalid/unknown, sieć; 0,05 zł, wynik z 24 h bez opłaty). DELETE /v1/messages/{id} anuluje zaplanowaną wysyłkę (status cancelled, zwrot kosztu). Historia: GET /v1/messages (cursor, filtry status/reference/to) i GET /v1/messages/{id}. Konto: GET /v1/account (saldo w groszach, cena za część, scopes, send_window, inbound_number, inbound_prefix), PATCH /v1/account (sender_name, send_window, inbound_prefix), GET /v1/senders, PUT /v1/account/webhook. Śledzone linki: {{link:https://…}} w text (do 2 adresów) = krótki link api.przypominamy.com/l/<token> per odbiorca z licznikiem kliknięć; GET /v1/messages/{id} zwraca links[], GET /v1/links (message_id, clicked=true) i GET /v1/links/{token} (click_log), webhook link.clicked przy pierwszym kliknięciu; bez dopłaty. Odbiór odpowiedzi (2-way) na życzenie, po uruchomieniu numeru odbiorczego w usłudze (do tego czasu inbound_number = null, lista pusta): odpowiedź ze słowem kluczowym klienta (inbound_prefix) albo od numeru, do którego klient pisał w ciągu 30 dni, trafia na GET /v1/inbound (from, since, unread, mark_read, cursor; pola id, from, to, text, reply_to, matched_by prefix|last_message, received_at, read_at) i GET /v1/inbound/{id}; webhook message.received z data.inbound i data.opt_out; STOP/WYPISZ/NIE = numer na czarną listę. Czarna lista: GET/POST /v1/blacklist, DELETE /v1/blacklist/{msisdn}; numery z listy dostają status rejected bez opłaty. Kontakty i grupy: GET/POST /v1/contacts, GET/PATCH/DELETE /v1/contacts/{id}, GET/POST /v1/groups, GET/PATCH/DELETE /v1/groups/{id}, POST /v1/groups/{id}/contacts, DELETE /v1/groups/{id}/contacts/{contactId}. Autoryzacja Bearer pk_live_… z zakresami send/read/manage (403 forbidden bez zakresu); klucz z panelu app.przypominamy.com/keys. Webhooki message.sent/delivered/undelivered/failed/expired, message.received i link.clicked podpisane HMAC-SHA256 w nagłówku X-Przypominamy-Signature (t=<unix>,v1=<hex>, podpis nad ''<t>.<body>'', tolerancja 300 s). Idempotency-Key. Błędy jako {error:{code,message,param},request_id}. Prepaid (domyślnie; billing_mode w GET /v1/account), saldo w groszach, 402 przy braku środków, 120 żądań/min. Postpaid na życzenie po weryfikacji: zestawienie miesięczne 1. dnia miesiąca, 14 dni na przelew, po terminie 402 do zaksięgowania wpłaty.'
  x-logo:
    url: https://przypominamy.com/przypominamy-logo.png
    altText: Przypominamy.com
  description: 'Operations tagged Czarna lista across 2 of this provider''s published API definitions: openapi.json, przypominamy-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.przypominamy.com
  description: Produkcja
security:
- bearerAuth: []
tags:
- name: Czarna lista
  description: Numery, na które konto nie wysyła; link opt-out
paths:
  /v1/blacklist:
    get:
      tags:
      - Czarna lista
      summary: Czarna lista
      operationId: listBlacklist
      description: 'Aktywne wpisy czarnej listy konta (bez wygasłych), posortowane po numerze. Paginacja kursorem: `next_cursor` to ostatni numer strony. Wymaga zakresu `read`.'
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 100
      - name: cursor
        in: query
        schema:
          type: string
        description: Wartość `next_cursor` z poprzedniej strony (numer)
      responses:
        '200':
          description: Strona wyników
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlacklistEntry'
                  next_cursor:
                    type:
                    - string
                    - 'null'
              example:
                data:
                - msisdn: '+48600100200'
                  reason: opt_out
                  created_at: '2026-09-07T10:02:11.000Z'
                  expires_at: null
                - msisdn: '+48600100201'
                  reason: reklamacja
                  created_at: '2026-09-07T10:05:40.000Z'
                  expires_at: '2026-12-31T23:00:00.000Z'
                next_cursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Czarna lista
      summary: Dodaj numery do czarnej listy
      operationId: addToBlacklist
      description: Blokuje jeden numer (`msisdn`) lub wiele (`msisdns`, do 1000). Istniejący wpis jest nadpisywany (nowy powód i data wygaśnięcia). Nieprawidłowe numery wracają w `invalid` i nie przerywają żądania. Wysyłka na zablokowany numer dostaje status `rejected` bez opłaty. Wymaga zakresu `manage`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                msisdn:
                  type: string
                  description: Jeden numer (alternatywnie `msisdns`)
                  example: '+48600100200'
                msisdns:
                  type: array
                  items:
                    type: string
                  maxItems: 1000
                  description: Lista numerów
                reason:
                  type: string
                  maxLength: 120
                  description: Powód (domyślnie `manual`; link opt-out zapisuje `opt_out`)
                  example: reklamacja
                expires_at:
                  type:
                  - string
                  - 'null'
                  format: date-time
                  description: Koniec blokady (ISO 8601, w przyszłości); brak = bezterminowo
            examples:
              jeden:
                summary: Jeden numer bezterminowo
                value:
                  msisdn: '+48600100200'
                  reason: reklamacja
              wiele:
                summary: Lista numerów z datą wygaśnięcia
                value:
                  msisdns:
                  - '+48600100200'
                  - '+48600100201'
                  reason: kampania Q4
                  expires_at: '2026-12-31T23:00:00Z'
      responses:
        '201':
          description: Dodano
          content:
            application/json:
              schema:
                type: object
                properties:
                  added:
                    type: integer
                    description: Liczba unikalnych, poprawnych numerów
                  invalid:
                    type: array
                    items:
                      type: string
                    description: Odrzucone wartości
                  expires_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
              example:
                added: 2
                invalid: []
                expires_at: '2026-12-31T23:00:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: curl
        source: "curl -X POST https://api.przypominamy.com/v1/blacklist \\\n  -H \"Authorization: Bearer $PRZYPOMINAMY_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"msisdns\": [\"+48600100200\"], \"reason\": \"reklamacja\"}'"
    servers:
    - url: https://api.przypominamy.com
      description: Produkcja
  /v1/blacklist/{msisdn}:
    delete:
      tags:
      - Czarna lista
      summary: Usuń numer z czarnej listy
      operationId: removeFromBlacklist
      description: Odblokowuje numer. Jeśli odbiorca sam się wypisał linkiem opt-out, ponowne wysyłki marketingowe wymagają jego nowej zgody. Wymaga zakresu `manage`.
      parameters:
      - name: msisdn
        in: path
        required: true
        schema:
          type: string
        description: Numer w E.164 (plus zakoduj jako `%2B` albo pomiń)
        example: '+48600100200'
      responses:
        '200':
          description: Usunięto
          content:
            application/json:
              example:
                removed: '+48600100200'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Numeru nie ma na czarnej liście
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.przypominamy.com
      description: Produkcja
  /o/{token}:
    get:
      tags:
      - Czarna lista
      summary: Strona wypisu (link opt-out)
      operationId: optOutPage
      security: []
      description: Publiczna strona HTML, na którą prowadzi link z placeholdera `{{opt_out}}` w treści SMS. Token jest losowy i nie zawiera numeru. Wejście dopisuje numer odbiorcy do czarnej listy konta nadawcy (powód `opt_out`, bezterminowo) i pokazuje potwierdzenie z zamaskowanym numerem i nazwą nadawcy; kolejne wejścia są idempotentne. Nieznany token = strona „Link nieaktywny” (404). Nie wywołuj tego adresu z własnego kodu.
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
        example: k3Jd9sQz1a
      responses:
        '200':
          description: Wypisano - strona HTML z potwierdzeniem
          content:
            text/html:
              schema:
                type: string
        '404':
          description: Link nieprawidłowy lub wygasły - strona HTML
          content:
            text/html:
              schema:
                type: string
    servers:
    - url: https://api.przypominamy.com
      description: Produkcja
components:
  responses:
    BadRequest:
      description: Błąd walidacji
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: 'Nieprawidłowy numer odbiorcy: +48XXXXXXXXX'
              param: to
            request_id: req_…
    Unauthorized:
      description: Brak lub nieprawidłowy klucz API
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: Nieprawidłowy klucz API
            request_id: req_…
    Forbidden:
      description: Klucz bez wymaganego zakresu (albo konto zawieszone / testowe wysyła na niezweryfikowany numer)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: forbidden
              message: Ten klucz API nie ma zakresu "send". Wygeneruj klucz z odpowiednim zakresem w panelu (app.przypominamy.com/keys).
            request_id: req_…
  schemas:
    BlacklistEntry:
      type: object
      properties:
        msisdn:
          type: string
          example: '+48600100200'
        reason:
          type:
          - string
          - 'null'
          description: '`opt_out` (link wypisu), `manual` (domyślne przy dodaniu przez API) lub własny opis'
          example: opt_out
        created_at:
          type: string
          format: date-time
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Koniec blokady; `null` = bezterminowo
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - unauthorized
              - forbidden
              - not_found
              - invalid_request
              - insufficient_funds
              - rate_limited
              - idempotency_conflict
              - provider_error
              - internal_error
            message:
              type: string
            param:
              type: string
              description: Pole żądania, którego dotyczy błąd (jeśli dotyczy)
        request_id:
          type: string
          example: req_DbIaEbKi5pbRgjCV
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: pk_live_…
      description: 'Klucz API z panelu app.przypominamy.com/keys (`pk_live_…` lub `pk_test_…`). Klucz ma zakresy: `send` (wysyłka i anulowanie), `read` (odczyt historii, raportów, konta, nadpisów, czarnej listy, kontaktów i grup, odpowiedzi 2-way i śledzonych linków), `manage` (ustawienia konta, webhook, zapis czarnej listy, kontaktów i grup). Brak zakresu = HTTP 403 `forbidden`. Klucze sprzed wprowadzenia zakresów mają wszystkie trzy.'
x-refined-from:
- openapi.json
- przypominamy-com-openapi.json