Messages API - FI
- Anastasiia
Tämän API:n avulla voit vastaanottaa / lähettää viestin yhteyshenkilölle ja vastaanottaa myös koko kirjeenvaihdon valitun yhteyshenkilön kanssa.
Lähetetään.
Voit lähettää viestin yhteyshenkilölle (mahdollisuudella valita kanava).
POST https://api.smartsender.com/v1/contacts/{contactId}/send
URL-parametrit:
Nimi | Kuvaus |
|---|---|
contactId | Yhteyshenkilötunnus |
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
type | Viestin tyyppi | Saatavilla olevat tyypit
|
watermark | Viestin prioriteetin aikaleima (oletus, käytä nykyistä aikaleimaa) | Timestamp |
media | Liitteen URL-osoite | Pakollinen, jos mediaviesti. Jos tyyppi ei vastaa tiedostomuotoa, se lähetetään "asiakirjana" |
title | paikan nimi | Pakollinen, jos tyyppi location |
latitude | Leveys | Pakollinen, jos tyyppi location |
longitude | Pituusaste | Pakollinen, jos tyyppi location |
content | Teksti | Pakollinen, jos tyyppi text |
fullName | Koko nimi | Pakollinen, jos tyyppi contact |
phoneNumber | Puhelinnumero | Pakollinen, jos tyyppi contact |
Jos vastaus on onnistunut, hanki objekti, jonka tyyppi on Message.
Kuitti (yhteyshenkilön kautta).
Voit vastaanottaa viestin yhteyshenkilön kautta.
GET https://api.smartsender.com/v1/contacts/{contactId}/messages
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
page | Pyydetty sivu | Vähimmäisarvo 1 |
limitation | Näytettävien tietojen määrä sivua kohden | Pienin arvo 1, maksimi 20 |
Jos vastaus on onnistunut, saat seuraavat tiedot:
{
"cursor": Cursor,
"collection": Message[]
}
Vastauksen kuvaus:
Vastaanottaminen (chatin kautta).
Mahdollistaa viestin vastaanottamisen chatin kautta.
Pääparametrit:
Nimi | Kuvaus | Validointi |
|---|---|---|
page | Pyydetty sivu | Vähimmäisarvo 1 |
limitation | Näytettävien tietojen määrä sivua kohden | Pienin arvo 1, maksimi 20 |
Jos vastaus on onnistunut, saat seuraavat tiedot:
Vastauksen kuvaus: