Dokumentacja API TopMessage | Odzyskaj wiadomości i zweryfikuj kody

Pobierz wiadomość

Pobieraj szczegóły wiadomości przychodzących i wychodzących oraz weryfikuj kody uwierzytelniające wysyłane do klientów. Uzyskaj dostęp do listy wszystkich wiadomości lub znajdź informacje o konkretnej wiadomości, korzystając z unikalnego identyfikatora wiadomości podanego podczas jej tworzenia lub odbierania.

Przykłady przypadków użycia

Weryfikacja użytkownika przebiegła pomyślnie, jeśli nagłówek X-Total-Count ma wartość 1 lub lista obiektów danych w odpowiedzi nie jest pusta.

Poniżej przedstawiono kilka przykładów przypadków użycia interfejsu API TopMessage:

Uzyskaj szczegółowe informacje o wszystkich wysłanych wiadomościach, aby monitorować dostarczanie, śledzić wydajność i optymalizować swoją strategię komunikacji.

Pełne parametry żądania

Żadne parametry żądania nie są wymagane.

Pełne parametry odpowiedzi

Odpowiedź zawiera wszystkie parametry z żądania wraz z dodatkowymi parametrami wymienionymi poniżej.

Nazwa	Uprzejmy	Opis
data	`object`	Zawiera informacje o wiadomości.

Data Object

Nazwa	Uprzejmy	Opis
id	`string`	Unikalny identyfikator Twojej wiadomości.
account_id	`string`	Unikalny identyfikator Twojego konta.
status	`string`	Początkowy status Twojej wiadomości. Możliwe wartości: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
from	`string`	Nazwa wyświetlana, z której zostanie wysłana Twoja wiadomość. Sprawdź dostępne nazwy lub utwórz nową na stronie nadawców.
to	`string[]`	Numer telefonu komórkowego odbiorcy w formacie międzynarodowym.
text	`string[]`	Twoja wiadomość tekstowa, która zostanie wysłana do odbiorców.
channel	`string`	Kanał komunikacyjny przesyła Twoją wiadomość. Możliwe wartości: `SMS` I `WHATSAPP` Domyślny: `SMS`
segment_count	`integer`	Liczba segmentów, z których składała się Twoja wiadomość.
encoding	`string`	Kodowanie Twojej wiadomości. Możliwe wartości: `STANDARD` I `UNICODE`
direction	`string`	Określa przepływ wiadomości – czy została wysłana przez Twój system, czy odebrana od użytkownika. Możliwe wartości: `OUTBOUND`, `INBOUND`
country	`string`	Określa kraj odbiorcy dla wiadomości wychodzących oraz kraj nadawcy dla wiadomości przychodzących. Wartość jest podana w formacie ISO 3166-1 alpha-2.
type	`string`	Określa typ treści wiadomości, która jest wysyłana lub odbierana. Pomaga to zidentyfikować, czy wiadomość to zwykły tekst, szablon czy media (np. obrazy lub filmy), w tym treści interaktywne dla WhatsApp.
schedule	`string`	Określa czas, kiedy wiadomość ma zostać wysłana. Czas musi być w UTC i musi być zgodny z formatem ISO-8601 ("2024-12-01T18:00:00Z"). Czas zaplanowany nie może być ustawiony na więcej niż 1 rok w przyszłość. Domyślny: Teraz
create_date	`string`	Godzina zainicjowania wiadomości
update_date	`string`	Data ostatniej aktualizacji statusu Twojej wiadomości.

GET

https://api.topmessage.pl/v1/messages

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Próbka odpowiedzi

'X-Total-Count': 1

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "48511512345",
            "text": "Cześć! Testuję tę fajną funkcję SMS. https://topmessage.pl",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "PL",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        },
        {
            "id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "48511512346",
            "text": "Szybki test tej funkcji SMS.",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "PL",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}