Skip to main content

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 CodeMesajA├ž─▒klama
400Required headers not foundDate, X-Requester-UserId veya X-Authorization header alanlar─▒ndan biri veya birka├ž─▒ eksik.
400Authorization failed due to data format not validX-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.
400Authorization failed due to date not validX-DLG-DATE tarih format─▒ "EEE, dd MMM yyyy HH:mm:ss Z" format─▒nda de─čil. Kontrol edin..
401Authorization failed─░stek do─črulanamad─▒. ─░mza de─čeri do─čru de─čil.
403Request time may not be correct.─░stek header'─▒nda gelen x-dlg-date ve sunucu zaman─▒ aras─▒nda +/- 15 dakikadan fazla fark var.