przypominamy-com Szablony API

openapi: 3.2.0
info:
  title: Przypominamy Com Szablony 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 Szablony 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: Szablony
  description: Szablony SMS/MMS/głosowe z placeholderami {{klucz}} - te same co w panelu
paths:
  /v1/templates:
    get:
      tags:
      - Szablony
      summary: Lista szablonów
      operationId: listTemplates
      description: Szablony konta (te same, które widać w panelu), posortowane po nazwie, z listą placeholderów `{{klucz}}` znalezionych w treści. Wymaga zakresu `read`.
      responses:
        '200':
          description: Lista szablonów
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Template'
              example:
                data:
                - id: tpl_Q3m7kL2pXa9dRt
                  name: Wizyta
                  type: sms
                  body: Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.
                  subject: null
                  placeholders:
                  - imie
                  - kiedy
                  - lekarz
                  created_at: '2026-09-07T07:11:04.000Z'
                  updated_at: '2026-09-07T07:11:04.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-codeSamples:
      - lang: curl
        source: "curl https://api.przypominamy.com/v1/templates \\\n  -H \"Authorization: Bearer $PRZYPOMINAMY_API_KEY\""
    post:
      tags:
      - Szablony
      summary: Utwórz szablon
      operationId: createTemplate
      description: 'Zapisuje szablon z placeholderami `{{klucz}}` (klucz: litery, cyfry, podkreślenie). `type` domyślnie `sms`; dla `mms` w `body` podaj dokument SMIL, a temat w `subject`; `vms` to szablon wiadomości głosowej. Wymaga zakresu `manage`.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateInput'
            example:
              name: Wizyta
              body: Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.
      responses:
        '201':
          description: Utworzono
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
              example:
                id: tpl_Q3m7kL2pXa9dRt
                name: Wizyta
                type: sms
                body: Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.
                subject: null
                placeholders:
                - imie
                - kiedy
                - lekarz
                created_at: '2026-09-07T07:11:04.000Z'
                updated_at: '2026-09-07T07:11:04.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/templates \\\n  -H \"Authorization: Bearer $PRZYPOMINAMY_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"name\": \"Wizyta\", \"body\": \"Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.\"}'"
      - lang: Python
        source: "import requests\n\nr = requests.post(\n    \"https://api.przypominamy.com/v1/templates\",\n    headers={\"Authorization\": f\"Bearer {API_KEY}\"},\n    json={\"name\": \"Wizyta\", \"body\": \"Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.\"},\n    timeout=15,\n)\ntpl = r.json()\n\n# wysyłka z szablonu\nrequests.post(\n    \"https://api.przypominamy.com/v1/messages\",\n    headers={\"Authorization\": f\"Bearer {API_KEY}\"},\n    json={\"to\": \"+48600100200\", \"template_id\": tpl[\"id\"], \"params\": {\"imie\": \"Anno\", \"kiedy\": \"jutro 10:00\", \"lekarz\": \"dr Nowak\"}},\n    timeout=15,\n)"
    servers:
    - url: https://api.przypominamy.com
      description: Produkcja
  /v1/templates/{id}:
    get:
      tags:
      - Szablony
      summary: Pobierz szablon
      operationId: getTemplate
      description: Wymaga zakresu `read`.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: tpl_Q3m7kL2pXa9dRt
      responses:
        '200':
          description: Szablon
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Szablony
      summary: Zmień szablon
      operationId: updateTemplate
      description: Częściowa aktualizacja - podajesz tylko zmieniane pola (`name`, `type`, `body`, `subject`). Wymaga zakresu `manage`.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: tpl_Q3m7kL2pXa9dRt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 60
                type:
                  type: string
                  enum:
                  - sms
                  - mms
                  - vms
                body:
                  type: string
                  maxLength: 5000
                subject:
                  type:
                  - string
                  - 'null'
                  maxLength: 80
            example:
              name: Wizyta 2
      responses:
        '200':
          description: Zmieniono
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Szablony
      summary: Usuń szablon
      operationId: deleteTemplate
      description: Usuwa szablon; wysłane wcześniej wiadomości zostają. Wymaga zakresu `manage`.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: tpl_Q3m7kL2pXa9dRt
      responses:
        '200':
          description: Usunięto
          content:
            application/json:
              example:
                deleted: tpl_Q3m7kL2pXa9dRt
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://api.przypominamy.com
      description: Produkcja
components:
  responses:
    NotFound:
      description: Nie znaleziono
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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:
    Template:
      type: object
      properties:
        id:
          type: string
          example: tpl_Q3m7kL2pXa9dRt
        name:
          type: string
          maxLength: 60
          example: Wizyta
        type:
          type: string
          enum:
          - sms
          - mms
          - vms
          description: Kanał, do którego pasuje szablon - musi zgadzać się z endpointem wysyłki
        body:
          type: string
          maxLength: 5000
          description: Treść z placeholderami `{{klucz}}` (dla MMS - dokument SMIL)
          example: Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.
        subject:
          type:
          - string
          - 'null'
          maxLength: 80
          description: Temat (tylko MMS)
        placeholders:
          type: array
          items:
            type: string
          description: Placeholdery znalezione w `body`, małymi literami
          example:
          - imie
          - kiedy
          - lekarz
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    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
    TemplateInput:
      type: object
      required:
      - name
      - body
      properties:
        name:
          type: string
          maxLength: 60
          example: Wizyta
        type:
          type: string
          enum:
          - sms
          - mms
          - vms
          default: sms
          description: Domyślnie `sms`
        body:
          type: string
          maxLength: 5000
          description: Treść z placeholderami `{{klucz}}`
          example: Cześć {{imie}}, wizyta {{kiedy}} u {{lekarz}}.
        subject:
          type:
          - string
          - 'null'
          maxLength: 80
          description: Temat (tylko MMS)
  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