Contacts API - lv

Izmantojot šo API, varat skatīt, atrast, pievienot, rediģēt, apvienot un dzēst kontaktpersonas projektā.

Kvīts.

Ļauj iegūt projekta kontaktpersonu sarakstu.

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

Galvenie parametri:

Vārds	Apraksts	Validācija

Vārds	Apraksts	Validācija
page	Pieprasītā lapa	Minimālā vērtība 1
limitation	Lapā parādāmo datu apjoms	Minimālā vērtība 1, maksimālā 20

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

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

Atbildes apraksts:

Vārds	Apraksts

Vārds	Apraksts
cursor	Cursor objekts
collection	Contact objektu masīvs

Meklēt.

Ļauj atrast atbilstības kontaktpersonām, izmantojot atslēgvārdu.

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

Vārds	Apraksts	Validācija

Vārds	Apraksts	Validācija
page	Pieprasītā lapa	Minimālā vērtība 1
limitation	Lapā parādāmo datu apjoms	Minimālā vērtība 1, maksimālā 20
term	Meklēt atslēgvārdu	nav tukšs

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

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

Atbildes apraksts:

Vārds	Apraksts

Vārds	Apraksts
cursor	Cursor objekts
collection	Contact objektu masīvs

Meklēt pēc ID.

Informācijas iegūšana par kontaktpersonu pēc ID.

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

Veiksmīgas atbildes gadījumā iegūstiet tipa objektu Contact

Meklēt pēc ID (vienkārša).

Informācijas iegūšana par kontaktpersonu pēc ID.

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

Veiksmīgas atbildes gadījumā iegūstiet tipa objektu Contact

Izmantojot šo metodi, mainīgie tiks nodoti kā atslēgas vērtība bez detalizētas informācijas par pašiem mainīgajiem.

Meklēt tērzēšanu pēc ID.

Kontaktpersonas tērzēšanas iegūšana pēc ID.

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

Veiksmīgas atbildes gadījumā iegūstiet tipa objektu Contact

Meklēt pieejamos sakarus pēc ID.

Saņemiet pieejamo saziņu sarakstu kontaktpersonai pēc ID.

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

Galvenie parametri:

Vārds	Apraksts	Validācija

Vārds	Apraksts	Validācija
page	Pieprasītā lapa	Minimālā vērtība 1
limitation	Lapā parādāmo datu apjoms	Minimālā vērtība 1, maksimālā 20

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

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

Atbildes apraksts:

Vārds	Apraksts

Vārds	Apraksts
cursor	Cursor objekts
collection	Gate objektu masīvs

Atjaunināt.

Atjaunina atlasītā klienta datus.

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

Pamatparametri: pieprasījuma pamattekstā norādiet visus atjauninājumam nepieciešamos parametrus. Tas var būt gan mainīgie, gan sistēmas lauki.

Galvenie parametri:

Vārds	Tips	Apraksts

Vārds	Tips	Apraksts
values	Objekts (atslēgas vērtība)	Visi nepieciešamie parametri atjaunināšanai pieprasījuma pamattekstā. Tas var būt gan mainīgie, gan sistēmas lauki.

Svarīgs! Ja lauka atjauninājumam ir norādīta nederīga vērtība, lauks tiks izlaists un tiks apstrādāts pārējais atjauninājums.

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{
    "state": true
}

Pasākuma uzsākšana.

Aktivizē kontaktpersonai atlasīto notikumu.

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

Galvenie parametri:

Vārds	Apraksts

Vārds	Apraksts
name	Pasākuma nosaukums, reģistrjutīgs

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{
    "state": true
}

Apvienošanās.

Savieno vienu klientu ar otru. Visi tagi, piltuves un mainīgie tiks sinhronizēti par labu {contactId}, un visas trūkstošās vērtības tiks ņemtas no {targetContactId}.

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

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{
    "state": true
}

(DEPRECATED) Noņemšana.

Ļauj dzēst atlasīto kontaktu.

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

Veiksmīgas atbildes gadījumā saņemsiet sekojošo:

{
    "state": true
}