Contacts API - lt

Naudodami šią API galite peržiūrėti, rasti, pridėti, redaguoti, sujungti ir ištrinti kontaktus projekte.

Kvitas.

Leidžia gauti projekto kontaktų sąrašą.

GET https://api.smartsender.com/v1/contacts

Pagrindiniai parametrai:

vardas	apibūdinimas	Patvirtinimas

vardas	apibūdinimas	Patvirtinimas
page	Pageidaujamas puslapis	Mažiausia vertė 1
limitation	Viename puslapyje rodomų duomenų kiekis	Mažiausia vertė 1, didžiausia 20

Sėkmingo atsakymo atveju gausite:

{
    "cursor": Cursor,
    "collection": Contact[]
}

Atsakymo aprašymas:

vardas	apibūdinimas

vardas	apibūdinimas
cursor	Cursor objektas
collection	objektų masyvas Contact

Paieška.

Leidžia rasti kontaktų atitikmenis naudojant raktinį žodį.

GET https://api.smartsender.com/v1/contacts/search

Pagrindiniai parametrai:

vardas	apibūdinimas	Patvirtinimas

vardas	apibūdinimas	Patvirtinimas
page	Pageidaujamas puslapis	Mažiausia vertė 1
limitation	Viename puslapyje rodomų duomenų kiekis	Mažiausia vertė 1, didžiausia 20
term	Paieškos raktažodis	ne tuščias

Sėkmingo atsakymo atveju gausite:

Atsakymo aprašymas:

vardas	apibūdinimas

vardas	apibūdinimas
cursor	Cursor objektas
collection	objektų masyvas Contact

Ieškoti pagal ID.

Informacijos apie kontaktą gavimas pagal ID.

Sėkmingo atsakymo atveju gaukite tipo objektą Contact

Ieškoti pagal ID (paprasta).

Informacijos apie kontaktą gavimas pagal ID.

Sėkmingo atsakymo atveju gaukite tipo objektą Contact

Taikant šį metodą, kintamieji bus perduodami kaip pagrindinė reikšmė be išsamios informacijos apie pačius kintamuosius.

Ieškokite pokalbių pagal ID.

Kontakto pokalbio gavimas pagal ID.

Sėkmingo atsakymo atveju gaukite tipo objektą Chat

Ieškokite galimų ryšių pagal ID.

Gaukite galimų kontaktų pagal ID sąrašą.

Pagrindiniai parametrai:

vardas	apibūdinimas	Patvirtinimas

vardas	apibūdinimas	Patvirtinimas
page	Pageidaujamas puslapis	Mažiausia vertė 1
limitation	Viename puslapyje rodomų duomenų kiekis	Mažiausia vertė 1, didžiausia 20

Sėkmingo atsakymo atveju gausite:

Atsakymo aprašymas:

vardas	apibūdinimas

vardas	apibūdinimas
cursor	Cursor objektas
collection	objektų masyvas Gate

Atnaujinti.

Atnaujina pasirinkto kliento duomenis.

Pagrindiniai parametrai: užklausos turinyje nurodykite visus būtinus atnaujinimo parametrus. Tai gali būti ir kintamieji, ir sistemos laukai.

Pagrindiniai parametrai:

vardas	Tipas	apibūdinimas

vardas	Tipas	apibūdinimas
values	Objektas (rakto vertė)	Visi būtini parametrai atnaujinti užklausos tekste. Tai gali būti ir kintamieji, ir sistemos laukai.

Svarbu! Jei lauko naujinimui nurodyta neteisinga reikšmė, laukas bus praleistas, o likusi naujinimo dalis bus apdorota.

Sėkmingo atsakymo atveju gausite:

Renginio pradžia.

Suaktyvina pasirinktą kontakto įvykį.

Pagrindiniai parametrai:

vardas	apibūdinimas

vardas	apibūdinimas
name	Renginio pavadinimas, skiriamos didžiosios ir mažosios raidės

Sėkmingo atsakymo atveju gausite:

Suvienijimas.

Sujungia vieną klientą su kitu. Visos žymos, kanalai ir kintamieji bus sinchronizuojami {contactId} naudai, o visos trūkstamos reikšmės bus paimtos iš {targetContactId}.

Sėkmingo atsakymo atveju gausite:

(DEPRECATED) Pašalinimas.

Leidžia ištrinti pasirinktą kontaktą.

Sėkmingo atsakymo atveju gausite: