getmessagingdetail

POST v1/reporting/getmessagingdetail#

Bu API aracılığı ile iki tarih aralığında bir çalışanın bir müşteri ile olan yazışmalarının içeriklerinin görüntülenebileceği dinamik link bilgisi alınabilir. API kendisine verilen parametreler için dinamik bir link oluşturur ve cevap olarak döner. Bu link bir browser'da açılarak yapılan Diyalog platfromu üzerinden yapılan yazışmalar görüntülenebilir.

API linki oluştururken iki kişi arasında mesajlaşma olup olmadığına bakmaksızın otomatik link oluşturur. Eğer herhangi bir mesajlaşma yapılmamış ise API'den gelen dinamik link açıldığında boş içerik görünecektir.

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/getcalllist
HTTP İstek Türü POST
HTTP Content-Type application/json

Request Body#

Schema
json object
staffId (string) Çalışan sicil numarası.
customerId (string) Müşteri numarası.
startDate (long) Unix epoch timestamps (miliseconds). Mesajlaşma başlangıç tarihidir.
endDate (long) Unix epoch timestamps (miliseconds). Mesajlaşma bitiş tarihidir.

Örnek Json Request Body :#

{
    "staffId" : "45188",
    "customerId" : "5667067",
    "startDate" : 1610856400000,
    "endDate" : 1635892494000
}

Responses#

HTTP 200 Response
json object API cevap olarak json obje döner. Bu obje içerisinde mesajlaşma içeriğinin görünülenebileceği dinamik link bilgisi döner.
json object
isSuccess (boolean) API'nin başarılı olup olmadığı bilgisini döner. Eğer true ise başarılı demektir ve conversationDetailLink içerisinde dinamik link iletilir. Eğer false döner ise API'nin başarısız olduğu anlamına gelir. Bu durumda conversationDetailLink boş döner ver error alanında hata mesajı döner.
conversationDetailLink (string) İlgili mesajlaşmanın Diyalog platfromuna bağlanılarak görüntülenebileceği dinamik linktir. Bu link bir browser'da açıldığında, Diyalog uygulamasına bağlanılır ve mesajlaşma içerikleri Diyalog uygulaması üzerinden görüntülenebilir. API hata alırsa bu alan boş olarak dönecektir. Ek olarak eğer iki kişi arasında API'ye verilen tarihler arasında bir mesajlaşma olmamış ise link açıldığında içerik boş olarak görünecektir.
error (string) Opsiyoneldir. API hata alırsa bu alanda hata mesajı döner.

Örnek Response Body :#

Başarılı Durumda :

{
    "conversationDetailLink": "http://web.diyalog.im/views.html#/messaging?...",
    "isSuccess": true
}

Hata Durumunda :

{
    "conversationDetailLink": "",
    "error": "Staff not found in the system",
    "isSuccess": false
}

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.