Wiadomości

Pobierz wiadomość

get/v1/messages/{id}

Request

  • Base URL: https://api.przypominamy.com
  • URL: https://api.przypominamy.com/v1/messages/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Wiadomość wraz ze śledzonymi linkami (links[], pusta tablica, gdy w treści nie było {{link:…}})

idstring
type'sms' | 'mms' | 'vms'

Kanał: SMS, MMS, wiadomość głosowa

status'scheduled' | 'queued' | 'sent' | 'delivered' | 'undelivered' | 'failed' | 'expired' | 'rejected' | 'cancelled' | 'unknown'

scheduled - zaplanowana (send_at lub przesunięta przez send_window); queued - przyjęta; sent - przekazana do sieci; delivered - doręczona; undelivered - niedoręczona; failed - odrzucona przez dostawcę; rejected - odrzucona przez nas (numer na czarnej liście, koszt 0); expired - wygasła (m.in. po expires_at); cancelled - zaplanowana wysyłka anulowana przez DELETE /v1/messages/{id}, koszt zwrócony; unknown - dostawca nie potwierdził (timeout / 5xx), saldo zarezerwowane do uzgodnienia po idx albo DLR

tostring
fromstring nullable
textstring

Treść po personalizacji - dokładnie to, co dostał odbiorca (link opt-out, śledzone linki api.przypominamy.com/l/… i placeholdery już podstawione)

subjectstring nullable

Temat (tylko MMS)

partsinteger
cost_groszeinteger

Koszt w groszach (0 dla odrzuconych; po anulowaniu zwrócony na saldo)

priorityboolean

Czy wysłano jako SMS priorytetowy (podwójna stawka)

referencestring nullable
send_atstring date-time nullable

Termin wysyłki (po przesunięciu przez send_window, jeśli było)

expires_atstring date-time nullable

Koniec prób doręczenia, gdy podano expires_at

delivered_atstring date-time nullable
errorstring nullable

Powód odrzucenia, gdy status = failed lub rejected (np. „Numer na czarnej liście (opt-out)”)

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "msg_qY08hZ2mmDXAazdRTytS",
  "to": "+48600100200",
  "from": "ZDROWKO",
  "parts": 1,
  "cost_grosze": 9,
  "links": [
    {
      "token": "k3Jd9sQz",
      "short_url": "https://api.przypominamy.com/l/k3Jd9sQz",
      "url": "https://firma.pl/wizyta?id=7",
      "message_id": "msg_qY08hZ2mmDXAazdRTytS",
      "to": "+48600100200",
      "clicks": 2
    }
  ]
}

Changes

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