Historia kontaktu

1. Pobranie listy połączeń za dany okres

Metoda pozwala na pobranie zdarzeń z historii kontaktu (połączeń, SMS, faksów) dla wskazanego w żądaniu okresu.

Metoda: GET
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/callHistory

Metoda stosuje stronicowanie powyżej 1000 rekordów. API zwróci zawsze maksymalnie 1000 rekordów, a o resztę należy zapytać dodając do adresu page={numer_strony}. Przykładowo, dla sytuacji gdzie jest więcej niż 1000 rekordów stosujemy:

{twoja_nazwa}.ccrm.pl/publicApi/callHistory?page=2

Dodatkowo, obowiązkowo należy podać zakres dat z jakich mają zostać zwrócone rekordy. Spację należy zakodować w formie %20. Przykładowo:

{twoja_nazwa}.ccrm.pl/publicApi/callHistory?dateFrom=2022-02-01%2008:00:00&dateTo=2023-01-27%2008:00:00

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.to

array

Rozmówca. Szerszy opis w pomocniczej tabeli callers.

data.from

array

Rozmówca. Szerszy opis w pomocniczej tabeli callers.

data.userTalk.status

string

Informacja, czy połączenie przeszło przez kolejkę czy nie lub czy było połączeniem wewnętrznym. Możliwe wartości: queue, noQueue, internal.

data.userTalk.receivers

array

Użytkownik CRM, który jest powiązany z połączeniem. Szerszy opis w pomocniczej tabeli user talk.

data.uuid

uuid

Wartość identyfikująca rekord.

data.callDirection

string

Kierunek połączenia Możliwe wartości in, out, internal.

data.callDate

datetime

Data i czas zdarzenia.

data.duration

int

Ilość sekund w których trwało połączenie.

data.destination

string

Kierunek.

data.cost

int

Koszt.

data.service

string

Rodzaj zdarzenia bilingowego. Możliwe wartości CALL, SMS, FAX.

data.smsData

string

Treść SMS.

data.note

int

Wartość oznaczająca czy do zdarzenia bilingowego zostały sporządzone notatki.

data.externalNumber.numberNotFormatted

string

Niesformatowany, zewnętrzny numer telefonu.

data.externalNumber.numberFormatted

string

Sformatowany, zewnętrzny numer telefonu.

data.externalNumber.type

string

Typ rozmówcy. Możliwe wartości unknown, person, organisation.

data.flags

array

Tagi przypisane do zdarzenia. Szerszy opis w pomocniczej tabeli flags.

data.status

string

Status rekordu. Możliwe wartości: answered, noAnswer, busy.

otherData.totalCount

int

Ilość rekordów.

message

string


Tabela pomocnicza: user talk

Właściwość

Wartość

Opis

internal

Int

Numer wewnętrzny.

uuid

uuid

Uuid użytkownika - jeśli znaleziono.

firstName

string

Imię użytkownika - jeśli znaleziono.

lastName

string

Nazwisko użytkownika - jeśli znaleziono.

Tabela pomocnicza: callers

Właściwość

Wartość

Opis

type

string

Typ rozmówcy. Możliwe wartości unknown, person, organisation.

uuid

uuid

Wartość identyfikująca rozmówcę - jeśli znaleziono.

firstName

string

Imię - jeśli znaleziono.

lastName

string

Nazwisko - jeśli znaleziono.

avatar

string

Nazwa pliku z avatarem - jeśli znaleziono.

name

string

Nazwa organizacji - jeśli znaleziono.

number

string

Numer telefonu.

numberNotFormatted

string

Niesformatowany numer telefonu.

Tabela pomocnicza: flags

Właściwość

Wartość

Opis

name

string

Nazwa flagi.

uuid

uuid

Wartość identyfikująca rekord.

color

string

Kolor flagi.

relUuid

uuid

Wartość identyfikująca relacje.

Przykład odpowiedzi
{
    "success":true,
    "data":[
        {
            "to":{
                "type":"unknown",
               "number":"+48 777 888 999",
                "numberNotFormatted":48777888999
            },
            "from":{
                "type":"unknown",
               "number":"+48 555 555 555",
                "numberNotFormatted":48555555555
            },
            "userTalk":{
                "status":"queue",
                "receivers":[
                    {
                        "internal":107,
                       "uuid":"fdf75d0c-fc9f-41dc-9a54-af2121db989b",
                        "firstName":"Jan",
                        "lastName":"Kowalski"
                    }
                ]
            },
            "uuid":"e4baaa94-095a-41b3-b638-203dcfcfd3fe",
            "callDirection":"IN",
            "callDate":"2022-12-29 11:24:57",
            "duration":368,
            "destination":"Połączenie Przychodzące",
            "cost":0,
           "service":"CALL",
           "smsData":null,
            "note":1,
            "externalNumber":{
                "numberNotFormatted":48333333333,
                "numberFormatted":"+48 333 333 333",
                "type":"unknown"
            },
            "flags": [
                {
                    "name": "Billing",
                    "uuid": "62bd7385-c4ba-46f5-94b5-2fae4ebc87d4",
                    "color": "#fa702e",
                    "reluuid": "9fb11e8a-099e-4ea8-8f17-fdf095f06637"
                }
            ],            
"status":"ANSWERED"
        }
    ],
    "otherData":{
        "totalCount":8437
    },
    "message":"OK"
}


2. Pobranie notatek powiązanych z danym zdarzeniem

Metoda pozwala na pobranie notatek powiązanych z danym zdarzeniem (połączeniem, SMSem, faksem).

Metoda: GET
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/notes

Dodatkowo, obowiązkowo należy podać wartość callHistory aby wyświetlić notatki właśnie z tego konkretnego zdarzenia z bilingu. Przykładowo:

{twoja_nazwa}.ccrm.pl/publicApi/notes?callHistory=337b7045-c171-4c8c-946b-ba123e91c369

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

string


data.text

string

Właściwy tekst notatki.

data.created

datetime

Data utworzenia notatki.

data.uuid

uuid

Unikalny identyfikator notatki.

data.user.firstName

string

Imię autora (użytkownika CRM) notatki.

data.user.lastName

string

Nazwisko autora (użytkownika CRM) notatki.

data.user.uuid

uuid

Unikalny identyfikator autora (użytkownika CRM) notatki.

data.status

string

Informacja czy notatka istnieje lub czy została usunięta.

data.call

object

Wskazuje powiązanie notatki ze zdarzeniem z historii kontaktu. Szerszy opis w pomocniczej tabeli note call.

organisation

object

Informacja czy notatka jest powiązana z profilem organizacji z kontaktów. Szerszy opis w pomocniczej tabeli note organisation.

person

object

Informacja czy notatka jest powiązana z profilem osoby z kontaktów. Szerszy opis w pomocniczej tabeli note person.

pin

int

Informacja czy notatka została przypięta.

files

array

Informacja o załączonych plikach. Szerszy opis w pomocniczej tabeli files.

edit

int

Informacja czy notatka była edytowana.

Tabela pomocnicza: note call

Właściwość

Wartość

Opis

uuid

uuid

Wartość identyfikująca rekord historii kontaktu.

callDate

datetime

Data i czas rekordu w historii kontaktu.

callDirection

string

Kierunek połączenia. Możliwe wartości in, out, internal.

service

string

Rodzaj zdarzenia bilingowego. Możliwe wartości call, sms, fax.

externalNumber.numberNotFormatted

string

Niesformatowany, zewnętrzny numer telefonu.

externalNumber.numberFormatted

string

Sformatowany, zewnętrzny numer telefonu.

Tabela pomocnicza: note files

Właściwość

Wartość

Opis

uuid

uuid

Wartość identyfikująca plik.

uploadedAt

datetime

Data i czas wysłania pliku.

relatedTo

string

Powiązanie pliku, domyślnie „note”.

mimeType

string

Format pliku.

fileExtension

string

Rozszerzenie pliku.

fileSize

int

Rozmiar pliku.

fileDescription

string

Opis pliku.

fileName

string

Nazwa pliku.

Tabela pomocnicza: note peson

Właściwość

Wartość

Opis

uuid

uuid

Wartość identyfikująca kontakt.

firstName

string

Imię.

lastName

string

Nazwisko.

Tabela pomocnicza: note organisation

Właściwość

Wartość

Opis

uuid

uuid

Wartość identyfikująca organizację.

name

string

Nazwa organizacji.

Przykład odpowiedzi
{
    "success":true,
    "data":[
        {
            "text":"{"blocks":[{"key":"be2bp","text":"Notatka do tego połączenia","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}",
            "created":"2022-12-29 12:13:35",
            "uuid":"1fa7bda9-e853-43d6-9b3c-c194ad59cefd",
            "user":{
                "firstName":"Jan",
                "lastName":"Kowalski",
                "uuid":"a26b956b-ce46-48f4-a1bd-b657136d4148"
            },
            "status":"exist",
            "call":{
                "uuid":"e4baaa94-095a-41b3-b638-203dcfcfd3fe",
                "callDate":"2022-12-29 10:24:57",
                "callDirection":"IN",
                "service":"CALL",
                "externalNumber":{
                    "numberNotFormatted":48777888999,
                    "numberFormatted":"+48 777 888 999"
                }
            },
            "organisation":null,
            "person":null,
            "pin":0,
            "files":{
            },
            "edit":1,
       }
    ],
    "otherData":{
        "totalCount":1
    },
    "message":"OK"
}

Revision #11
Created 13 January 2023 07:40:34 by tzukiewicz
Updated 30 August 2023 08:20:35 by Michał