search

zelloptt / zello-channel-api

WebSocket-based API and SDKs to connect to Zello channels (BETA)
MIT License
87 stars 34 forks source link

API documentation: error codes, message sequencing #233

Open PhilRW opened 1 month ago

PhilRW commented 1 month ago

Hello:

Would it be possible to please document some error codes on the API, such as: empty message woodpecker prohibited ...and others?

Also a brief explanation of what they mean would be appreciated and a potential remedy so the error handler code doesn't blindly retry without taking corrective action. Some I have been able to reverse engineer as they are fairly obvious (not authorized, for example), but others not so much.

Also an explanation of (a)synchronicity and sequencing of messages, for example, on_stream_start and on_stream_stop. I can understand multiple simultaneous streams but the consumer API only supports one channel which is logically treated as a half duplex connection, so I would expect on_stream_stop to follow after each on_stream_start, but occasionally messages are not received or are received out of order. Without further explanation and/or sequence diagrams, I am coding against the API in the dark.

Thanks!

AndyW999 commented 2 weeks ago

And I have some undocumented ones -

kicked unable to verify invalid stream id

Are there any more you are not telling us about?

Plus is there a method of reporting network problems yet as today I am able to send from channel API -> Android but there are no incoming packets from Android -> Channel API.

Thanks

Andy.

AndyW999 commented 2 weeks ago

And it had just started working again - maybe somebody does actually look at this...