SCC API – dodawanie kontaktów

Ważne

Chcąc uzyskać dostęp do API integracyjnego, konieczne jest posiadanie tokena autoryzacyjnego.

Pojedynczy kontakt w systemie, to zbiór danych dotyczących osoby lub przedsiębiorstwa, takich jak nazwisko lub nazwa, kontaktowy numer telefonu czy adres email.

Dodanie kontaktu

Jedną z podstawowych możliwości wykorzystania API integracyjnego jest dodawanie kontaktów do systemu Systell Contact Center.

Pomocne

Aby dodać kontakt do systemu, poza tokenem, będziesz potrzebować:

• definicji pól danych kontaktu. Możesz pobrać je z systemu za pośrednictwem API (instrukcja w punkcie 2.).

Gdy masz już gotową listę informacji o kontaktach, które chcesz wprowadzić do systemu, wykorzystaj je do skonstruowania wywołania dodania kontaktu tak, że:

• key z wyniku pobierania listy pól kontaktu – użyj jako nazwy pola;
• przypisz jej odpowiednią wartość dla wybranego kontaktu.

Na przykład:

jeśli na pobranej liście pól kontaktu znajduje się:

   "key": "FirstName",
   "value": "Imię"

to przy tworzeniu wpisu dla kontaktu o imieniu Jan, będzie to:

    "firstName": "Jan"

Aby dodać kontakt wywołaj (dane przykładowe):

POST
IntegrationApi/Record

{
    "name": "Nazwa",
    "firstName": "Jan",
    "lastName": "Testowski",
    "city": "Poznań",
    "region": "TEST6",
    "postCode": "60-600",
    "phoneNumber1": "123456789",
    "phoneNumber2": "987654321",
    "email": "jan.testowski@systell.eu",
    "recordItems": [
        {
            "name": "PoleTest",
            "value": "Dodatkowe pole na dane kontaktu"
        }
    ]
}
}

W rezultacie otrzymasz status 201 created oraz identyfikator nowo dodanego kontaktu.

Dobre praktyki

Uzyskany identyfikator dobrze jest zapisać w swoim systemie. Ułatwi to późniejsze aktualizacje kontaktu i na przykład dodanie go do kampanii.

Mając token i dane kontaktów możesz wykonywać przez API inne operacje na danych, na przykład:

 

Dodawanie spraw do systemu

Tworze spraw wymaga znajomości danych kampanii i kontaktów.

Wyszukiwanie kontaktów w systemie

Identyfikatory kontaktów są potrzebne między innymi do tworzenia spraw.