Chat Wars API v1.1.3
Documentation for Chat Wars API. Chat Wars is an MMORPG hosted on the Telegram platform under the game bot. There are three game bots, but only two of them have an API that is publicly accessible.
| Server | Description |
|---|---|
| Classic | This version of the game lacks an API! The developers have announced that this version of the game will no longer receive updates anymore. The game is completely in Russian, and players who only speak english are encouraged to play on another server, or to use a translation bot to translate text that is unclear. This version of the game was launched in approximately December, 2016. |
| International | This game bot is recommended to users who speak english, however players that originate from Russia have a restricted ability to join the game. This version of the game was launched in December, 2017. |
| CW3 | CW3 is the most recent iteration of Chat Wars, and receives updates very soon after the international server receives an update. It has no restrictions on who can join the game, however, text is a mixture of Russian and English. This version of the game was launched in Mid 2018. |
Abstract
Interaction is done via AMQP (by rabbitMQ). Application should publish a message to the appropriate exchange with an appropriate routing key, and then, listen for and react to incoming messages in its queue. E.g. for the application named dices that is running on the international server there would a be direct exchange named dices_ex, routing key dices_o and an inbound queue dices_i.
The connection url will be: amqps://dices:[hidden]@api.chatwars.me:5673/
Public exchanges, however are served by the Kafka server which can be found at digest-api.chtwrs.com:9092. The topic names has cw2- and cw3- prefixes for international and cw3 instances respectively. The names of topics can be found in corresponding article.
For now all those topics have the retention configured to 1 month, which means there is only one month of data available.
Please note, that at this moment, API is mildly unstable.
Connection
There are two versions of the game with an API, and there are two versions of the API. Refer to this table for what API to connect to. Be aware, an app will not automatically have the same access to both APIs, and you must request access to each API separately.
| Server | URL |
|---|---|
| International | amqps://api.chatwars.me:5673 |
| CW3 | amqps://api.chtwrs.com:5673 |
FAQ
Q: Why can I not declare my queues?
A: This functionality is not permitted for security reasons. Please remove declarations in the API from your code, and simply consume from the queue.
Q: Why is this message continuously repeating itself?
A: You may not be ack-ing the message the API sent which causes it to come back to you on the next restart of your consumer.
Q: Why am I getting an ACCESS_REFUSED error?
A: You are not meant to be declaring anything within the API, You only have to consume and publish.
Q: Why can’t I log in?
A: You may not be connecting to the correct instance of the API! If you wish to connect to the CW3 API, This table is a good reference for what API corresponds to what URL
| Server | URL |
|---|---|
| International | amqps://api.chatwars.me:5673 |
| CW3 | amqps://api.chtwrs.com:5673 |
Q: How do I obtain access to the API?
A: To access the Chat Wars API, you must first obtain a login by emailing to The support address
A recommended format to use (but not required) can be used to make the request more clear and simple. A sample format has been provided for you.
#api
instance: cw3/cw2/both
name of application: my amazing application
purpose: Make the players have an amazing experience
my telegram name: `@durov`
Default permissions:
- request valuables transfer from you
- transfer valuables to you
- issue a wtb/wts/rm commands on your behalf
- read your profile information
- read your stock info
- to view your craft or alchemists book
- to read your guild info (stock, lobby, etc...)
Do you want pouch transactions enabled: yes
Modification of your application can also be requested with a format similar to this:
#api
instance: cw3/cw2/both
Request of modification to my app:
name of application: my amazing application
Default Permissions:
remove - request valuables transfer from you
remove - transfer valuables to you
add - read your profile information
add - read your stock info
Access to pouch transactions: removed
Q: I just got asked to test a feature on a “testing queue”. What’s that?
A: This means that new functionality for the API is being tested, and is not yet available for other applications. There is a seperate queue and routing key that you should use in this scenario. When you get asked to do the test, you should consume from the app_ti queue, and publish requests with the app_to routing key instead. So, if your application is called dices, you would be consuming from dices_ti, publishing to the dices_ex exchange, and use the dices_to routing key.
Q: Am I stupid?
A: Yes.