Selle API abil saate projektis kontakte vaadata, leida, lisada, redigeerida, liita ja kustutada.
Kviitung.
Võimaldab hankida projektis osalevate kontaktide loendit.
| Code Block |
|---|
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:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Contact[]
}
|
Vastuse kirjeldus:
Otsing.
Võimaldab märksõna abil leida vasteid kontaktidele.
| Code Block |
|---|
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:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Contact[]
}
|
Vastuse kirjeldus:
Otsi ID järgi.
Kontakti kohta teabe hankimine ID abil.
| Code Block |
|---|
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.
| Code Block |
|---|
GET https://api.smartsender.com/v1/contacts/{contactId}/info |
Eduka vastuse korral hankige tüüpi objekt Võtke ühendust .
| Info |
|---|
Selle meetodi puhul edastatakse muutujad võtmeväärtusena, ilma muutujate endi kohta üksikasjaliku teabeta. |
Otsige vestlust ID järgi.
Kontakti vestluse saamine ID abil.
| Code Block |
|---|
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.
| Code Block |
|---|
GET https://api.smartsender.com/v1/contacts/{contactId}/gates |
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:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Gate[]
}
|
Vastuse kirjeldus:
Värskenda.
Värskendab valitud kliendi andmeid.
| Code Block |
|---|
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 |
|---|---|---|
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:
| Code Block |
|---|
{
"state": true
}
|
Запуск события.
Запускает выбранное событие для контакта.
| Code Block |
|---|
POST https://api.smartsender.com/v1/contacts/{contactId}/fire |
Peamised parameetrid:
Nimi | Kirjeldus |
|---|---|
name | Sündmuse nimi, tõstutundlik |
Eduka vastuse korral saate järgmise teabe:
| Code Block |
|---|
{
"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}.
| Code Block |
|---|
POST https://api.smartsender.com/v1/contacts/{contactId}/unite/{targetContactId} |
Eduka vastuse korral saate järgmise teabe:
| Code Block |
|---|
{
"state": true
}
|
(AEGUNUD) Kustutamine.
Võimaldab valitud kontakti kustutada.
| Code Block |
|---|
DELETE https://api.smartsender.com/v1/contacts/{contactId} |
Eduka vastuse korral saate järgmise teabe:
| Code Block |
|---|
{
"state": true
} |