{"info":{"_postman_id":"59d5887e-f45d-4005-8593-9182c267e497","name":"AnyCom Web Services","description":"

This document detailing all features supported by AnyCom.
\nAll features is accessible on AnyCom Web too.

Documentation version

Released at: 2021-07-01
AnyCom Core version: V1.3.023

URL

AnyCom Web Services responds on: https://ws.anycom.io/

Authentication

All requests should be contain on header (preferred mode) or JSON body the \"auth_key\" and \"auth_user\" keys.
\nauth_key - Is visible on AnyCom parameters menu option.
\nauth_user - Should be a valid user configured on AnyCom users menu option.

Request

All requests should be contain on JSON body 3 mandatory values:

\n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n\n \n \n \n\n

Key	Type	Description
\"group\"	String	Command group
\"cmd\"	String	Command
\"args\"	JSON Object	Command arguments

\n* Command arguments is detailed on each request documentation.\n\n

Response

Format
\nEach request returns on body a JSON Array, with 2 values:
\n\"status\" - Returns response code of request.
\n\"result\" - If the request response contains many values, returns a JSON list with the attributes, or return a string if the request returns only one value.
\nDetailing of result list is specified in each method.

\nResponse Codes
\nAll requests contain on header a response code, respecting table below:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Code	Description
200	OK
204	Empty response.
400	Missing authentication key!
401	Unauthorized! The authentication key does not exist or is not active.
404	Invalid method.
412	Precondition Failed.

\n* Each request contain a result detail on body.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"URL","slug":"url"},{"content":"Authentication","slug":"authentication"},{"content":"Request","slug":"request"},{"content":"Response","slug":"response"}],"owner":"15066703","collectionId":"59d5887e-f45d-4005-8593-9182c267e497","publishedId":"Tzedhjo6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-29T19:27:03.000Z"},"item":[{"name":"Channels","item":[{"name":"Display current users","id":"972baed3-ff18-4af9-b5a3-3254282bdc78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"show\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show all current users on available channels.

Request arguments

This request don't have argument option, but is mandatory send a empty \"args\" object on request JSON body.

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"customer\"	Integer	-	Customer ID on AnyCom database.
\"state\"	String	-	Current customer status (identifying/on_bot/on_chat/done).
\"session\"	Integer	-	Current session ID.
\"send\"	JSON Object	-	Detailing of sent messages.
\"count\"	Integer	\"send\"	Number of sent messages.
\"last\"	String	\"send\"	Timestamp of last sent message.
\"last_elapsed\"	String	\"send\"	Converted timestamp of last sent message.
\"chat\"	JSON Object	-	Current chat session parameters.
\"group\"	JSON Object	\"chat\"	Detailing of chat group.
\"id\"	Integer	\"group\"	Chat group ID.
\"name\"	String	\"group\"	Chat group name.
\"invited\"	Boolean	\"chat\"	Chat invited.
\"greeting\"	String	\"chat\"	Greeting message to customer.
\"call\"	String	\"chat\"	Type of call (invite/invited/accepted/direct).
\"user\"	String	\"chat\"	Username of chat attendant.
\"subject\"	String	\"chat\"	Chat subject to attendant.
\"receive\"	JSON Object	-	Detailing of received messages.
\"count\"	Integer	\"receive\"	Number of received messages.
\"last\"	String	\"receive\"	Timestamp of last received message.
\"last_elapsed\"	String	\"receive\"	Converted timestamp of last received message.
\"user_name\"	String	-	Customer name.
\"channel\"	JSON Object	-	Detailing of channel parameters.
\"user_id\"	String	\"channel\"	Full customer channel username.
\"type\"	String	\"channel\"	Channel type.
\"id\"	Integer	\"channel\"	Channel ID.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"fc9b51d6-433e-49ec-92d4-0ad521006952","name":"Display current users - Header Authentication","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"show\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"customer\": 12002,\n \"state\": \"on_bot\",\n \"session\": 16689,\n \"send\": {\n \"count\": 2,\n \"last\": \"1617043377\",\n \"last_elapsed\": \"90 days, 4:11:48\"\n },\n \"chat\": {\n \"group\": {\n \"id\": 14,\n \"name\": \"Suporte\"\n },\n \"invited\": true,\n \"greeting\": \"\",\n \"call\": \"invited\",\n \"user\": \"\",\n \"subject\": \"\"\n },\n \"receive\": {\n \"count\": 1,\n \"last\": \"1617043371\",\n \"last_elapsed\": \"90 days, 4:11:54\"\n },\n \"user_name\": \"ExCodes Software\",\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"id\": 9\n }\n }\n ]\n}"},{"id":"1ed07bc7-afa8-4273-947b-361ad445c6ce","name":"Display current users - Body Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Authentication\": {\n \"auth_key\": \"{{auth_key}}\",\n \"auth_user\": \"{{auth_user}}\"\n },\n \"Request\": {\n \"group\": \"chan\",\n \"cmd\": \"show\",\n \"args\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"customer\": 12002,\n \"state\": \"on_bot\",\n \"session\": 16689,\n \"send\": {\n \"count\": 2,\n \"last\": \"1617043377\",\n \"last_elapsed\": \"90 days, 4:11:48\"\n },\n \"chat\": {\n \"group\": {\n \"id\": 14,\n \"name\": \"Suporte\"\n },\n \"invited\": true,\n \"greeting\": \"\",\n \"call\": \"invited\",\n \"user\": \"\",\n \"subject\": \"\"\n },\n \"receive\": {\n \"count\": 1,\n \"last\": \"1617043371\",\n \"last_elapsed\": \"90 days, 4:11:54\"\n },\n \"user_name\": \"ExCodes Software\",\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"id\": 9\n }\n }\n ]\n}"}],"_postman_id":"972baed3-ff18-4af9-b5a3-3254282bdc78"},{"name":"Modify user current state","id":"62edd6c9-1262-4e84-b6d5-ab5cbf8dc8a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"state\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\",\n \"new_state\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to modify current status of customer session.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.
\"new_state\"	String	New state option (none/identifying/on_bot/on_chat/done).

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"1e7bc069-8f16-479f-bd95-e41dea9fc50c","name":"Modify user current state","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"state\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\",\n \"new_state\": \"on_chat\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"State of channel whatsapp/1/554432328668@c.us changed to on_chat\"\n}"}],"_postman_id":"62edd6c9-1262-4e84-b6d5-ab5cbf8dc8a9"},{"name":"Remove user session","id":"84033aed-5eab-4e72-adea-cdbb564532b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to remove a active customer session.

Request arguments

To execute this request below arguments is mandatory in \"args\" object on the JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"b7d7b665-c4ee-4893-a5d3-4c3749e5f5ab","name":"Remove user session","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"BOT, Channel whatsapp/1/554432328668@c.us has been removed\"\n}"}],"_postman_id":"84033aed-5eab-4e72-adea-cdbb564532b5"},{"name":"Check valid WhatsApp number","id":"c6517252-35a1-4295-8ef2-c83423a2ef5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"check\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to check if a customer number is a valid WhatsApp number.

Request arguments

To execute this request below arguments is mandatory in \"args\" object on the JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"user\"	Integer	Customer number.

\n\n

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"status\"	String	-	Result of request (invalid/valid/already).
\"contact\"	JSON Object	-	Contact number detail.
\"isBusiness\"	Boolean	\"contact\"	Show if this number is using WhatsApp Business App.
\"user_name\"	String	\"contact\"	Show current name defined on WhatsApp App.
\"channel\"	JSON Object	-	Channel detail.
\"user_id\"	String	\"channel\"	Full customer channel username.
\"type\"	String	\"channel\"	Channel type.
\"user\"	String	\"channel\"	Encountered username.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"b7571135-c088-4702-9e00-bd7e972ba70d","name":"Check valid WhatsApp number","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"check\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 9,\n \"user\": 554432328668\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"status\": \"already\",\n \"contact\": {\n \"isBusiness\": true,\n \"user_name\": \"Excodes Software\"\n },\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"user\": \"554432328668\"\n }\n }\n ]\n}"}],"_postman_id":"c6517252-35a1-4295-8ef2-c83423a2ef5c"},{"name":"Reload channel","id":"8ad8f33c-40b7-488e-b863-053299d2827c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"reload\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to execute a reload on specified channel.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"049b30bc-9c10-4a60-b895-731f54525663","name":"Reload channel","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"reload\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Reload command sent to 1\"\n}"}],"_postman_id":"8ad8f33c-40b7-488e-b863-053299d2827c"},{"name":"Send message","id":"d29497c6-c9d2-4368-9a3e-3a264e57ca0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"message\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"user\": \"\",\n \"flow\": \"\",\n \"message\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to send a message to customer.

Request arguments

To execute this request below arguments is mandatory in \"args\" object on the JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"user\"	Integer	Customer number.
\"flow\"	Integer	Flow number to execute if customer responds the message.
\"message\"	String	Message to send to customer.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"38ddfe74-2479-405f-8e53-c849c1446dae","name":"Send message","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chan\",\n \"cmd\": \"message\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"user\": 554432328668,\n \"flow\": 1,\n \"message\": \"Welcome to ExCodes Software.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Sent message to whatsapp/1/554432328668@c.us/ExCodes and flow set to 1\"\n}"}],"_postman_id":"d29497c6-c9d2-4368-9a3e-3a264e57ca0b"}],"id":"fd3d3d12-62db-42ef-b240-f4705e7da81f","_postman_id":"fd3d3d12-62db-42ef-b240-f4705e7da81f","description":""},{"name":"General","item":[{"name":"Show status","id":"f30c5ef0-e7cf-4f7a-bb13-a1c6b83246fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"status\",\n \"cmd\": \"\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show status of all available channels.

Request arguments

This request don't have argument option, but is mandatory send a empty \"args\" object on request JSON body.

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"status\"	String	-	Current channel status (UP/DOWN).
\"seen\"	JSON Object	-	Last seen detailing, displayed if the channel type is \"whatsapp\".
\"last\"	String	\"seen\"	Timestamp of channel last seen.
\"last_elapsed\"	String	\"seen\"	Converted timestamp of channel last seen.
\"clients\"	JSON Object	-	Detail of customers on the channel.
\"count\"	Integer	\"clients\"	Total customers active on channel.
\"channel\"	JSON Object	-	General channel information.
\"type\"	String	\"channel\"	Channel type.
\"id\"	Integer	\"channel\"	Channel ID number, displayed if the channel type is \"whatsapp\".

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"d680cfa5-dd51-43c0-9930-6e240cdedd5f","name":"Show status","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"status\",\n \"cmd\": \"\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"status\": \"UP\",\n \"seen\": {\n \"last\": \"1624670857\",\n \"last_elapsed\": 38\n },\n \"clients\": {\n \"count\": 2\n },\n \"channel\": {\n \"type\": \"whatsapp\",\n \"id\": 9\n }\n },\n {\n \"status\": \"UP\",\n \"clients\": {\n \"count\": 0,\n \"chats\": 0\n },\n \"channel\": {\n \"type\": \"livechat\"\n }\n },\n {\n \"status\": \"UP\",\n \"clients\": {\n \"count\": 2\n },\n \"channel\": {\n \"type\": \"liveflow\"\n }\n }\n ]\n}"}],"_postman_id":"f30c5ef0-e7cf-4f7a-bb13-a1c6b83246fb"}],"id":"0abe1e8c-970b-4eb6-a80d-1678fbe6b194","_postman_id":"0abe1e8c-970b-4eb6-a80d-1678fbe6b194","description":""},{"name":"Bot","item":[{"name":"Display current bot sessions","id":"9c1d5d51-7a7d-4ff2-9605-d1537773fae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"show\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show all current users sessions on bot.

Request arguments

This request don't have argument option, but is mandatory send a empty \"args\" object on request JSON body.

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"user_name\"	String	-	Current customer name defined on WhatsApp App.
\"next\"	JSON Object	-	Next flow item detail.
\"item\"	Integer	\"next\"	Next item ID to execute.
\"step\"	Integer	\"next\"	Internal next step ID information.
\"destination\"	JSON Object	\"next\"	Next item destination detail
\"type\"	String	\"destination\"	Type of next flow item.
\"option\"	String	\"destination\"	Next flow item options.
\"flow\"	Integer	\"next\"	Flow number ID of next item.
\"id\"	Integer	\"next\"	Internal ID of next item.
\"running\"	JSON Object	-	Running flow item detail.
\"item\"	Integer	\"running\"	Running flow item ID.
\"step\"	Integer	\"running\"	Running item step ID information.
\"destination\"	JSON Object	\"running\"	Running item destination detail
\"type\"	String	\"destination\"	Type of running flow item.
\"option\"	String	\"destination\"	Running flow item options.
\"flow\"	Integer	\"running\"	Current number flow.
\"id\"	Integer	\"running\"	Internal ID of current number flow item.
\"last_answer\"	String	-	Last answer sent to customer.
\"chat_group\"	JSON Object	-	Chat detail.
\"id\"	String	\"chat_group\"	Name of current chat group.
\"name\"	String	\"chat_group\"	Name of current chat attendant.
\"channel\"	JSON Object	-	Channel information.
\"user_id\"	String	\"channel\"	Full customer channel username.
\"type\"	String	\"channel\"	Type of channel.
\"id\"	Integer	\"channel\"	Channel ID number.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"0634a7f5-600c-4af5-8125-640b01fa70af","name":"Display current bot sessions","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"show\",\n \"args\": {}\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"user_name\": \"ExCodes Software\",\n \"next\": {\n \"item\": 98,\n \"step\": 0,\n \"destination\": {\n \"type\": \"message\",\n \"option\": null\n },\n \"flow\": 1,\n \"id\": 2036\n },\n \"running\": {\n \"item\": 12,\n \"step\": 0,\n \"destination\": {\n \"type\": \"chat\",\n \"option\": null\n },\n \"flow\": 1,\n \"id\": 125\n },\n \"last_answer\": \"\",\n \"chat_group\": {\n \"id\": \"Suporte\",\n \"name\": \"\"\n },\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"id\": 1\n }\n }\n ]\n}"}],"_postman_id":"9c1d5d51-7a7d-4ff2-9605-d1537773fae8"},{"name":"Modify current flow","id":"39430755-c37d-4efb-be72-40b55259238c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"flow\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\",\n \"flow\": \"\",\n \"item\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to modify current flow of customer session.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.
\"flow\"	Integer	New flow ID.
\"item\"	Integer	New flow item ID.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"b5432df7-c3ed-4046-b629-665c083d8d0a","name":"Modify current flow","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"flow\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\",\n \"flow\": 2,\n \"item\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Next flow of channel whatsapp/1/554432328668@c.us set to 2/1\"\n}"}],"_postman_id":"39430755-c37d-4efb-be72-40b55259238c"},{"name":"Reload service","id":"898b39af-a4a4-4007-9065-94c8bf652261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"reload\",\n \"args\": {\n \"target\": \"\",\n \"id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to reload bot functions.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"target\"	String	Target option (all/service/function/macro/global).
\"id\"	Integer	Target ID, this key should be sent only on service or function option.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"1b89c809-59b4-4374-9034-e528e71fadd2","name":"Reload service","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"reload\",\n \"args\": {\n \"target\": \"all\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Reload all command sent to LiveFlow\"\n}"}],"_postman_id":"898b39af-a4a4-4007-9065-94c8bf652261"},{"name":"Remove bot session","id":"f3d28d4d-d1d7-4cf6-ab3a-5ec725547d55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to remove bot customer session.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"8c844f18-e9f9-4f6d-bd94-1d8f81b37460","name":"Remove bot session","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"BOT of Channel whatsapp/1/554432328668@c.us has been removed\"\n}"}],"_postman_id":"f3d28d4d-d1d7-4cf6-ab3a-5ec725547d55"},{"name":"Validate bot service","id":"17c6b8e9-74a9-42b3-ad23-053aa6dfea72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"validate\",\n \"args\": {\n \"target\": \"\",\n \"id\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to validate bot service or function.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"target\"	String	Target option (service/function).
\"id\"	Integer	Target ID.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"7f2adc92-58c3-4982-b11a-a59fd4ee4c6e","name":"Validate bot service","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"bot\",\n \"cmd\": \"validate\",\n \"args\": {\n \"target\": \"service\",\n \"id\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"LiveFlow BOT service 100-(Mensagem de boas vindas) sucessfully compiled\"\n}"}],"_postman_id":"17c6b8e9-74a9-42b3-ad23-053aa6dfea72"}],"id":"575ea835-dc15-4d60-9f7e-dc8f2f3c0515","_postman_id":"575ea835-dc15-4d60-9f7e-dc8f2f3c0515","description":""},{"name":"Chat","item":[{"name":"Directly connect customer with a chat attendant","id":"ac0ab6fc-3f27-41b9-86c0-b28e56487249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"connect\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": \"\",\n \"chan_user\": \"\",\n \"chat_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to directly connect customer with a chat attendant.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n

Key	Type	Description
\"chan_type\"	String	Channel type (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.
\"chat_user\"	String	Attendant username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"50184ee3-a80e-4f0a-9b20-3065032a766c","name":"Directly connect customer with a chat attendant","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"connect\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\",\n \"chat_user\": \"maxbauer@exc\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Chat connected Successful\"\n}"}],"_postman_id":"ac0ab6fc-3f27-41b9-86c0-b28e56487249"},{"name":"Close customer chat session","id":"1932b472-fc61-49d5-9c7f-16e1a7fa1979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"close\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to close customer chat session.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Channel type (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"d3e1e378-733a-49f0-abd7-76b02efd804b","name":"Close customer chat session","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"close\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"LiveChat conversation of whatsapp/1/554432328668@c.us with maxbauer has been closed\"\n}"}],"_postman_id":"1932b472-fc61-49d5-9c7f-16e1a7fa1979"},{"name":"Drop customer chat session","id":"8bfa29e4-040f-44e2-ad10-b2e24df24798","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"drop\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to drop customer chat session.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Channel type (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	String	Full customer channel username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"7866f4f4-0691-44fd-827d-778c954d5daf","name":"Drop customer chat session","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"drop\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": \"554432328668@c.us\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"LiveChat conversation of whatsapp/1/554432328668@c.us with maxbauer@exc has been dropped\"\n}"}],"_postman_id":"8bfa29e4-040f-44e2-ad10-b2e24df24798"},{"name":"Request new chat invite","id":"323a9129-35a2-4722-87a1-263719c91dac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"invite\",\n \"args\": {\n \"chan_type\": \"\",\n \"chan_id\": \"\",\n \"chan_user\": \"\",\n \"chat_group\": \"\",\n \"chat_user\": \"\",\n \"chat_subj\": \"Attendant Subject\",\n \"chat_greet\": \"Customer greeting message\",\n \"customer_ft\": \"\",\n \"customer_fk\": \"\",\n \"session_fk\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to send a new chat invite.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chan_type\"	String	Type of channel (whatsapp).
\"chan_id\"	Integer	Channel ID.
\"chan_user\"	Integer	Customer number.
\"chat_group\"	Integer	Chat group ID.
\"chat_user\"	String	Chat attendant username.
\"chat_subj\"	String	Attendant subject.
\"chat_greet\"	String	Customer greeting message.
\"customer_ft\"	String	ERP customer type.
\"customer_fk\"	Integer	ERP customer number.
\"session_fk\"	Integer	ERP ticket number.

\nObs:
\n- On invite \"chat_user\" is preferred if is defined.
\n- The message defined on \"chat_greet\" is send when the attendant accept invite.\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"a9ac998f-a20e-4bcb-af92-3061d555cf0e","name":"Request new chat invite","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"invite\",\n \"args\": {\n \"chan_type\": \"whatsapp\",\n \"chan_id\": 1,\n \"chan_user\": 554432328668,\n \"chat_group\": 1,\n \"chat_user\": \"\",\n \"chat_subj\": \"Attendant Subject\",\n \"chat_greet\": \"Customer greeting message\",\n \"customer_ft\": \"M\",\n \"customer_fk\": 1234,\n \"session_fk\": 1000\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"Chat invited Successful\"\n}"}],"_postman_id":"323a9129-35a2-4722-87a1-263719c91dac"},{"name":"Disconnect attendant from chat","id":"c0e2d904-810d-4c46-95c1-6aab2a56f315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chat_user\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

Use this request to disconnect a attendant from chat.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"chat_user\"	String	Attendant username.

\n\n

Result detail

This request returns a simple result string.

\n","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"480d2532-768d-40e5-ad13-8eb556079cf3","name":"Disconnect attendant from chat","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"rem\",\n \"args\": {\n \"chat_user\": \"excodes\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": \"LiveChat User excodes has been removed\"\n}"}],"_postman_id":"c0e2d904-810d-4c46-95c1-6aab2a56f315"},{"name":"Show online chat attendants","id":"f586c36c-c33e-439d-b36f-bd8744f771fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"user\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show details of online chat attendants.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"target\"	String	Target to show (user).

\n\n

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"chat_user\"	String	-	Chat username.
\"connection\"	JSON Object	-	Attendant connection details.
\"start_time\"	String	\"connection\"	Timestamp of attendant AnyCom Chat login.
\"ip_addr\"	String	\"connection\"	Attendant source IP address.
\"last_ack\"	Integer	\"connection\"	Last ACK of attendant in seconds.
\"group\"	JSON Object	-	Attendant group details.
\"id\"	Integer	\"group\"	Primary attendant chat group ID.
\"alternative_groups\"	List	\"group\"	Alternative attendant chat group ID.
\"name\"	String	\"group\"	Name of primary attendant chat group.
\"os\"	JSON Object	-	Attendant device details.
\"version\"	String	\"os\"	Operating system version.
\"name\"	String	\"os\"	Operating system name.
\"web_version\"	JSON Object	-	AnyCom Web details.
\"front\"	String	\"web_version\"	Version of AnyCom Web platform.
\"core\"	String	\"web_version\"	Version of AnyCom Core platform.
\"clients\"	JSON Object	-	Current customers detail.
\"count\"	Integer	\"clients\"	Number of current customers on chat.
\"chat_user_name\"	String	-	Attendant display name.
\"browser\"	JSON Object	-	Attendant browser details.
\"version\"	String	\"browser\"	Attendant browser version.
\"name\"	String	\"browser\"	Name of browser in use by attendant.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"8f20e683-7b73-4919-9210-192f5ecb705c","name":"Show online chat attendants","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"user\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"chat_user\": \"maxbauer\",\n \"connection\": {\n \"start_time\": \"1624927155\",\n \"ip_addr\": \"10.1.200.20\",\n \"last_ack\": 4\n },\n \"group\": {\n \"id\": 14,\n \"alternative_groups\": [],\n \"name\": \"Suporte\"\n },\n \"os\": {\n \"version\": \"10.15.7\",\n \"name\": \"macOS\"\n },\n \"web_version\": {\n \"front\": \"V1.3.010\",\n \"core\": \"V1.3.013\"\n },\n \"clients\": {\n \"count\": 1\n },\n \"chat_user_name\": \"Max\",\n \"browser\": {\n \"version\": \"91.0.4472.114\",\n \"name\": \"Chrome\"\n }\n }\n ]\n}"}],"_postman_id":"f586c36c-c33e-439d-b36f-bd8744f771fe"},{"name":"Show current chat awaiting","id":"9097c0c9-c1b6-404c-908c-fd7eb78a5a0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"awaiting\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show awaiting customers on chat.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"target\"	String	Target to show (awaiting).

\n\n

Result detail

This request returns following structure on result JSON list:

Key	Type	Parent Key	Description
\"chat\"	JSON Object	-	Chat details.
\"call\"	String	\"chat\"	Type of call.
\"group\"	JSON Object	\"chat\"	Chat group detail.
\"id\"	Integer	\"group\"	Chat group ID.
\"name\"	String	\"group\"	Chat group name.
\"greeting\"	String	\"chat\"	Customer greeting message on chat accept.
\"subject\"	String	\"chat\"	Attendant subject invite.
\"channel\"	JSON Object	-	Channel details.
\"user_id\"	String	\"channel\"	Full channel customer username.
\"type\"	String	\"channel\"	Type of channel.
\"id\"	Integer	\"channel\"	Channel ID.
\"user_name\"	String	\"channel\"	Channel customer displayed name.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"3af6efd9-1666-445e-ada0-26a2c9f45b49","name":"Show current chat awaiting","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"awaiting\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"chat\": {\n \"call\": \"invited\",\n \"group\": {\n \"id\": 14,\n \"name\": \"Suporte\"\n },\n \"greeting\": \"\",\n \"subject\": \"Recuperada da desconexão de [CHAT_USER_NAME]\"\n },\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"id\": 9,\n \"user_name\": \"ExCodes Software\"\n }\n }\n ]\n}"}],"_postman_id":"9097c0c9-c1b6-404c-908c-fd7eb78a5a0a"},{"name":"Show current chat conversation","id":"038d2a8a-4f96-43ec-b029-bde4ff1854aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"conversation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/","description":"

This request show current customers on chat conversation.

Request arguments

To execute this request, below arguments is mandatory in \"args\" object on JSON request body.

\n\n \n \n \n \n \n \n \n \n \n \n

Key	Type	Description
\"target\"	String	Target to show (conversation).

\n\n

Result detail

This request returns following structure on result JSON list:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Key	Type	Parent Key	Description
\"chat_user\"	String	-	Attendant chat username.
\"chat_user_name\"	String	-	Attendant chat displayed name.
\"chat_group\"	JSON Object	-	Chat group detail.
\"id\"	Integer	\"chat_group\"	Chat group ID.
\"name\"	String	\"chat_group\"	Chat group name.
\"channel\"	JSON Object	-	Channel details.
\"user_id\"	String	\"channel\"	Full channel customer username.
\"type\"	String	\"channel\"	Type of channel.
\"id\"	Integer	\"channel\"	Channel ID.
\"user_name\"	String	\"channel\"	Channel customer displayed name.

","urlObject":{"protocol":"https","path":[""],"host":["ws","anycom","io"],"query":[],"variable":[]}},"response":[{"id":"9353fd46-e29d-4a1e-b065-4b5dc7a2c6dc","name":"Show current chat conversation","originalRequest":{"method":"POST","header":[{"key":"auth_key","value":"{{auth_key}}","type":"text"},{"key":"auth_user","value":"{{auth_user}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group\": \"chat\",\n \"cmd\": \"show\",\n \"args\": {\n \"target\": \"conversation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.anycom.io/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": [\n {\n \"chat_user\": \"maxbauer\",\n \"chat_user_name\": \"Max\",\n \"chat_group\": {\n \"id\": 0,\n \"name\": \"\"\n },\n \"channel\": {\n \"user_id\": \"554432328668@c.us\",\n \"type\": \"whatsapp\",\n \"id\": 9,\n \"user_name\": \"ExCodes Software\"\n }\n }\n ]\n}"}],"_postman_id":"038d2a8a-4f96-43ec-b029-bde4ff1854aa"}],"id":"7a23a6f7-b71e-42b7-a3fc-ff0a1f7d112f","_postman_id":"7a23a6f7-b71e-42b7-a3fc-ff0a1f7d112f","description":""}],"event":[{"listen":"prerequest","script":{"id":"390d78ce-0cd8-4ee3-95fa-fc9e1378a888","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ed7656c0-0c5c-42fe-a8fe-8a166acd4125","type":"text/javascript","exec":[""]}}]}