getonlinehelplist

POST v1/reporting/getonlinehelplist#

Bu API aracılığı ile iki tarih aralığında Diyalog üzerinden yapılan canlı yardımların listesine erişilebilinir. API'ye temsilci ve/veya müşteri numarası bilgileride verilebilir.

Her istekte maximum 20 adet bilgi tarihe göre yeniden eskiye doğru döner.

API'ye verilen iki tarih aralığında 20 adetten daha fazla öğe olabilir. Bu durumda en son yapılan 20 canlı yardım döner. İki tarih aralığında yapılan diğer öğeleride alabilmek için API cevabında dönen en eski tarihli (son öğe) öğenin tarihi alınmalı ve bu tarih kullanılarak API tekrar tekrar çağırılarak alınmalıdır.

API istekleri

HMAC Authentication ile doğrulanmalıdır. HMAC Authentication için Authentication dokümanına bakınız.
API URI : https://DIYALOG-SERVER-API-ENDPOINT/v1/reporting/getonlinehelplist
HTTP İstek Türü POST
HTTP Content-Type application/json

Request Body#

Schema
json object
startDate (long) Unix epoch timestamps (miliseconds). Canlı yardım listesinin sorgulanacağı başlangıç tarihidir.
endDate (long) Unix epoch timestamps (miliseconds). Canlı yardım listesinin sorgulanacağı bitiş tarihidir.
customerId (string) Opsiyoneldir. Müşteri numarası. Eğer bir müşterinin verilen iki tarih aralığında yaptığı canlı yardımlar görülmek isteniyorsa bu bilgi API'ye verilmelidir.
agentId (string) Opsiyoneldir. Temsilci sicil numarası. Eğer bir temsilcinin verilen iki tarih aralığında yaptığı canlı yardımlar görülmek isteniyorsa bu bilgi API'ye verilmelidir.

Not : Eğer iki tarih aralığında bir temsilci ve müşteri arasındaki canlı yardımlar görülmek isteniyorsa customerId ve agentUserId alanları API'ye verilmelidir.

Örnek Json Request Body :#

{
    "customerId" : "2337368",
    "agentId" : "45186",
    "startDate" : 1612984180000,
    "endDate" : 1615403380000
}

Responses#

HTTP 200 Response
json object array API cevap olarak json array döner. Bu array içerisinde aşağıdaki alanlardan oluşan json objeleri döner. Her objenin içerisinde yapılan canlı yardım detayları bulunur. API cevap olarak maksimum 20 adet bilgi (json objesi) tarih sıralamasına göre yeniden eskiye doğru sıralı şekilde döner. Eğer herhangi bir canlı yardım bulunamaz ise array boş olarak döner.
json object
onlineHelpId (long) Diyalog sisteminde canlı yardım için oluşturulan tekil id.
customerNo (string) Canlı Yardım talep eden müşterinin müşteri numarasıdır.
customerName (string) Canlı Yardım talep eden müşterinin ad ve soyad bilgisidir.
agentId (string) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Canlı Yardım veren temsilcinin sicil numarasıdır.
agentName (string) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Canlı Yardım veren temsilcinin ad ve soyadını bilgisidir.
helpState (string) Canlı Yardım en son aldığı durum bilgisini döner. Durum değerleri aşağıdaki gibidir : "onlinehelp_requested" "onlinehelp_cancelled_by_customer" "onlinehelp_started" "onlinehelp_ended_by_customer" "onlinehelp_ended_by_agent" "onlinehelp_ended_customer_kill_app"
helpRequestedAt (long) Unix epoch timestamps (miliseconds). Müşterinin mobil kanaldan canlı yardım talep ettiği tarih ve zaman bilgisini döner.
helpStartedAt (long) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Unix epoch timestamps (miliseconds). Temsilci ve müşterinin canlı yardıma başlama tarih ve zaman bilgisini döner.
helpEndedAt (long) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Unix epoch timestamps (miliseconds). Temsilci ve müşterinin canlı yardıma bitiş tarih ve zaman bilgisini döner.
waitTime (int) Opsiyoneldir. Saniye cinsinden müşterinin temsilci bağlanana kadar beklediği süreyi döner. Müşteri temsilci bağlanmadan iptal etmiş ise bu sürede bu alanda döner.
helpTime (int) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Saniye cinsinden müşteri ve temsilci arasında geçen canlı yardım süresini saniye cinsinden döner.
conversationDetailLink (int) Opsiyoneldir. Eğer canlı yardım başlamamamış ise bu alan dönmez. Temsilci ve müşterinin canlı yardım sırasında yaptığı yazışmaların görüntülenembileceği adresin linkidir. Bu link bir browser aracılığı ile açıldığında Diyalog platformuna bağlanılır ve mesajlaşmalar gösterilir.

Örnek Response Body :#

[
    {
        "agentId": "45186",
        "agentName": "Agent 45186",
        "conversationDetailLink": "https://web.diyalog.im/onlnehelpdetail.html/....",
        "customerName": "Customer Name1",
        "customerNo": "2337368",
        "helpEndedAt": 3,
        "helpRequestedAt": 1,
        "helpStartedAt": 2,
        "helpState": "Ended by customer",
        "helpTime": 12,
        "onlineHelpId": 12345,
        "waitTime": 4
    },
    {
        "agentId": "45187",
        "agentName": "Agent 45187",
        "conversationDetailLink":"https://web.diyalog.im/onlnehelpdetail.html/....",
        "customerName": "Customer Naem2",
        "customerNo": "7403713",
        "helpEndedAt": 3,
        "helpRequestedAt": 1,
        "helpStartedAt": 2,
        "helpState": "Ended by agent",
        "helpTime": 12,
        "onlineHelpId": 12346,
        "waitTime": 4
    }
]

HTTP 500 Response
string API hata aldığında HTTP 500 status kodu ile cevap dönecektir. API'nin hata mesajı metin olarak döner.

API isteği doğrulama sırasında hata alırsa aşağıdaki hata kodlarını döner.#

Http Status Code	Mesaj	Açıklama
400	Required headers not found	Date, X-Requester-UserId veya X-Authorization header alanlarından biri veya birkaçı eksik.
400	Authorization failed due to data format not valid	X-Authorization header alanındaki bilgiler doğru formatta değil. Alanın "DLGA " ile başlayıp accesKeyId ve imza değerleri arasına : olduğunu kontrol edin.
400	Authorization failed due to date not valid	X-DLG-DATE tarih formatı "EEE, dd MMM yyyy HH:mm:ss Z" formatında değil. Kontrol edin..
401	Authorization failed	İstek doğrulanamadı. İmza değeri doğru değil.
403	Request time may not be correct.	İstek header'ında gelen x-dlg-date ve sunucu zamanı arasında +/- 15 dakikadan fazla fark var.