Centrum wiadomości
Centrum wiadomości to miejsce komunikowania się kupujących i sprzedających. To połączenie czata i poczty elektronicznej, w którym znajdziesz korespondencję prowadzoną w ramach Allegro, jak i wiadomości od kupujących.
Więcej informacji na temat Centrum wiadomości znajdziesz w Pomocy Allegro.
Lista wątków na koncie
Za pomocą GET /messaging/threads, jako zalogowany sprzedawca, pobierzesz wszystkie wątki (czyli całą korespondencję z kupującymi) na danym koncie. Domyślnie w odpowiedzi otrzymasz 20 wątków.
Aby zawęzić listę wyszukiwania, możesz skorzystać z parametrów:
limit - by określić liczbę wiadomości na liście (min. 1, max. 20),
offset - by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych (min. 0).
Np. GET /messaging/threads?limit=4&offset=5
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/messaging/threads' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'
{
"threads": [
{
"id": "4lN1A6WTKM8AcfP1bLiumXuJ14Es1fiCguyqRvj3qDf", - identyfikator wątku
"read": false, - informacja, czy wątek został odczytany
"lastMessageDateTime": "2021-07-13T19:53:05.051Z", - data ostatniej wiadomości
"interlocutor": { - dane rozmówcy
"login": "client:44300444", - login
"avatarUrl": - adres URL avataru użytkownika
"https://a.allegroimg.allegro.pl/ovwcolormcolorgreen300/1dbab0/8e6f13624ac8a4fd24764646cd48"
}
},
{
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf",
"read": false,
"lastMessageDateTime": "2021-07-13T19:49:48.899Z",
"interlocutor": {
"login": "allegrofan",
"avatarUrl": "https://a.allegroimg.allegro.pl/ovwcolormcolorteal300/1dbab0/8e6f13624ac8a4fd24764646cd48"
}
}
],
"offset": 0,
"limit": 20
}
Szczegółowe informacje o danym wątku
Za pomocą GET /messaging/threads/{threadId}, jako zalogowany sprzedawca, pobierzesz szczegółowe informacje o danym wątku.
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/messaging/threads/dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'
{
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf", - identyfikator wątku
"read": false, - informacja, czy wątek został odczytany
"lastMessageDateTime": "2021-07-13T19:49:48.899Z", - data ostatniej wiadomości
"interlocutor": { - dane rozmówcy
"login": "allegrofan", - login
"avatarUrl": - adres URL avataru użytkownika
"https://a.allegroimg.allegro.pl/ovwcolormcolorteal300/1dbab0/8e6f13624ac8a4fd24764646cd48"
}
}
Lista wiadomości dla wybranego wątku
Za pomocą GET /messaging/threads/{threadId}/messages, jako zalogowany sprzedawca, pobierzesz listę wiadomości dla wybranego wątku. Domyślnie w odpowiedzi otrzymasz 20 wiadomości.
Aby zawęzić listę wyszukiwania, możesz skorzystać z parametrów:
limit - by określić liczbę wiadomości na liście (min. 1, max. 20),
offset - by wskazać miejsce, od którego chcesz pobrać kolejną porcję danych (min. 0).
Np. GET /messaging/threads/{threadId}/messages?limit=4&offset=5
before - by wskazać wiadomości utworzone przed wskazaną datą,
after - by wskazać wiadomości utworzone po wskazanej dacie.
Np. GET /messaging/threads/{threadId}/messages/?before=2021-07-14T08:00:00.000Z
Identyfikator wątku (threadId) uzyskasz poprzez GET /messaging/threads w polu “threads.id”.
{
"messages": [
{
"id": "3793aee2-7fd5-48b0-9de1-cfc804fbf002", - identyfikator wiadomości
"status": "DELIVERED", - status wiadomości
"type": "MESSAGE_CENTER", - rodzaj wiadomości
"createdAt": "2021-07-13T19:49:48.899Z", - data wiadomości
"thread": {
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf" - identyfikator wątku
},
"author": { - autor wiadomości
"login": "allegro", - login
"isInterlocutor": true - informacja, czy autor jest rozmówcą
},
"text": "Jaki jest rok wydania?", - treść wiadomości
"subject": null, - tytuł wiadomości
"relatesTo": { - powiązanie wiadomości
"offer": {
"id": "7680560734" - numer oferty
},
"order": null - identyfikator zamówienia
},
"hasAdditionalAttachments": false, - czy wiadomość posiada dodatkowe załączniki
"attachments": [], - załączniki
"additionalInformation": {
"vin": "WVGZZZ5NZ8W031284" - opcjonalne, numer VIN pojazdu (tylko dla ofert
części samochodowych lub motocyklowych)
}
},
{
"id": "12fe4125-fca9-400a-8363-1739e86fe787",
"status": "DELIVERED",
"type": "MESSAGE_CENTER",
"createdAt": "2021-07-13T19:37:52.571Z",
"thread": {
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf"
},
"author": {
"id": "43544040",
"isInterlocutor": true
},
"text": "Czy telefon jest nowy?",
"subject": null,
"relatesTo": {
"offer": {
"id": "7680560740"
},
"order": null
},
"hasAdditionalAttachments": false,
"attachments": []
}
],
"offset": 0,
"limit": 20
}
Szczegółowe informacje o wiadomości
Za pomocą GET /messaging/messages/{messageId}, jako zalogowany sprzedawca, pobierzesz szczegółowe informacje o wiadomości.
Identyfikator wiadomości (messageId) uzyskasz za pomocą GET /messaging/threads/{threadId}/messages w polu “messages.id”.
{
"id": "3793aee2-7fd5-48b0-9de1-cfc804fbf002", - identyfikator wiadomości
"status": "DELIVERED", - status wiadomości
"type": "MESSAGE_CENTER", - rodzaj wiadomości
"createdAt": "2021-07-13T19:49:48.899Z", - data wiadomości
"thread": {
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf" - identyfikator wątku
},
"author": { - autor wiadomości
"login": "allegro", - login
"isInterlocutor": true - informacja, czy autor jest rozmówcą
},
"text": "Jaki jest rok wydania?", - treść wiadomości
"subject": null, - tytuł wiadomości
"relatesTo": { - powiązanie wiadomości
"offer": {
"id": "7680560734" - numer oferty
},
"order": null - identyfikator zamówienia
},
"hasAdditionalAttachments": false, - czy wiadomość posiada dodatkowe załączniki
"attachments": [], - załączniki
"additionalInformation": {
"vin": "WVGZZZ5NZ8W031284" - opcjonalne, numer VIN pojazdu (tylko dla ofert
części samochodowych lub motocyklowych)
}
Dodatkowo za pomocą PUT /messaging/threads/{threadId}/read oznaczysz wybrany wątek jako odczytany (“read”: true). Jeżeli pojawi się kolejna wiadomość w wątku, to zmienimy wartość pola na “read”: false.
Identyfikator wątku (threadId) uzyskasz poprzez GET /messaging/threads w polu “threads.id”.
Przykładowy request:
curl -X PUT \
'https://api.allegro.pl/messaging/threads/dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf/read' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"read": true
}'
{
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf", - identyfikator wątku
"read": true, - informacja, czy wątek został odczytany
"lastMessageDateTime": "2021-07-13T19:49:48.899Z", - data ostatniej wiadomości
"interlocutor": { - dane rozmówcy
"login": "allegrofan", - login
"avatarUrl": - adres URL avataru użytkownika
"https://a.allegroimg.allegro.pl/ovwcolormcolorteal300/1dbab0/8e6f13624ac8a4fd24764646cd48"
}
}
Nowa wiadomość
Możesz utworzyć nową wiadomość i wysłać ją:
- do wybranego użytkownika - w tym celu skorzystaj z POST /messaging/messages.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/messaging/messages' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"recipient": {
"login": "allegrofan"
},
"order": {
"id": "5e2a4f40-a5a6-11ef-9992-73b2635ee427"
}
"text": "Proszę o kontakt",
"attachments": []
}'
{
"id": "b58e920b-4d1d-46d1-815a-702311a784c3", - identyfikator wiadomości
"status": "VERIFYING", - status wiadomości
"type": "MESSAGE_CENTER", - rodzaj wiadomości
"createdAt": "2021-07-13T21:15:26.700Z", - data wiadomości
"thread": {
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf" - identyfikator wątku
},
"author": { - autor wiadomości
"id": "44190193", - identyfikator użytkownika
"isInterlocutor": false - informacja, czy autor jest rozmówcą
},
"text": "Proszę o kontakt", - treść wiadomości
"subject": null, - tytuł wiadomości
"relatesTo": { - powiązanie wiadomości
"offer": null, - numer oferty
"order": {
"id": "5e2a4f40-a5a6-11ef-9992-73b2635ee427", - identyfikator zamówienia
},
"hasAdditionalAttachments": false, - czy wiadomość posiada dodatkowe załączniki
"attachments": [] - załączniki
}
- w wybranym wątku - w tym celu skorzystaj z POST /messaging/threads/{threadId}/messages.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl /messaging/threads/dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf/messages' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"text": "Hello",
"attachments": []
}'
{
"id": "669a15f6-4f14-4a65-958f-268d628f796f", - identyfikator wiadomości
"status": "VERIFYING", - status wiadomości
"type": "MESSAGE_CENTER", - rodzaj wiadomości
"createdAt": "2021-07-14T05:03:54.598Z", - data wiadomości
"thread": {
"id": "dpYCg9auts9xpSojwC6DWPvyVKHraqDCZCiT70j6pcf" - identyfikator wątku
},
"author": { - autor wiadomości
"id": "44190193", - identyfikator użytkownika
"isInterlocutor": false - informacja, czy autor jest rozmówcą
},
"text": "Hello", - tekst wiadomości
"subject": null, - tytuł wiadomości
"relatesTo": { - powiązanie wiadomości
"offer": null, - numer oferty
"order": null - identyfikator zamówienia
},
"hasAdditionalAttachments": false, - czy wiadomość posiada dodatkowe załączniki
"attachments": [] - załączniki
}
Usunięcie wiadomości
Za pomocą DELETE /messaging/messages/{messageId} usuniesz wybraną wiadomość. Pamiętaj jednak, że wiadomość nadal będzie widoczna dla odbiorcy.
Przykładowy request:
curl -X DELETE \
'https://api.allegro.pl/messaging/meesages/3793aee2-7fd5-48b0-9de1-cfc804fbf002' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'
Przykładowy response:
status 204 No Content
Załączniki
W naszym API udostępniamy trzy zasoby odpowiedzialne za zarządzanie załącznikami w Centrum wiadomości:
- GET /messaging/message-attachments/{attachmentId} - pobierz załącznik np. dodany przez kupującego,
- POST /messaging/message-attachments - dodaj deklarację własnego załącznika,
- PUT /messaging/message-attachments/{attachmentId} - dodaj własny załącznik.
Pobranie załącznika
Za pomocą GET /messaging/message-attachments/{attachmentId} pobierzesz załącznik z Centrum wiadomości.
Wartość “attachmentId” znajdziesz w polu “attachment.url”, gdy skorzystasz z jednego z wymienionych zasobów:
Przykładowy request:
curl -X GET \
'https://api.allegro.pl/messaging/message-attachments/97dc0b60-2da4-4247-92ba-b748630ba0f6' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: */*'
Deklaracja załącznika
Za pomocą POST /messaging/message-attachments prześlesz deklarację załącznika, czyli zdefiniujesz jego rozmiar (w bajtach) i nazwę. W odpowiedzi otrzymasz “attachmentId”, czyli id załącznika.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/messaging/message-attachments' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: application/vnd.allegro.public.v1+json' \
-d '{
"filename": "image.png", - nazwa pliku
"size": 21876 - rozmiar pliku
}'
Przykładowy response:
{
"id": "97dc0b60-2da4-4247-92ba-b748630ba0f6" - identyfikator załącznika
}
Dodanie załącznika
Skorzystaj z PUT /messaging/message-attachments/{attachmentId}, aby przesłać załącznik na nasze serwery. W wywołaniu podaj id załącznika {attachmentId}. Otrzymasz go za pomocą POST /messaging/message-attachments. Jako content-type podaj rodzaj pliku, jaki chcesz dodać:
image/png,
image/gif,
image/bmp,
image/tiff,
image/jpeg,
application/pdf.
Przykładowy request:
curl -X PUT \
'https://api.allegro.pl/messaging/message-attachments/97dc0b60-2da4-4247-92ba-b748630ba0f6' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json' \
-H 'Content-Type: image/png'
Przykładowy response:
{
"id": "97dc0b60-2da4-4247-92ba-b748630ba0f6"
}
Lista zasobów
Pełną dokumentację zasobów w postaci pliku swagger.yaml znajdziesz tu.
Lista zasobów podstawowych opisanych w poradniku:
GET /messaging/threads - pobierz listę wszystkich wątków
GET /messaging/threads/{threadId} - pobierz szczegółowe informacje o danym wątku
PUT /messaging/threads/{threadId}/read - oznacz wybrany wątek jako przeczytany
POST /messaging/messages - napisz nową wiadomość
GET /messaging/threads/{threadId}/messages - pobierz listę wiadomości dla wybranego wątku
POST /messaging/threads/{threadId}/messages - napisz nową wiadomość w wybranym wątku
GET /messaging/messages/{messageId} - pobierz szczegółowe informacje o danej wiadomości
DELETE /messaging/messages/{messageId} - usuń wybraną wiadomość
POST /messaging/message-attachments - dodaj deklarację załącznika
PUT /messaging/message-attachments/{attachmentId} - dodaj załącznik
GET /messaging/message-attachments/{attachmentId} - pobierz załącznik