About the request timeout

[AnonymousPanda]

Hello,

I've read some articles stating that Genesys Cloud's Platform APIs have a default timeout value of 15,000 ms. Where can I find the official documentation regarding this timeout value?

Additionally, I'd like to know what action the Genesys Cloud system takes when it encounters a timeout.
Does it automatically retry the request, or does it simply mark the request as a 'failure' and terminate?

[Eos_Rios]

This is pretty much it;

Conversations api read timeout

FWIW, you should set your client's request timeout to 16 seconds (16,000 ms). The API's max timeout is 15 seconds, so you'll always get some kind of response within that period. Setting your timeout to 1 second more allows some buffer to count time in transit because the API measures 15 seconds on its side. If your client timeout is reached, that indicates a network error as the API will always respond.

But I've submitted a recommendation for it to be added in the API overview since it should be documented somewhere official if it's a basic fact of the API.

[AnonymousPanda]

Hello Eos_Rios,

I have read that comment as well.
Does that mean there's no official documentation about the API request timeout at this point?

[tim.smith]

Yes, but I can confirm that my quoted post is the official answer.

[AnonymousPanda]

Hello tim.smith,
Thank you for your confirmation.

I also would like to ask you what actions Genesys Cloud takes when it encounters a timeout for an API request sent to the client. My initial post was about a scenario where the client sent a request to Genesys Cloud and the client failed to send the corresponding request due to the request timeout of 15000ms, so I'm asking for the opposite case this time.

Does Genesys automatically retry sending the timed-out request, or does it simply return a 5XX response code, mark the request as timed out, and not retry at all?

[tim.smith]

@AnonymousPanda

Does Genesys automatically retry sending the timed-out request, or does it simply return a 5XX response code, mark the request as timed out, and not retry at all?

If the request times out internally on the server side, it will send a 504 response. The server does not have any control over your application, the client, and cannot force it to retry the request. Implementing retry logic is up to your application.

[AnonymousPanda]

Thank you, tim.smith.
It really helped a lot.