Api session event editor chat set tools: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
51,321 edits
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/event/editorchat/set_tools/
API Endpoint: api/session/event/editorchat/set_tools/


Description: Set [[Tools]]
Description: Set the Agent [[Tools]] of a [[Chat Channel]].


{|class=wikitable
{|class=wikitable
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (AgentTool or multiple values in array [a, b, c])
| (AgentTool or multiple values in array [a, b, c])
| AgentTool[][]
| Array of Agent [[Tools]]
|  
|  
|}
|}
Line 35: Line 35:
===Example POST===
===Example POST===
Curl example POST
Curl example POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ [ "EXECUTE_ENDPOINT", "VALIDATE_QUERY" ], [ "EXECUTE_ENDPOINT", "GET_IMAGE" ], [ "VALIDATE_QUERY", "EXECUTE_ENDPOINT" ] ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ [ "VALIDATE_ENDPOINT", "GET_SCREEN" ], [ "VALIDATE_ENDPOINT", "GET_PAGE" ], [ "GET_SCREEN", "VALIDATE_ENDPOINT" ] ] ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST
Curl example multi item POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ [ "EXECUTE_QUERY", "GET_SUMMARY" ], [ "EXECUTE_QUERY", "GO_TO_LOCATION" ], [ "GET_SUMMARY", "EXECUTE_QUERY" ] ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ [ "GET_IMAGE", "EXECUTE_QUERY" ], [ "GET_IMAGE", "VALIDATE_QUERY" ], [ "EXECUTE_QUERY", "GET_IMAGE" ] ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST
JavaScript example POST
Line 44: Line 44:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, [ [ "EXECUTE_ENDPOINT", "VALIDATE_QUERY" ], [ "EXECUTE_ENDPOINT", "GET_IMAGE" ], [ "VALIDATE_QUERY", "EXECUTE_ENDPOINT" ] ] ]'
 body: '[ 1, [ [ "VALIDATE_ENDPOINT", "GET_SCREEN" ], [ "VALIDATE_ENDPOINT", "GET_PAGE" ], [ "GET_SCREEN", "VALIDATE_ENDPOINT" ] ] ]'
};
};
fetch("https://engine.tygron.com/api/session/event/editorchat/set_tools/", options)
fetch("https://engine.tygron.com/api/session/event/editorchat/set_tools/", options)

Revision as of 15:29, 10 November 2026

API Endpoint: api/session/event/editorchat/set_tools/

Description: Set the Agent Tools of a Chat Channel.

Index Importance Type Description Values
0 REQUIRED (CHAT_CHANNEL Integer ID or multiple integer values in array [1, 2, 3]) Chat Channels
1 REQUIRED (AgentTool or multiple values in array [a, b, c]) Array of Agent Tools

Response Codes

Response Code: Description
200 Boolean (Content was updated)
300-600 Codes Overview

Example POST

Curl example POST 

curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, [ [ "VALIDATE_ENDPOINT", "GET_SCREEN" ], [ "VALIDATE_ENDPOINT", "GET_PAGE" ], [ "GET_SCREEN", "VALIDATE_ENDPOINT" ] ] ]'

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/editorchat/set_tools/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ [ "GET_IMAGE", "EXECUTE_QUERY" ], [ "GET_IMAGE", "VALIDATE_QUERY" ], [ "EXECUTE_QUERY", "GET_IMAGE" ] ] ]'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, [ [ "VALIDATE_ENDPOINT", "GET_SCREEN" ], [ "VALIDATE_ENDPOINT", "GET_PAGE" ], [ "GET_SCREEN", "VALIDATE_ENDPOINT" ] ] ]'
};
fetch("https://engine.tygron.com/api/session/event/editorchat/set_tools/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_chat_set_tools&oldid=96564"