Contacts API - FI
- Anastasiia
Tämän API:n avulla voit tarkastella, etsiä, lisätä, muokata, yhdistää ja poistaa yhteystietoja projektissa.
Kuitti.
Voit saada luettelon projektin yhteyshenkilöistä.
GET https://api.smartsender.com/v1/contacts
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": Contact[]
}
Vastauksen kuvaus:
Hae.
Voit etsiä yhteystietoja avainsanan avulla.
GET https://api.smartsender.com/v1/contacts/search
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 |
term | Hakumerkkijono | ei tyhjä |
Jos vastaus on onnistunut, saat seuraavat tiedot:
Vastauksen kuvaus:
Hae tunnuksella.
Yhteystietojen saaminen tunnuksella.
Jos vastaus on onnistunut, hanki tyyppinen objekti Contact
Hae tunnuksella (yksinkertainen).
Yhteystietojen saaminen tunnuksella.
Jos vastaus on onnistunut, hanki tyyppinen objekti Contact
Tässä menetelmässä muuttujat välitetään avainarvoina ilman tarkkoja tietoja itse muuttujista.
Hae chatista tunnuksella.
Yhteyshenkilön chatin saaminen tunnuksella.
Jos vastaus on onnistunut, hanki tyyppinen objekti Chat.
Hae käytettävissä olevia viestejä tunnuksella.
Hanki luettelo yhteyshenkilön käytettävissä olevista yhteydenotoista tunnuksella.
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:
Päivittää.
Päivittää valitun asiakkaan tiedot.
Perusparametrit: Määritä kaikki päivityksen vaadittavat parametrit pyynnön tekstiosassa. Se voi olla sekä muuttujia että järjestelmäkenttiä.
Pääparametrit:
Nimi | Tyyppi | Kuvaus |
|---|---|---|
values | Objekti (avainarvo) | Kaikki tarvittavat parametrit päivittämistä varten pyynnön rungossa. Se voi olla sekä muuttujia että järjestelmäkenttiä. |
Tärkeä! Jos kentän päivitykselle on määritetty virheellinen arvo, kenttä ohitetaan ja päivityksen loppuosa käsitellään.
Jos vastaus on onnistunut, saat seuraavat tiedot:
Tapahtuman käynnistäminen.
Käynnistää valitun tapahtuman kontaktille.
Pääparametrit:
Nimi | Kuvaus |
|---|---|
name | Tapahtuman nimi, isot ja pienet kirjaimet |
Jos vastaus on onnistunut, saat seuraavat tiedot:
Liitto.
Yhdistää yhden asiakkaan toiseen. Kaikki tunnisteet, kanavat ja muuttujat synkronoidaan {contactId}:n hyväksi, ja kaikki puuttuvat arvot otetaan kohteesta {targetContactId}.
Jos vastaus on onnistunut, saat seuraavat tiedot:
(POISTETTU) Poisto.
Voit poistaa valitun yhteystiedon.
Jos vastaus on onnistunut, saat seuraavat tiedot: