Kontaktide API

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

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:

Nimi	Kirjeldus

Nimi	Kirjeldus
cursor	Tippige objekt Kursor
collection	Tüüpobjektide massiiv Värav

Otsing.

Võimaldab märksõna abil leida vasteid kontaktidele.

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

Peamised parameetrid:

Nimi	Kirjeldus	Kinnitamine

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:

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

Vastuse kirjeldus:

Nimi	Kirjeldus

Nimi	Kirjeldus
cursor	Tippige objekt Kursor
collection	Tüüpobjektide massiiv Värav

Otsi ID järgi.

Kontakti kohta teabe hankimine ID abil.

GET https://api.smartsender.com/v1/contacts/{contactId}

Eduka vastuse korral hankige tüüpi objekt Võtke ühendust .

Otsi ID järgi (lihtne).

Kontakti kohta teabe hankimine ID abil.

GET https://api.smartsender.com/v1/contacts/{contactId}/info

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.

GET https://api.smartsender.com/v1/contacts/{contactId}/chat

Eduka vastuse korral hankige tüüpi objekt Vestlus.

Otsige saadaolevaid sideid ID järgi.

Hankige ID-ga kontakti jaoks saadaolevate suhtluste loend.

GET https://api.smartsender.com/v1/contacts/{contactId}/gates

Peamised parameetrid:

Nimi	Kirjeldus	Kinnitamine

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": Gate[]
}

Vastuse kirjeldus:

Nimi	Kirjeldus

Nimi	Kirjeldus
cursor	Tippige objekt Kursor
collection	Tüüpobjektide massiiv Värav

Värskenda.

Värskendab valitud kliendi andmeid.

PUT https://api.smartsender.com/v1/contacts/{contactId}

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

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:

{
    "state": true
}

Tulekahju sündmus.

Käivitab kontakti jaoks valitud sündmuse.

POST https://api.smartsender.com/v1/contacts/{contactId}/fire

Peamised parameetrid:

Nimi	Kirjeldus

Nimi	Kirjeldus
name	Sündmuse nimi, tõstutundlik

Eduka vastuse korral saate järgmise teabe:

{
    "state": true
}

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}.

POST https://api.smartsender.com/v1/contacts/{contactId}/unite/{targetContactId}

Eduka vastuse korral saate järgmise teabe:

{
    "state": true
}

(AEGUNUD) Kustutamine.

Võimaldab valitud kontakti kustutada.

DELETE https://api.smartsender.com/v1/contacts/{contactId}

Eduka vastuse korral saate järgmise teabe:

{
    "state": true
}