Session Link

API dla deweloperów

Pobierz ze swoich systemów bezpośredni link do rozmowy z klientem; klient i rozmowa są tworzone, jeśli jeszcze nie istnieją.

• WhatsApp
• Instagram
• REST API

Zainstaluj z MonoStoreZobacz na monochat.ai

Przegląd

Jedno wywołanie API z kanałem oraz numerem telefonu lub adresem e-mail klienta zwraca link otwierający rozmowę z tym klientem w MonoChat. Jeśli klient lub rozmowa jeszcze nie istnieją, zostają utworzone.

Umieść link w swoim CRM, systemie helpdesk lub na ekranie zamówienia, a zespół przejdzie stamtąd prosto do czatu.

Najważniejsze cechy

• Otwórz lub utwórz. Działa dla klienta w danym kanale WhatsApp, Instagram lub innym, według numeru telefonu lub adresu e-mail.
• Kieruj po drodze. Przypisz rozmowę do konsultanta, według identyfikatora lub adresu e-mail, albo do grupy roboczej w tym samym wywołaniu.
• Ten sam klient, ta sama rozmowa. Ponowne wywołanie dla tego samego klienta i kanału zwraca istniejącą rozmowę.

Instalacja i konfiguracja

1. Zainstaluj Session Link w Ustawienia › MonoStore › Aplikacje lub otwórz link instalacyjny app.monochat.ai/apps/vvKJe8Nbp4EQNy2KA. Jeśli nie masz konta MonoChat, link pozwoli Ci najpierw się zarejestrować i zainstaluje aplikację za Ciebie.
2. Utwórz token API w Profil › Tokeny API. Token jest wyświetlany tylko raz, więc skopiuj go od razu. Zobacz Tokeny API.
3. Otwórz Ustawienia › Session Link API. Dokumentacja w tym miejscu pokazuje dokładny adres endpointu Twojej przestrzeni roboczej i gotowe do skopiowania przykładowe żądania. Wypróbuj przykład z jednym ze swoich kanałów.
4. Dodaj do swojego CRM, systemu helpdesk lub ekranu zamówienia przycisk „Czatuj na WhatsAppie”, który wywołuje API i otwiera zwrócony url.

notatka

• Link otwiera MonoChat osobom, które są zalogowane i mają uprawnienia do tej rozmowy.
• Wywołanie jedynie otwiera rozmowę; nie wysyła klientowi wiadomości. Aby napisać jako pierwszy, użyj WhatsApp Template API.

Funkcje

Link do rozmowy

Odpowiedź zawiera link otwierający rozmowę w MonoChat oraz identyfikator rozmowy.

Klient tworzony w razie potrzeby

Nowy klient jest tworzony z podanym przez Ciebie imieniem i nazwiskiem; odpowiedź informuje, czy klient był już znany.

Przypisanie

Przypisz do konsultanta według identyfikatora lub adresu e-mail albo do grupy roboczej.

Ekran dokumentacji

Dokumentacja API z dokładnym adresem endpointu Twojej przestrzeni roboczej i gotowymi do skopiowania przykładowymi żądaniami.

Dokumentacja API

Wywołanie to POST z treścią JSON, uwierzytelniane tokenem API.

POST https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js
Authorization: Bearer <API_TOKEN>
Content-Type: application/json

• <slug> to slug organizacji Twojej przestrzeni roboczej, czyli część po /tenants/ w Twoim adresie MonoChat.
• <app-folder> to folder, w którym zainstalowano aplikację. Ekran Ustawienia › Session Link API pokazuje pełny adres z oboma wartościami wstawionymi.
• Token utwórz w Profil › Tokeny API. Zobacz Tokeny API.

Pola żądania

Pole	Wymagane	Opis
connectorBrand	tak	Typ kanału, na przykład whatsapp lub instagram.
channelUsername	tak	Nazwa użytkownika Twojego kanału w MonoChat, na przykład Twój numer WhatsApp bez +.
customer.identityType	tak	phoneNumber lub email.
customer.identity	tak	Numer telefonu klienta (z numerem kierunkowym kraju, bez +) lub adres e-mail.
customer.firstname, customer.lastname	nie	Używane, gdy klient jest nowy w MonoChat. Domyślnie -.
assignment.type	nie	agent (identyfikator użytkownika-konsultanta), agentIdentity (adres e-mail konsultanta) lub workgroup (identyfikator grupy roboczej).
assignment.value	z assignment.type	Identyfikator lub adres e-mail, do którego ma zostać przypisana rozmowa.

Przykładowe żądanie

curl --location 'https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
  "connectorBrand": "whatsapp",
  "channelUsername": "905334445566",
  "customer": {
    "identityType": "phoneNumber",
    "identity": "905306667788",
    "firstname": "Ayşe",
    "lastname": "Yılmaz"
  },
  "assignment": { "type": "agentIdentity", "value": "sarah@yourcompany.com" }
}'

Odpowiedź

{
  "result": {
    "url": "https://app.monochat.ai/tenants/<slug>?tab=messages&sessionTab=all&filter=…&_id=<sessionId>",
    "sessionId": "Zeii7vpeeFFnsJepZ",
    "isOldUser": true
  }
}

Pole	Opis
url	Otwiera rozmowę w MonoChat.
sessionId	Identyfikator rozmowy. Ten sam klient w tym samym kanale zawsze otrzymuje tę samą rozmowę.
isOldUser	false, gdy klient został utworzony przez to wywołanie.

Błędy

Nieudane wywołanie zwraca status błędu i komunikat:

Komunikat	Przyczyna
connectorBrand, channelUsername and customer fields are required	Brakuje wymaganego pola najwyższego poziomu.
customer.identityType must be one of: phoneNumber, email	Brakuje identityType lub ma on inną wartość.
customer.identity field is required	Brakuje numeru telefonu lub adresu e-mail klienta.
Channel not found	W Twojej przestrzeni roboczej nie ma kanału tego typu z taką nazwą użytkownika.
Customer Channel not found	Nie udało się dopasować klienta do tożsamości kanału.
Agent user not found	Brak konsultanta z adresem e-mail podanym w assignment.value.
401	Brakuje nagłówka Authorization lub token jest nieprawidłowy.

Zrzuty ekranu

CRM, helpdesk i ekran zarządzania zamówieniami, z których każdy otwiera właściwą rozmowę w MonoChatPrzypisanie rozmowy do konsultanta lub grupy roboczej w tym samym wywołaniu APINowy klient i nowa rozmowa tworzone automatycznie na podstawie żądania APIJedno wywołanie API zwraca link do rozmowyPrzycisk „Czatuj na WhatsAppie” w CRM otwiera rozmowę z klientem jednym kliknięciemPonowne wywołanie API dla tego samego klienta otwiera istniejącą rozmowę

FAQ

Czy Session Link wysyła wiadomość do klienta?

Nie. Tylko otwiera lub tworzy rozmowę i zwraca link do niej. Aby napisać do klienta jako pierwszy, użyj aplikacji WhatsApp Template API.

Z jakimi kanałami działa?

WhatsApp, Instagram i pozostałe kanały połączone z Twoją przestrzenią roboczą MonoChat. W żądaniu podajesz typ kanału i nazwę użytkownika swojego kanału.

Czy tworzy zduplikowane rozmowy?

Nie. Ten sam klient w tym samym kanale zawsze otrzymuje tę samą rozmowę.

Kto może otworzyć link?

Osoby zalogowane w MonoChat, które mają uprawnienia do tej rozmowy.

Powiązane

• WhatsApp Template API
• Aplikacje MonoStore
• Ustawienia profilu
• Zespoły robocze