interactionisnotdelivered

POST v1/application/interactionisnotdelivered#

An interaction may have been created in your queue system for live help or a call, but for some reason this interaction may not have been assigned to any agent. In such cases, you can use this API to prevent customers from waiting on the waiting screen. The Dialogue system allows the customer in waiting status to exit the waiting screen.

API requests

Must be authenticated with HMAC Authentication. For HMAC Authentication, see the Authentication document.
API URI : https://DIYALOG-SERVER-API-ENDPOINT/v1/application/interactionisnotdelivered
HTTP Request Type POST
HTTP Content-Type application/json

Request Body#

Schema
json object
interactionId (String) Optional. It is the id information of the interaction that cannot be transmitted to any agent. This value is optional. If it is not provided, sessionId information should be provided to API.
sessionId (String) Optional. This information is the sessionId information that Diyalog sends to you when creating the interaction. Diyalog will reach the relevant customer using this information and end the customer's wait. If the interaction id information is provided to the API, the interaction id will be used first instead of this session id.
message (String) Opsiyoneldir. You can provide detailed information in this field about why the Interaction could not be forwarded to any agent. This field will be forwarded to the mobile application. You can use it as a message to be shown to the customer.

Örnek Json Request Body :#

{
    "interactionId" : "123456",
    "sessionId" : "123121212121",
    "message" : "I can't help you right now. Please try again later."
}

Note: If you give the interaction id information to the API, the API will not use the session id information. Therefore, it is sufficient to pass either the interaction id or session id information to the API.

Responses#

HTTP 200 Response
json object The API returns a json object as a response. You can get detailed information about the API result from this answer.
isSuccess (boolean) this field returns information about whether the API was successful or not. True indicates that the API is running successfully and processing your request False indicates that an error occurred.
message (string) An information message is returned regarding the result of the operation.
errorCode (int) Optional. Error code of the result. It s optional. If isSucces return true, this field will not return. Return Codes : 400 : No interactionId or seesionId is found in your request. Should be provide one of them. 402 : No customer is waiting in a given interaction id. The customer should not be waiting to connect. 403 :Customer is waiting for differrent intereaction. The customer might cancel this interaction and start another.

Örnek Response Body :#

{
    "isSuccess": true,
    "message": "Customer waiting will be stopped."
}

HTTP 500 Response
string When the API receives an exception, it will return a response with the HTTP 500 status code. The API's error message is returned as text.

If the API request receives an error during HMAC validation, the following error codes are returned.#

Http Status Code	Mesaj	Açıklama
400	Required headers not found	One or more of the Date, X-Requester-UserId, or X-Authorization header fields are missing.
400	Authorization failed due to data format not valid	The information in the X-Authorization header field is not in the correct format. Check that the field starts with "DLGA" and includes : between the accesKeyId and signature values.
400	Authorization failed due to date not valid	X-DLG-DATE date format is not "EEE, dd MMM yyyy HH:mm:ss Z".
401	Authorization failed	The request could not be verified. The signature value is not correct.
403	Request time may not be correct.	There is a difference of more than +/- 15 minutes between the x-dlg-date in the request header and the server time.