Session Link

API pentru dezvoltatori

Obțineți din propriile sisteme un link direct către conversația unui client; clientul și conversația sunt create dacă nu există încă.

• WhatsApp
• Instagram
• REST API

Instalați din MonoStoreVedeți-o pe monochat.ai

Prezentare generală

Un singur apel API cu un canal și numărul de telefon sau e-mailul unui client returnează un link care deschide conversația clientului în MonoChat. Dacă clientul sau conversația nu există încă, sunt create.

Puneți linkul în CRM, în help desk sau pe ecranul comenzii, iar echipa dvs. sare direct de acolo în chat.

Puncte forte

• Deschidere sau creare. Funcționează pentru un client de pe un anumit canal WhatsApp, Instagram sau altul, după numărul de telefon sau e-mail.
• Rutare pe parcurs. Atribuiți conversația unui agent, după id sau e-mail, sau unui grup de lucru, în același apel.
• Același client, aceeași conversație. Apelarea din nou pentru același client și același canal returnează conversația existentă.

Instalare și configurare

1. Instalați Session Link din Setări › MonoStore › Aplicații sau deschideți linkul de instalare app.monochat.ai/apps/vvKJe8Nbp4EQNy2KA. Dacă nu aveți un cont MonoChat, linkul vă permite să vă înregistrați mai întâi și instalează aplicația pentru dvs.
2. Creați un token API în Profil › Token-uri API. Token-ul este afișat o singură dată, așa că copiați-l imediat. Consultați Token-uri API.
3. Deschideți Setări › Session Link API. Documentația de acolo arată adresa exactă a endpoint-ului spațiului dvs. de lucru și exemple de cereri gata de copiat. Încercați exemplul cu unul dintre canalele dvs.
4. Adăugați un buton „Chat pe WhatsApp” în CRM, în help desk sau pe ecranul comenzii, care apelează API-ul și deschide url-ul returnat.

notă

• Linkul deschide MonoChat pentru persoanele autentificate și care au voie să vadă conversația respectivă.
• Apelul doar deschide conversația; nu trimite clientului niciun mesaj. Folosiți WhatsApp Template API pentru a scrie primul.

Funcționalități

Link către conversație

Răspunsul conține linkul care deschide conversația în MonoChat și id-ul conversației.

Client creat dacă e nevoie

Un client nou este creat cu prenumele și numele pe care le trimiteți; răspunsul spune dacă clientul era deja cunoscut.

Atribuire

Atribuiți unui agent după id sau e-mail, sau unui grup de lucru.

Ecranul de documentație

Referința API cu adresa exactă a endpoint-urilor spațiului dvs. de lucru și exemple de cereri gata de copiat.

Referință API

Apelul este un POST cu corp JSON, autentificat cu un token 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> este tenant slug-ul spațiului dvs. de lucru, partea de după /tenants/ din adresa dvs. MonoChat.
• <app-folder> este folderul în care a fost instalată aplicația. Ecranul Setări › Session Link API arată adresa completă, cu ambele valori completate.
• Creați token-ul în Profil › Token-uri API. Consultați Token-uri API.

Câmpurile cererii

Câmp	Obligatoriu	Descriere
connectorBrand	da	Tipul canalului, de exemplu whatsapp sau instagram.
channelUsername	da	Numele de utilizator al canalului dvs. în MonoChat, de exemplu numărul dvs. WhatsApp fără +.
customer.identityType	da	phoneNumber sau email.
customer.identity	da	Numărul de telefon al clientului (prefix de țară, fără +) sau adresa de e-mail.
customer.firstname, customer.lastname	nu	Folosite când clientul este nou în MonoChat. Implicit -.
assignment.type	nu	agent (id-ul utilizatorului agent), agentIdentity (e-mailul agentului) sau workgroup (id-ul grupului de lucru).
assignment.value	cu assignment.type	Id-ul sau e-mailul căruia i se atribuie conversația.

Exemplu de cerere

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" }
}'

Răspuns

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

Câmp	Descriere
url	Deschide conversația în MonoChat.
sessionId	Id-ul conversației. Același client de pe același canal primește mereu aceeași conversație.
isOldUser	false când clientul a fost creat de acest apel.

Erori

Un apel eșuat răspunde cu un cod de eroare și un mesaj:

Mesaj	Cauză
connectorBrand, channelUsername and customer fields are required	Lipsește un câmp obligatoriu de nivel superior.
customer.identityType must be one of: phoneNumber, email	identityType lipsește sau are altă valoare.
customer.identity field is required	Lipsește numărul de telefon sau e-mailul clientului.
Channel not found	Nu există în spațiul dvs. de lucru niciun canal de acel tip cu acel nume de utilizator.
Customer Channel not found	Clientul nu a putut fi asociat cu o identitate de canal.
Agent user not found	Nu există niciun agent cu e-mailul indicat în assignment.value.
401	Antetul Authorization lipsește sau token-ul este invalid.

Capturi de ecran

Un CRM, un help desk și un ecran de gestionare a comenzilor, fiecare deschizând conversația potrivită în MonoChatAtribuirea conversației unui agent sau unui grup de lucru în același apel APIUn client nou și o conversație nouă create automat din cererea APIUn singur apel API returnează linkul conversațieiUn buton „Chat pe WhatsApp” într-un CRM deschide conversația clientului cu un clicApelarea din nou a API-ului pentru același client deschide conversația existentă

Întrebări frecvente

Trimite Session Link un mesaj clientului?

Nu. Doar deschide sau creează conversația și returnează un link către ea. Pentru a scrie primul clientului, folosiți aplicația WhatsApp Template API.

Cu ce canale funcționează?

WhatsApp, Instagram și celelalte canale conectate la spațiul dvs. de lucru MonoChat. În cerere indicați tipul canalului și numele de utilizator al canalului dvs.

Va crea conversații duplicate?

Nu. Același client de pe același canal primește mereu aceeași conversație.

Cine poate deschide linkul?

Persoanele autentificate în MonoChat și care au voie să vadă conversația respectivă.

Articole conexe

• WhatsApp Template API
• Aplicații MonoStore
• Setări profil
• Grupuri de lucru