SCC API – lista kampanii

Ważne

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

Sprawa stanowi powiązanie między kontaktem a kampanią (dlatego będą Ci potrzebne dane o kampaniach). Zawiera informacje związane z obsługą pojedynczego zgłoszenia.

Kampania, określa ogólną tematykę zbioru spraw – to jest na przykład Biuro Obsługi Klienta, czyli wsparcie klienta zgłaszającego się z problemem lub Pozyskiwanie leadów, czyli próba nawiązania nowych relacji handlowych.

Pobieranie listy kampanii

Jeśli chcesz dodać sprawę i nie znasz identyfikatora kampanii, do której ma należeć – pobierz listę kampanii skonfigurowanych w Twoim SCC i wybierz odpowiednią.

Aby pobrać wykaz kampanii wywołaj (dane przykładowe):

GET
IntegrationApi/Campaign/All

{
    "totalCount": 9,
    "campaigns":[
        {
            "id": "AF4627DD-D398-40D3-97E0-AF97C147073A"
            "name": "BOK / Helpdesk"
            "description": ""
        },
        {
            "id": "CAF0AB2F-992A-4E9A-88BE-DF08EDE33989",
            "name": "Ankieta satysfakcji"
            "description": "Ankieta satysfakcji klientów firmy, zawiera 7 pytań, czas trwania: 10 minut."
        },
        { 
            "id": "49DBAF46-6FEA-4744-AF34-E2D444DE42A1", 
            "name": "Lejek sprzedaży"
            "description": ""
        },
        {
            "id": "782B443D-42AF-4223-B661-CB95A26D0843",
            "name": "Pozyskanie leadów"
            "description": ""
        },
        { 
            "id": "A2EC22E5-9DAF-4C0C-8F53-ECDA668842ED", 
            "name": "Pozyskanie leadów (fotowoltaika)"
            "description": ""
        },
        {
            "id": "80D5975E-3FC0-46B2-BA73-77DBE45F2BA6",
            "name": "BDC"
            "description": ""
        },
        { 
            "id": "4FAEFE80-BF3D-486C-9885-01729186C086", 
            "name": "Wynajem pojazdów"
            "description": ""
        },
        {
            "id": "4A2F25A8-19B5-4DF8-A6BD-4C0657D5813F",
            "name": "Autoresponder"
            "description": ""
        },
        { 
            "id": "04189F43-D13A-4E29-8DBF-193318185754", 
            "name": "Spam"
            "description": ""
        }
    ]
}

Gdzie, w otrzymanym rezultacie:

• total count – liczba wszystkich kampanii w systemie;
• id – to identyfikator kampanii;
• name – jest nazwą kampanii widoczną w SCC;
• description –  to wartość opcjonalna, opis widoczny tylko na liście skonfigurowanych kampanii.

Ważne

Pamiętaj, że tą metodą pobierasz pełną listę kampanii. Będą na niej też kampanie zakończone i nieaktywne.

Sprawa dodana do nieaktywnej kampanii nie trafi do kolejki obsługiwanej przez konsultantów.

Dostępne są dodatkowe parametry:

• active (true/false) – użyj aby na liście znalazły się tylko aktywne kampanie;
• pagination.skip (wartość liczbowa) – pomiń X pierwszych pozycji;
• pagination.take (wartość liczbowa) – pokaż X pozycji z wszystkich.

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

 

Dodawanie kontaktów do systemu

Dodawanie nowych kontaktów bez weryfikacji powtórzeń.

Pobieranie listy statusów kampanii

Potrzebne do zmiany statusu w sprawie lub wyszukiwania spraw na określonym etapie obsługi.