Api session event editor chat reset channel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: editorchat/reset_channel. | API Endpoint: editorchat/reset_channel. | ||
Description: Reset chat channel contents | |||
{|class=wikitable | {|class=wikitable | ||
| Line 14: | Line 12: | ||
|0 | |0 | ||
|REQUIRED | |REQUIRED | ||
|( | |(Integer number) | ||
|Channel | |Channel ID | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 23: | Line 21: | ||
!Description | !Description | ||
|- | |- | ||
| | |200 | ||
| | |Boolean (Found channel and removed messages returns true otherwise false) | ||
|- | |- | ||
|300-600 | |300-600 | ||
| Line 32: | Line 30: | ||
Curl example POST: | Curl example POST: | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/reset_channel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ' | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/reset_channel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST: | JavaScript example POST: | ||
| Line 39: | Line 37: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: ' | body: '1' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editorchat/reset_channel/", options) | fetch("https://engine.tygron.com/api/session/event/editorchat/reset_channel/", options) | ||
| Line 47: | Line 45: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{article end|seealso=*[[Api session event editor chat]] | {{article end|seealso=*[[Api session event editor chat]] | ||
*[[Api session items chatmessages]] | |||
}} | }} | ||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 13:32, 14 April 2026
API Endpoint: editorchat/reset_channel.
Description: Reset chat channel contents
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (Integer number) | Channel ID |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (Found channel and removed messages returns true otherwise false) |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editorchat/reset_channel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '1'
};
fetch("https://engine.tygron.com/api/session/event/editorchat/reset_channel/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));