API

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

Pobierz listę wiadomości
Pobierz konkretną wiadomość
Zweryfikuj kod

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.

Pełne parametry żądania

Żadne parametry żądania nie są wymagane.

Pełne parametry odpowiedzi

Parametry odpowiedzi

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

Nazwa	Uprzejmy	Opis
data	`object`	Zawiera poniższe szczegóły wysyłanej wiadomości.

Obiekt danych

Nazwa	Uprzejmy	Opis
account_id	`string`	Unikalny identyfikator Twojego konta.
id	`string`	Unikalny identyfikator Twojej wiadomości.
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.Przejdź do strony nadawców.
to	`string[]`	Numer telefonu komórkowego odbiorcy w formacie międzynarodowym.
status	`string`	Początkowy status Twojej wiadomości. Możliwe wartości: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	Kanał komunikacyjny przesyła Twoją wiadomość. Możliwe wartości: `SMS` I `WHATSAPP` Domyślny: `SMS`
text	`string`	Twoja wiadomość tekstowa, która zostanie wysłana do odbiorców.
template_id	`string`	Unikalny identyfikator Twojego wysłanego szablonu. Możesz sprawdzić dostępne szablony lub utworzyć nowy na stronie szablonów w swoim koncie.Przejdź do strony szablonów.
parameters	`string[]`	Wartości te służą do zastąpienia symboli zastępczych w szablonie wiadomości, co pozwala dostosować wiadomość dla każdego odbiorcy. Domyślny: Pusty
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`
country	`string`	Kraj docelowy odbiorcy wiadomości.
direction	`string`	Określa, czy wiadomość jest odbierana przez system, czy wysyłana z systemu do odbiorcy. Możliwe wartości: `OUTBOUND`, `INBOUND`
type	`string`	Określa strukturę zawartości wiadomości. Możliwe wartości: `TEXT`, `TEMPLATE`
create_date	`string`	Godzina zainicjowania wiadomości
update_date	`string`	Data ostatniej aktualizacji statusu Twojej wiadomości.
code	`string`	Kod podany przez użytkownika, 4-6 cyfr
expired	`boolean`	Wskazuje, czy kod wygasł. Możliwe wartości: `TRUE`, `FALSE` Domyślny: `FALSE`

Pobierz listę wiadomości

GET

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

Pobierz konkretną wiadomość

GET

https://api.topmessage.pl/v1/messages/{Id}

Zweryfikuj kod

GET

https://api.topmessage.pl/v1/messages?to={receipnet_number}&code={code}&expired=false

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

Próbka odpowiedzi

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}