Kontaktide API
- Anastasiia
- Smart Sender
Selle API abil saate projektis kontakte vaadata, leida, lisada, redigeerida, liita ja kustutada.
Kviitung.
Võimaldab hankida projektis osalevate kontaktide loendit.
GET https://api.smartsender.com/v1/contacts
Peamised parameetrid:
Nimi | Kirjeldus | Kinnitamine |
|---|---|---|
page | Taotletud leht | Minimaalne väärtus 1 |
limitation | Ühel lehel kuvatavate andmete hulk | Minimaalne väärtus 1, maksimaalne 20 |
Eduka vastuse korral saate järgmise teabe:
{
"cursor": Cursor,
"collection": Contact[]
}
Vastuse kirjeldus:
Otsing.
Võimaldab märksõna abil leida vasteid kontaktidele.
GET https://api.smartsender.com/v1/contacts/search
Peamised parameetrid:
Nimi | Kirjeldus | Kinnitamine |
|---|---|---|
page | Taotletud leht | Minimaalne väärtus 1 |
limitation | Ühel lehel kuvatavate andmete hulk | Minimaalne väärtus 1, maksimaalne 20 |
term | Otsi märksõna | mitte tühi |
Eduka vastuse korral saate järgmise teabe:
Vastuse kirjeldus:
Otsi ID järgi.
Kontakti kohta teabe hankimine ID abil.
Eduka vastuse korral hankige tüüpi objekt Võtke ühendust .
Otsi ID järgi (lihtne).
Kontakti kohta teabe hankimine ID abil.
Eduka vastuse korral hankige tüüpi objekt Võtke ühendust .
Selle meetodi puhul edastatakse muutujad võtmeväärtusena, ilma muutujate endi kohta üksikasjaliku teabeta.
Otsige vestlust ID järgi.
Kontakti vestluse saamine ID abil.
Eduka vastuse korral hankige tüüpi objekt Vestlus.
Otsige saadaolevaid sideid ID järgi.
Hankige ID-ga kontakti jaoks saadaolevate suhtluste loend.
Peamised parameetrid:
Nimi | Kirjeldus | Kinnitamine |
|---|---|---|
page | Taotletud leht | Minimaalne väärtus 1 |
limitation | Ühel lehel kuvatavate andmete hulk | Minimaalne väärtus 1, maksimaalne 20 |
Eduka vastuse korral saate järgmise teabe:
Vastuse kirjeldus:
Värskenda.
Värskendab valitud kliendi andmeid.
Põhiparameetrid: määrake kõik värskenduse nõutavad parameetrid päringu kehas. Need võivad olla nii muutujad kui ka süsteemiväljad.
Peamised parameetrid:
Nimi | Tüüp | Kirjeldus |
|---|---|---|
values | Objekt (võtmeväärtus) | Kõik värskendamiseks vajalikud parameetrid päringu põhiosas. Need võivad olla nii muutujad kui ka süsteemiväljad. |
Tähtis! Kui välja värskenduse jaoks on määratud kehtetu väärtus, jäetakse väli vahele ja ülejäänud värskendus töödeldakse.
Eduka vastuse korral saate järgmise teabe:
Tulekahju sündmus.
Käivitab kontakti jaoks valitud sündmuse.
Peamised parameetrid:
Nimi | Kirjeldus |
|---|---|
name | Sündmuse nimi, tõstutundlik |
Eduka vastuse korral saate järgmise teabe:
liit.
Ühendab ühe kliendi teisega. Kõik sildid, lehtrid ja muutujad sünkroonitakse {contactId} kasuks ja kõik puuduvad väärtused võetakse saidilt {targetContactId}.
Eduka vastuse korral saate järgmise teabe:
(AEGUNUD) Kustutamine.
Võimaldab valitud kontakti kustutada.
Eduka vastuse korral saate järgmise teabe: