This API is designed to send and receive messages, get clients list, apply tags, set webhooks and more.
\nTo start testing the API:
\nGo to the System site (see TERMS below) under admin account and open Settings > API section.
\nUsing Postman app, copy API token to this Postman collection in Variables section.
\nMake sure you have a few messages from clients to test the API.
\nThe footnotes indicate the changes that are planned for the next release.
\nImportant! The release date can be changed.
\n2026-01-27
\nAdded new imported_message event for webhooks (POST)
Added API for operators management (/operators (POST), (PUT))
Added API for new custom role model (/access rights (GET) and /access_rights/:id (GET))
2025-07-30
\nAdded new parameter force_assign for the following methods messages/:id/transfer, messages/:id/transfer_to_group, dialogs/:id/
2025-06-06
\nAdded Webhook Signature Verification (HMAC). See Webhooks description
\n2025-05-01
\nChanges in /statistics response. Examples added
2024-09-17
\nAdded new method companies/info (GET)
2024-08-12
\nAdded API for Tickets managment (/tickets (GET), (POST), (PUT), (DELETE))
Added new new_ticket, ticket_updated, ticket_deleted events for webhooks (POST)
Added new values (help/tickets (GET)) for Tickets in Data types and values
2024-07-03
\nAdded new client_added_to_blacklist event for webhooks (POST).
Added new filter by channels for webhooks (POST).
Added new supported transport for messages (POST) with buttons and interactive type.
Added two_factor field in operators (GET) response.
Added attachment_filename parameter for messages (POST) to provide the original filename.
Added attachment parameter for messages/inbox (POST). We recommend using this instead of image or video.
Added attachment_filename parameter for messages/inbox (POST) to provide the original filename. Note that attachment is required; image or video do not support attachment_filename.
2024-02-20
\nAdded new events operator_status_changed and operator_authentication_updated for webhooks (POST).
Added new parameters client_phone and custom_fields for message/inbox (POST).
Added the ability to send interactive messages with type list in Wa dialog for messages (POST).
Added the ability to send interactive messages with type buttons in Wa dialog for messages (POST).
System — Chat2Desk service.
\nClient — is a person, who sends or receives messages via the System.
\nTransport – is a messenger, social network or online chat which is supported by the System. Such as WhatsApp, Viber, Telegram, Facebook, Instagram, VKontakte, online chat and more.
\nChannel — is a group of your messenger accounts. You can have many channels with different auto replies, self service menu, chat assignment etc. for each channel.
\nExternal channel — is a source of messages from any messenger (transport) not supported by the System. For example, 3rd party chat, messenger, app or CRM.
\nRequest — is a set of messages within a dialog with a client. As a rule, request starts with first client message and finishes when the dialog is closed. When the client continues to chat in closed dialog, a new request starts in the same dialog.
\nRESTful architecture and methods GET, PUT, DEL and POST are used.
\nCommands’ results are presented in JSON format.
\nThis API uses HTTPS.
\nAuthorization is based on API token, which is available in Settings > API on the site under admin account.
\nCommands that return large list of data support pagination using URL parameters:
\nlimit — number of records returned (maximum is 200, default is 20).
\noffset — offset from the 1st record of the list (default is 0). Messages (GET) is an exception as it uses start_id instead of offset.Example of the request (list of clients): /v1/clients?offset=50&limit=30
In general, the system is designed to answer those clients who first contacted your company and so are in the list of you clients (see clients (GET)). Using clients (POST) you can create a new client and then contact him or her. Contact these newly created clients reasonably because your messenger account might get blocked for spam in case of too many new contacts or messages.
Obtain your API token on the System site in Settings > API section. Info on the API is available with api_modes (GET). Put the token to this Postman collection in Variables section using Postman app.
There are 2 ways to work with messages:
\nYour clients use regular messengers, social networks, emails or our online chat to send messages to your company. In this case use webhooks (POST) to receive these messages from the System. To send messages back to the clients use messages (POST).
If you want to contact a client that never contacted you before ( this is Write first paid option) use client (POST) to create a new client, get the client's id and then use messages (POST) to send a message as described above.
Your clients contact you via your own app, CRM or contact form and you need the System to let your operators (agents) and chat bots to serve the clients. You should use external channel to pass messages to the System from these external source of messages using messages/inbox (POST). To receive operators’ and chat bots replies to send them back to your clients – use webhooks (see webhooks (POST)).
Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"order\": \"desc\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/clients","description":"Returns a list of your clients with their info. You can filter the list of clients by clients phone, tags, info in client's info card and more.
\nSome fields in response:
\nclients (PUT).clients (PUT).Client’s phone filter. For Telegram numeric (user), client's phone is stored as [tg_user] 11122233344.
\n","type":"text/plain"},"key":"phone","value":"918446169771"},{"disabled":true,"description":{"content":"Сlient’s phone if the client revealed his/her real phone number in messengers that do not disclose it by default (currently Telegram and Facebook). Also this field can be edited by an operator manually or via clients (PUT).
\n","type":"text/plain"},"key":"client_phone","value":"380504312345"},{"disabled":true,"description":{"content":"Client's tags filter, comma delimited. Clients with at least 1 tag from the list are returned.
\n","type":"text/plain"},"key":"tags","value":"103429,103430"},{"disabled":true,"description":{"content":"Client custom field id to filter clients using custom_field[text] (see custom_client_fields (GET)).
\n","type":"text/plain"},"key":"custom_field[id]","value":"1"},{"disabled":true,"description":{"content":"Text to seacrh in field id specified by custom_field[id].
\n","type":"text/plain"},"key":"custom_field[text]","value":"California"},{"disabled":true,"description":{"content":"Clients with creation date (by the first message)\nafter specified unix time are returned.
\n","type":"text/plain"},"key":"created_after","value":""},{"disabled":true,"description":{"content":"Order of records returned (asc, desc). Default is ascending order.
\n","type":"text/plain"},"key":"order","value":"asc"},{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"e0147890-39d5-470f-9b10-6a35abfff7e6","name":"clients","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/clients/17340089/","description":"Returns extended info for a specified client. 17340089 here is an example of client id.
\nSee clients (GET) for more info.
Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/clients/17340089/transport","description":"Returns a list of available transports for the client specified (see TERMS for transport). 17340089 here is an example of client id.
\nSee clients (GET) for more info.
Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/clients/17340089/dialogs","description":"Returns a list of dialogs for the client specified. 17340089 here is an example of client id.
\nSee clients (GET) for more info.
Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/clients/17340089/questions?start_date=01-11-2021&finish_date=31-12-2021","description":"Returns a list of self service menu items sent to the client specified. 17340089 here is an example of client id. See Settings > Self-service menu section on the site.
\nSee clients (GET) for more info.
Date span
\n","type":"text/plain"},"key":"start_date","value":"01-11-2021"},{"description":{"content":"Date span
\n","type":"text/plain"},"key":"finish_date","value":"31-12-2021"}],"variable":[]}},"response":[{"id":"082e9129-67f3-4888-a62c-1782a0a9cfd6","name":"clients/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/clients/17340089/last_question","description":"Returns the last self service menu item sent to the client specified. 17340089 here is an example of client id. See Settings > Self-service menu section on the site.
\nSee clients (GET) for more info.
Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"ban_status\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/clients/673282519","description":"Modifies info for specified client.
17340089 here is an example of client id.
clients (GET). This field is informational and is NOT used when exchanging messages with messenger. It and can be edited in client card.custom_client_fields (GET).Get this token in Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.chat2desk.com/v1/clients","description":"Creates a new client so you can contact this client afterwards. It is possible to send messages only to a client which exists in the System. So if you need to contact a client first, the client have to be created first.
\nUse with caution because a client that you contact first, likely, doesn't have your number in address book and can tap “This is spam!” button, which may lead your WhatsApp or Viber account to get blocked.
\nAfter successful execution, the command returns an info on newly created client. Region and country are determined based on the phone number.
\nHaving received the client’s id, you can then send this client a message using messages (POST).
To use this command you need a Write first option. It is turned off by default. Contact our tech. support on the site to enable this option.
\nIf the client is already registered in the system, the client_id will be returned in error in response to the request (see example error Client already exists)
Client’s phone number with country code, without any symbols and spaces or email address if you want to contact the client via email.
\n","type":"text/plain"},"key":"phone","value":"499210009991"},{"disabled":true,"description":{"content":"Name of a transport (messenger), via which you want to contact this client. You can create a new client only using WhatsApp, Viber, Viber Business, External, Email and SMS. To get a list of your available transports use transports (GET).
\n","type":"text/plain"},"key":"transport","value":"whatsapp"},{"disabled":true,"description":{"content":"(Optional) Id of a channel in which the client will be created. If left blank, your first channel will be used. To get a list of your channels use channels (GET).
\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"(Optional) Assigned name of this new client.
\n","type":"text/plain"},"key":"nickname","value":"John"},{"disabled":true,"description":{"content":"(Optional) Client’s phone number that can stored\nadditionally in client card. This field is informational and is NOT used when exchanging messages with messenger. It and can be edited in client card.
\n","type":"text/plain"},"key":"assigned_phone","value":""}],"variable":[]}},"response":[{"id":"507f667e-40fb-4fbe-97e1-8c622553e618","name":"OK clients","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Get this token in Settings > API section (under admin account)."},{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://api.chat2desk.com/v1/clients","host":["https://api.chat2desk.com"],"path":["v1","clients"],"query":[{"key":"phone","value":"499210009991","description":"Client’s phone number with country code, without any symbols and spaces or email address if you want to contact the client via email.","disabled":true},{"key":"transport","value":"telegram","description":"Name of a transport (messenger), via which you want to contact this client. You can create a new client only using WhatsApp, Viber, Viber Business, External, Email and SMS. To get a list of your available transports use *transports (GET)*.","disabled":true},{"key":"channel_id","value":"21872","description":"(Optional) Id of a channel in which the client will be created. If left blank, your first channel will be used. To get a list of your channels use *channels (GET)*.","disabled":true},{"key":"nickname","value":"John","description":"(Optional) Assigned name of this new client.","disabled":true},{"key":"assigned_phone","value":"","description":"(Optional) Client’s phone number that can stored\nadditionally in client card. This field is informational and is NOT used when exchanging messages with messenger. It and can be edited in client card. ","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"id\": 75,\r\n \"assigned_name\": John,\r\n \"phone\": \"499210009991\",\r\n \"name\": null,\r\n \"avatar\": null,\r\n \"region_id\": null,\r\n \"country_id\": 1,\r\n \"first_client_message\": \"2016-07-07T05:34:28 UTC\",\r\n \"last_client_message\": \"2016-07-07T05:34:28 UTC\"\r\n },\r\n \"status\": \"success\"\r\n}"},{"id":"d1d759cf-d355-46a1-ac97-e348f7b1caff","name":"error Client already exists","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/custom_client_fields","description":"Returns your list of custom fields of client info card. These fields can be edited in Settings > General section on the site.
\nSome fields in response:
\nWorking with clients.
\n","_postman_id":"92271ce1-eb82-4a28-adac-0ec38e2324e2"},{"name":"Messages & requests","item":[{"name":"messages","id":"eab4cc5c-f448-4ae0-807a-406b25df0930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/","description":"Returns a list of accumulated messages (both from and to clients as well as system messages). Where supported, delivery and read status also returned.
\nWhen this command is used without message id it returns a list of all messages. When message id is specified, the command returns extended info about specified message, including dialog_id, operator_id and channel_id.
\nImportant! Do not use this command too often with high number of records to receive (limit parameter). You will hit API requests limit very soon. Use webhooks instead (see web_hook (POST)).
Pay attention, that for this messages (GET) command start_id parameter replaces offset parameter to reduce server load.
Some fields in response:
\ncoordinates – geo coordinates.
\ntype:
\nfrom_client – a message from client.
\nto_client – a message to client.
\nsystem – system message (like “Chat was transferred…”). Such message is not sent to a client.
\nautoreply – autoanswer to a client or menu message.
\nread – status read or not by an operator.
\ncreated – date of message creation (UTC).
\nrecipient_status – info about delivery status of the message (where supported).
\nattachments – array of attachments in the message with name and link of each attachment. For backward compatibility some attachment types are additionally returned in separate fields like photo, video and audio.
\ninsta_comment – true for Instagram comment message.
\nextra data – may contain:
\nexternal id passed using messages/inbox (POST)).
post_url - link to a post for Instagram comment message.
\nOrder of records returned (asc or desc). Default is ascending order.
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Transport filter.
\n","type":"text/plain"},"key":"transport","value":"whatsapp"},{"disabled":true,"description":{"content":"Channel id.
\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"Client's id.
\n","type":"text/plain"},"key":"client_id","value":"17340089"},{"disabled":true,"description":{"content":"Supprorted types: to_client, from_client, autoreply, system.
\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"Operator's id.
\n","type":"text/plain"},"key":"operator_id","value":""},{"disabled":true,"description":{"content":"Timespan start date. The parameter is mutually exclusive with the start_id parameter. If the start_id parameter is specified, the use of the parameters start_date and finish_date is not allowed.
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"Timespan finish date. The parameter is mutually exclusive with the start_id parameter. If the start_id parameter is specified, the use of the parameters start_date and finish_date is not allowed.
\n","type":"text/plain"},"key":"finish_date","value":""},{"disabled":true,"key":"dialog_id","value":"18498876"},{"disabled":true,"description":{"content":"(instead of offset pararmeter) starting message id (messages with id⩾start_id). The parameter is mutually exclusive with the start_date and finish_date parameters. If the start_date and finish_date parameters are specified, the use of the parameters start_id is not allowed.
\n","type":"text/plain"},"key":"start_id","value":""},{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"The enabled parameter sorts messages by start_id in reverse order, from later to earlier.
\n","type":"text/plain"},"key":"direction_reverse","value":"true"}],"variable":[]}},"response":[{"id":"cc43aac4-e1a2-4b51-98a8-da32cd9cf9e7","name":"messages","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/1312913968","description":"Returns an info on specified message id. 1 here is an example of message id. Where supported, delivery and read status is returned.
\nSee messages (GET) for more info.
Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":""},"url":"https://api.chat2desk.com/v1/messages/1/transfer?operator_id=100","description":"Assigns a dialog to which the specified message belongs to an operator specified. 1 here is an example of message id.
\n","urlObject":{"path":["v1","messages","1","transfer"],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Id of an operator (agent), on whom this message and corresponding dialog will be assigned. See operators (GET).
\n","type":"text/plain"},"key":"operator_id","value":"100"},{"disabled":true,"description":{"content":"Force-assign a chat bypassing all assignment rules (default: true).\nSet to false to apply standard assignment logic: operator online status, queues, and dialog limits.
\n","type":"text/plain"},"key":"force_assign","value":"{true, false}"}],"variable":[]}},"response":[{"id":"05ab4925-56ae-40f5-8188-a178fca22695","name":"OK transfer","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/1312913968/unread","description":"Marks a message as read by operator (agent).\n1312913968 here is an example of message id.
\nNote, that when a message gets answered, the message and the whole dialog are marked as read automatically.
\n","urlObject":{"path":["v1","messages","1312913968","unread"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f0372df-04dd-42d3-ba94-8cc0146a5f30"},{"name":"messages/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/1312913968/unread","description":"Marks a message as unread by operator (agent). 1312913968 here is an example of message id.
\nNote, that when a message gets answered, the message and the whole dialog are marked as read automatically.
\n","urlObject":{"path":["v1","messages","1312913968","unread"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a84e3d5-d0bd-408a-ac71-2c8de9e2242b"},{"name":"messages","id":"56879bbe-3d69-4c64-9f23-07c10971723d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"Button\": \n {\n \"text\": \"Label\",\n \"type\": \"reply\",\n \"payload\": \"My payload\",\n \"color\": \"red\",\n \"url\": \"http://site.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/messages","description":"Sends a message, including buttons, to a client. You can refer a client only by his/her client id. So, this client should exist in clients’ list. Otherwise, use clients (POST) to create a new client.
17340089 here is an example of client id.
Important! Rate limit is apllied to sending messages using this command. The rate is around 15-20 messages per second (may vary). In case of too many messages an error will be returned: 429 Too many requests.
\nWhen sending buttons (see inline_buttons and keyboard parameters), these parameters supported by messengers:
\nreply – VK, Viber Public, Facebook, Telegram, Online chat, Instagram.
\nphone – Telegram, Facebook, Viber Public.
\nemail – Facebook.
\nlocation – Telegram, Facebook.
\nurl – Viber Public, Online chat.
\npayload – Viber Public, Facebook, VK, Online chat.
\ncolor – Viber Public, VK.
\nInline-buttons support:
\nurl – Viber Public, Facebook, Telegram
\nreply – Viber Public, Facebook, Telegram, Wa_dialog, Wa_gupshup, Wa_direct.
\nlocation, phone, email – none
\nWe recommend keeping buttons text 38 characters maximum (19 for cyrillic characters). Otherwise the message with buttons might not be sent.
\nList messages (interactive) support:
\nWa_dialog
\nWa_gupshup
\nWa_direct
\nMessage text (required if there’s no attachment).
\n","type":"text/plain"},"key":"text","value":"Hello, developer (with buttons)"},{"disabled":true,"description":{"content":"Direct URL for an attachment (photo, audio, PDF, etc.). Not all attachment file types are supported by all messengers.
\n","type":"text/plain"},"key":"attachment","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/9/97/The_Earth_seen_from_Apollo_17.jpg/1280px-The_Earth_seen_from_Apollo_17.jpg"},{"disabled":true,"description":{"content":"Original filename for attachment. Attachment (link) required. If ommited we'll try to get it from link
\n","type":"text/plain"},"key":"attachment_filename","value":"PDF Example.PDF"},{"disabled":true,"description":{"content":"Id of a client to whom message will be sent
\n","type":"text/plain"},"key":"client_id","value":"17340089"},{"disabled":true,"description":{"content":"See channels (GET). If omitted, channel of last message from the client will be used.
\n","type":"text/plain"},"key":"channel_id","value":""},{"disabled":true,"description":{"content":"Id of the operator on whose behalf the message will be sent. \nIf the dialog is assigned to another operator, then when sending the current request, the chat will not be reassigned, and the message will be sent from the operator specified in the parameter.\nTo reassign the dialog to another operator, use the (PUT) dialogs request.
\n","type":"text/plain"},"key":"operator_id","value":""},{"disabled":true,"description":{"content":"The status of the dialog.\nThe dialog can be open (the value = true) or closed (value = false). By default the value = true.
\nNB: If the dialog is closed and the current request is sent with the value true, the dialog will switch to the open status.
\n","type":"text/plain"},"key":"open_dialog","value":"{true, false}"},{"disabled":true,"description":{"content":"If you send message using an integration with another platform or CRM system, you can store id of the message in the external system in this field.
\n","type":"text/plain"},"key":"external_id","value":""},{"disabled":true,"description":{"content":"Send the message in encrypted format or not. By default - false. The message looks encrypted everywhere inside the System but anyway is sent to a client in normal nonencrypted format.
\n","type":"text/plain"},"key":"encrypted","value":"{true, false}"},{"disabled":true,"description":{"content":"Id of a message to quote when sending this message (in reply to). The text of the message will look like this:\n«Initial message text»\n— Message text
\n","type":"text/plain"},"key":"reply_message_id","value":"1312926701"},{"disabled":true,"description":{"content":"Button array may contain:\n\"Button\": {
\nurl – Viber Public, Facebook, Telegram\nreply – Viber Public, Facebook, Telegram\nlocation, phone, email – none
\n","type":"text/plain"},"key":"inline_buttons","value":"Button[]"},{"disabled":true,"description":{"content":"Example: {\"keyboard\": {\"buttons\": [{\"type\":\"url\", \"text\": \"Site\nbutton\", \"color\": \"blue\",\"url\": \"https://www.google.com\"}]}}
\n","type":"text/plain"},"key":"keyboard","value":"Button: {type:reply;text:A button}"},{"disabled":true,"description":{"content":"An array with interactive message parameters for the \"list\" and \"button\" types. Only for wa_dialog.
\n","type":"text/plain"},"key":"interactive","value":""}],"variable":[]}},"response":[{"id":"005e67f3-10b3-4cfb-8777-4916972d53a8","name":"message with keyboard","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\r\n \"channel_id\": \"1\",\r\n \"body\": \"This is message text\",\r\n \"attachment\": \"https://pdfobject.com/pdf/sample.pdf\",\r\n \"attachment_filename\": \"PDF Example.PDF\",\r\n \"location\": \"lat lng\",\r\n \"extra_data\": {\r\n \"external_id\": \"111111\"\r\n },\r\n \"from_client\": {\r\n \"id\": \"123abc\" or \"phone\": 19110001122,\r\n \"avatar\": \"direct url\",\r\n \"nickname\": \"API_boy\",\r\n \"client_phone\": 7800808080,\r\n \"custom_fields\": {\r\n \"1\": \"Text 1\",\r\n \"2\": \"Text 2\",\r\n \"3\": \"Text 3\"\r\n }\r\n }\r\n}\r\n\r\n/*\r\n \"channel_id\" - id of the channel.\r\n \"body\" - message text.\r\n \"attachment\" - (optional) direct URL for an attachment\r\n \"attachment_filename\" - (optional, attachment required). If ommited we'll try to get it from link\r\n \"attachment_filename\": \"PDF Example.PDF\",\r\n \"image\" - (optional, not supported) url to image. Only one of these two parameters is accepted: \"image\" or \"video\".\r\n \"video\" - (optional, not supported) url to video. \r\n \"location\"- (optional) link to the location.\r\n \"external_id\"-(optional) your id of the message. This id will be sent you back using inbox web hook event.\r\n This id is also available via messages (GET).\r\n \"id\"- id as you identify a client (any symbols), except phone number. If you identify a client with phone number, \r\n then use the phone parameter.\r\n \"phone\"- client’s phone number. Only digits are allowed.\r\n \"avatar\" - (optional) client’s avatar (url to a picture) to display in Chats section.\r\n \"nickname\" - (optional) client’s name. Works only if nickname is empty. To change existing client's name use PUT Clients\r\n \"client_phone\" - (optional) customer's phone number.\r\n \"custom_fields\" -(optional) an array that includes the unique identifiers of the Client's custom fields and their values.\r\n*/","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/messages/inbox","description":"Sends incoming message from client to the System using external channel.
\nExample:
\n{\n \"channel_id\": \"1\",\n \"body\": \"This is message text\",\n \"attachment\": \"https://pdfobject.com/pdf/sample.pdf\",\n \"attachment_filename\": \"PDF Example.PDF\",\n \"location\": \"lat lng\",\n \"extra_data\": {\n \"external_id\": \"111111\"\n },\n \"from_client\": {\n \"id\": \"123abc\" or \"phone\": 19110001122,\n \"avatar\": \"direct url\",\n \"nickname\": \"API_boy\",\n \"client_phone\": 7800808080,\n \"custom_fields\": {\n \"1\": \"Text 1\",\n \"2\": \"Text 2\",\n \"3\": \"Text 3\"\n }\n }\n}\n\nexternal_id – (optional) your id of the message. This id will be sent you back using inbox webhook event. This id is also available via messages (GET).
id – id as you identify a client (any symbols), except phone number. If you identify a client with phone number, then use phone parameter.
\nphone – client’s phone number. Only digits are allowed. Only one of these two parameters is accepted: id or phone. If both or none
is used, then an error is returned.
nickname – (optional) client’s name. Works only if nickname is empty. To change existing client's name use сlients (PUT)
avatar – (optional) client’s avatar (direct url to a picture) to display in Chats section.
\nIn order this command to work you must have an external channel connected to your company. Contact administration.
\n","urlObject":{"path":["v1","messages","inbox"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"78bea85f-14a2-47ec-8489-02926b589296"},{"name":"messages/import","id":"24b16311-9206-4cb3-8ee2-b478530602a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"This method allows you to import messages (incoming, outgoing, attachments) that are not present in the C2D system (if the user corresponded before connecting the messenger in the C2D system).
\nMessages can be imported as an array, but you can send no more than 10 messages per request.
\nOnly one attachment can be passed in the application parameter and the attachment format is presented as a direct link to the file.
\nIn the event that the operator_id is not specified, the admin id is automatically substituted, while after import the dialog will not be translated to the admin.
client_id - unique client ID (required parameter).
\nchannel_id - the channel to which the device is connected (required parameter).
\ntransport - name of the transport for which messages are imported (required parameter).
\ntimestamp - the date of sending/receiving the message, by which all dialog messages are sorted (required parameter).
\ntext - the text of the message, context-dependent on the value of the attachment parameter:
\nattachment - array with attachments, context-dependent on the text parameter. If text is filled in, the parameter is mandatory. If the text is not filled in, it is not required. The parameter must contain a direct link to the resource. Only one attachment can be passed in the application parameter
\ntype - Message type (required parameter). Possible vakues \"autoreply\" \"to_client\" \"from_client\"
\noperator_id - the unique identifier of the author of the message, a context-dependent parameter from the value of the type parameter (optional parameter):
\nexternal_id - If you send message using an integration with another platform or CRM system, you can store id of the message in the external system in this field.
\n","urlObject":{"path":["v1","messages","import",""],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"d645dda2-d267-4076-a82c-e7ab3ab97dfb","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/1/transfer_to_group?group_id=1","description":"Arranges a dialog with the specified message to a group of operators (agents). One operator from the group will be chosen by the System in according with the rules specified in Settings > Operators > Groups > Rules of selecting specific operator from group.
\n","urlObject":{"path":["v1","messages","1","transfer_to_group"],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Id of an operators_groups (agents), on whom this message and corresponding dialog will be assigned. See operators_groups (GET).
\n","type":"text/plain"},"key":"group_id","value":"1"},{"disabled":true,"description":{"content":"Force-assign a chat bypassing all assignment rules (default: true).\nSet to false to apply standard assignment logic: operator online status, queues, and dialog limits.
\n","type":"text/plain"},"key":"force_assign","value":"{true, false}"}],"variable":[]}},"response":[{"id":"eb668b99-c72a-4b05-a912-e44b93bce9b8","name":"OK transfer_to_group","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/requests/165505634","description":"Returns an info about specified request (see TERMS for request).
\nUse requests/id/messages to get a list of request messages.
\n","urlObject":{"path":["v1","requests","165505634"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"2714e8e2-e300-420f-a62d-0390982340a7","name":"requests/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/requests/165505634/messages","description":"Returns a list of request messages (see TERMS for request).
\nUse requests/id to get an info about the request.
\n","urlObject":{"path":["v1","requests","165505634","messages"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"e098054a-e010-48a9-8ffd-b355f094285f","name":"requests/Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"request_id\": 165505634\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/requests/close","description":"Closes a request (see TERMS for request).
\nExample:\n{\"request_id\": 537136\nor\n\"client_id\": 37817}
\nToken from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/messages/Allows to change delivery status for outgoing message only for external channel.
\nPossible use case:
Client implemented integration with corporate mobile application using external channel.
• Message is sent to mobile application using messages (POST)
• Message is delivered to end user in mobile application
• Message is marked as delivered using messages (PUT)
Params:
• status – can be one of the following:
1 – pending;
2 – sent;
3 – failed;
5 – canceled;
6 – delivered;
7 - seen.
Working with messages and requests.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"53fd6533-2969-4c4d-a2ff-4040b7fd13de"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"139ea2dd-b2a2-4dc7-a7bc-026070a7f93b"}}],"_postman_id":"d170e873-15c9-412a-9c2a-a92ff616b293"},{"name":"Dialogs","item":[{"name":"dialogs","id":"bae63c1d-f11d-4e59-b013-9b3bea5c337d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/dialogs/","description":"Returns a list of your dialogs.
\nNote, that once an operator (agent) takes or is being assigned with a dialog with a client, the messages of the chat start to belong to this dialog.
\n","urlObject":{"path":["v1","dialogs",""],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"id of operator.
\n","type":"text/plain"},"key":"operator_id","value":null},{"disabled":true,"description":{"content":"state of dialog (open or closed).
\n","type":"text/plain"},"key":"state","value":""},{"disabled":true,"description":{"content":"order of records returned (asc or desc). Default is ascending order.
\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[{"id":"dfa264fc-65ff-4f62-b391-f071184e5ff4","name":"dialogs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/dialogs/18498876/","description":"Returns an info on a dialog specified.\n18498876 here is an example of dialog id.
\nNote, that once an operator (agent) takes or is being assigned with a dialog with a client, the messages of the chat start to belong to this dialog.
\n","urlObject":{"path":["v1","dialogs","18498876",""],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"50d1aea2-eef2-40fc-9513-3f648b7a2f62","name":"dialogs/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/dialogs/unanswered?limit=600","description":"Returns a list of overdue dialogs that are unanswered for specified period of seconds. Use it to track \"stuck\" chats with your clients.
\n","urlObject":{"path":["v1","dialogs","unanswered"],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Time in seconds after last client’s message after which a dialog is considered overdue. As you can see, here limit parameter replaces the number of records to return.
\n","type":"text/plain"},"key":"limit","value":"600"}],"variable":[]}},"response":[{"id":"fa8cfc20-3058-442d-9596-1a45ee83246d","name":"dialogs/unanswered","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"operator_id\": 221063,\n \"state\": \"closed\",\n \"initiator_id\": 2,\n \"force_assign\": \"true\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/dialogs/18498876","description":"Changes a dialog state and arranges it to an operator (agent).
\nExample:
{\"operator_id\": 1,
\"state\": \"open\" or \"closed\",
\"initiator_id\": 2,
\"force_assign\": \"true\" or \"false\"}
* initiator_id - (optional) You can specify the id of the operator who initiated the chat translation. If the parameter is not specified, the administrator is the initiator of the transfer
\n* force_assign - (optional) Force-assign a chat bypassing all assignment rules (default: true). Set to false to apply standard assigment logic: operator online status, queues, and dialog limits.
\n","urlObject":{"path":["v1","dialogs","18498876"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"64790e8e-8583-43b9-84f8-c40ec837b89f","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Working with dialogs (chats).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f7fa5126-1db0-461c-9c9a-333a4b95e260"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0075a73d-d73e-4ca7-ba93-84e020651336"}}],"_postman_id":"dde2655e-dbf9-4b2b-b8b3-d27998180c6f"},{"name":"Webhooks","item":[{"name":"webhooks","id":"90e3507e-6e7e-426e-ae61-6c1d16a6c75a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"javascript"}}},"url":"https://api.chat2desk.com/v1/webhooks","description":"Returns a list of your active webhooks.
\n","urlObject":{"path":["v1","webhooks"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"8625ffeb-b869-465e-9c6b-6f9fe194d94a","name":"webhooks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API token","description":"Token from Settings > API section (under admin account)."}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"javascript"}}},"url":"https://api.chat2desk.com/v1/webhooks"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 537680,\n \"name\": \"New name\",\n \"url\": \"https://yoursite.com/\",\n \"events\": [\n \"inbox\",\n \"outbox\",\n \"comment\"\n ],\n \"status\": \"enable\",\n \"errors\": [],\n \"source\": \"client\",\n \"channels\": [\n 1123,\n 5813\n ]\n }\n ],\n \"status\": \"success\"\n}"}],"_postman_id":"90e3507e-6e7e-426e-ae61-6c1d16a6c75a"},{"name":"webhooks/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/webhooks/5518","description":"Returns an info about specified webhook.
5518 here as an example of webhook id.
Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://yoursite.com/\",\r\n \"name\": \"My first web hook\",\r\n \"events\": [\r\n \"inbox\",\r\n \"outbox\",\r\n \"comment\"\r\n ],\r\n \"channels\": [\r\n 1123,\r\n 5813\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/webhooks","description":"Creates a new webhook for various events.
\nExample with events:
\n{\n \"url\": \"https://yoursite.com/\",\n \"name\": \"Webhook name\",\n \"events\": [\n \"inbox\",\n \"outbox\",\n \"outbox_status\",\n \"comment\",\n \"operator_status_changed\",\n \"operator_authentication_updated\",\n \"new_client\", \n \"new_tag\", \n \"new_request\",\n \"add_tag_to_client\",\n \"add_tag_to_request\",\n \"delete_tag_from_client\",\n \"delete_tag_from_request\",\n \"client_updated\",\n \"client_added_to_blacklist\",\n \"close_dialog\",\n \"close_request\",\n \"dialog_transferred\",\n \"device_updated\",\n \"new_ticket\",\n \"ticket_updated\",\n \"ticket_deleted\",\n \"new_qr_code\",\n \"ai_hints_requested\"\n ],\n \"channels\": [\n 1123,\n 5813\n ]\n}\n\nname: name of new webhook. Up to 5 simultaneous webhooks are allowed for free.
\nurl: URL on your server where the requests will come. Any URL is allowed but we recommend https. If empty value (null) is set then the
webhook will be deleted.
events: events list for which webhook will be triggered. See supported events in Webhooks description
\nchannels: list of channels through which you will receive events related to the channel (events for messages, dialogs, etc.). If omitted, events will be sent for all channels. Events not related to a channel (events for operators, client changes, etc.) will always be received.
\nToken from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://yoursite.com/\",\r\n \"name\": \"New name\",\r\n \"events\": [\"inbox\", \"outbox\"]\r\n }\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/webhooks/222421","description":"Updates specified webhook.
222421 here is an example of webhook id that you want to update – see webhooks (POST)
use this parameter if you want to\nactivate or deactivate existing wehhook. If omitted, webhook status will not be\nchanged
\n","type":"text/plain"},"key":"status","value":"enable/disable"}],"variable":[]}},"response":[],"_postman_id":"51d49f89-afdf-4584-887b-fd87b5dc19db"},{"name":"webhooks/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/webhooks/{id}","description":"Deletes specified webhook.
222421 here is an example of webhook id.
Working with webhooks. The System supports up to 5 simultaneous webhooks for free.
\nImportant! We resend unsuccessful webhook event 3 times: after 10 seconds, after 5 minutes and after 2 hours. In order to avoid overload, a webhook will be disabled if after 5 hours no respond of successful data acceptance was received. See Errors section for more details.
\n{\n \"message_id\": 115816153,\n \"type\": \"from_client\",\n \"text\": \"Hello!\",\n \"transport\": \"telegram\",\n \"client_id\": 30247382,\n \"operator_id\": null,\n \"dialog_id\": 4236638,\n \"channel_id\": 18337,\n \"photo\": null,\n \"coordinates\": null,\n \"audio\": null,\n \"pdf\": null,\n \"client\": {\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"client_phone\": \"\",\n \"name\": \"Ольга Шуст\",\n \"assigned_name\": null,\n \"external_id\": null\n },\n \"hook_type\": \"inbox\",\n \"request_id\": 8891565,\n \"attachments\": [],\n \"is_new_request\": true,\n \"is_new_client\": false,\n \"insta_comment\": false,\n \"extra_data\": {},\n \"is_new\": true,\n \"event_time\": \"2023-01-25T09:32:10.137860Z\"\n}\n\n{\n \"message_id\": 115816478,\n \"type\": \"to_client\",\n \"text\": \"How do you do ?\",\n \"transport\": \"telegram\",\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"dialog_id\": 4236638,\n \"channel_id\": 18337,\n \"photo\": null,\n \"coordinates\": null,\n \"audio\": null,\n \"pdf\": null,\n \"client\": {\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"client_phone\": \"\",\n \"name\": \"Ольга Шуст\",\n \"assigned_name\": null,\n \"external_id\": null\n },\n \"hook_type\": \"outbox\",\n \"request_id\": 8891565,\n \"attachments\": [],\n \"is_new_request\": false,\n \"is_new_client\": false,\n \"insta_comment\": false,\n \"extra_data\": {},\n \"is_new\": false,\n \"event_time\": \"2023-01-25T09:44:48.968258Z\"\n}\n\nmessages/inbox or received directly from messengers (WhatsApp, VK Direct, Telegram User). These messages do not trigger standard inbox/outbox webhooks or automations.{\n \"message_id\": 5015921655,\n \"type\": \"to_client\",\n \"text\": \"text import\",\n \"transport\": \"telegram\",\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"dialog_id\": 4236638,\n \"channel_id\": 18337,\n \"photo\": null,\n \"coordinates\": null,\n \"audio\": null,\n \"pdf\": null,\n \"client\": {\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"client_phone\": null,\n \"name\": \"Dariia \",\n \"assigned_name\": \"Dariia\",\n \"external_id\": null\n },\n \"hook_type\": \"imported_message\",\n \"request_id\": 8891565,\n \"attachments\": [],\n \"is_new_request\": false,\n \"is_new_client\": false,\n \"insta_comment\": false,\n \"extra_data\": {\n \"external_id\": \"3234\",\n \"imported\": true\n },\n \"is_new\": false,\n \"event_time\": \"2026-02-02T13:44:41.694809Z\"\n}\n\noutbox_status: an error was received by the System from the messenger provider when trying to send a message. For example, a message from operator was processed by the System and sent to WhatsApp Business API (WABA), but the WABA provider responded with error – timeout error -\"gateway_status\": \"failed\".
The possible gateway_status for the event:
pending
\nsent
\nfailed
\nscheduled
\ncanceled
\ndelivered
\nseen
\n{\n \"data\": {\n \"id\": 983574888,\n \"gateway_status\": \"sent\",\n \"created\": \"2021-06-10T17:38:04 MSK\",\n \"dialog_id\": 23544077,\n \"client_id\": 177597039,\n \"error\": null\n },\n \"hook_type\": \"outbox_status\",\n \"event_time\": \"2021-06-10T14:38:04Z\"\n}\n\n{\n \"message_id\": 115816454,\n \"type\": \"comment\",\n \"text\": \"Don't close\",\n \"transport\": \"telegram\",\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"dialog_id\": 4236638,\n \"channel_id\": 18337,\n \"photo\": null,\n \"coordinates\": null,\n \"audio\": null,\n \"pdf\": null,\n \"client\": {\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"client_phone\": \"\",\n \"name\": \"Ольга Шуст\",\n \"assigned_name\": \"misterbanana\",\n \"external_id\": null\n },\n \"hook_type\": \"comment\",\n \"request_id\": 8891565,\n \"attachments\": null,\n \"is_new_request\": false,\n \"is_new_client\": false,\n \"insta_comment\": false,\n \"extra_data\": {},\n \"event_time\": \"2023-01-25T09:43:12.494933Z\"\n}\n\n{\n \"id\": \"2325532\",\n \"email\": \"operator_email@mail.com\",\n \"online\": 0,\n \"offline_type\": \"busy\",\n \"status_id\": 1,\n \"hook_type\": \"operator_status_updated\",\n \"event_time\": \"2023-01-25T09:40:12.518169Z\"\n}\n\nlog out and log in. Example of data:{\n \"id\": 40818,\n \"email\": \"operator_email@mail.com\",\n \"event\": \"login\"/\"logout\",\n \"platform\": \"web\"/\"mobile\"\n \"event_time\": \"2023-01-25T09:40:12.518169Z\",\n \"hook_type\": \"operator_authentication_updated\",\n \"ip_address\": \"\"\n}\n\nclients (POST).{\n \"id\": 31074670,\n \"phone\": \"[tg] 7536765434\",\n \"name\": \"Nocolas\",\n \"avatar\": \"\",\n \"assigned_name\": null,\n \"comment\": null,\n \"region_id\": null,\n \"country_id\": null,\n \"extra_comment_1\": null,\n \"extra_comment_2\": null,\n \"extra_comment_3\": null,\n \"client_created\": \"2023-01-25T10:14:46 UTC\",\n \"client_updated\": \"2023-01-25T10:14:46 UTC\",\n \"channels\": [\n {\n \"id\": 18333,\n \"transports\": [\n \"telegram\"\n ]\n }\n ],\n \"tags\": [],\n \"client_source\": \"incoming_message\",\n \"hook_type\": \"new_client\",\n \"event_time\": \"2023-01-25T10:14:46.699087Z\"\n}\n\n{\n \"id\": 22114,\n \"label\": \"vip\",\n \"description\": \"vip client\",\n \"group_id\": 14779,\n \"group_name\": \"test\",\n \"hook_type\": \"new_tag\",\n \"event_time\": \"2023-01-25T10:03:48.266263Z\"\n}\n\n{\n \"request_id\": 8891565,\n \"client_id\": 30247382,\n \"dialog_id\": 4236638,\n \"created\": 1674639130,\n \"updated\": 1674639130,\n \"start_message_id\": 115816153,\n \"end_message_id\": null,\n \"type\": \"common\",\n \"channel_id\": 18337,\n \"transport\": \"telegram\",\n \"is_new_client\": false,\n \"starter\": \"other\",\n \"client\": {\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"name\": \"Ольга Шуст\",\n \"avatar\": \"https://storage.chat2desk.com/companies/clients/avatars/2023-1/5797f8bfca0befda2.jpg\",\n \"client_source\": null,\n \"assigned_name\": null,\n \"comment\": \"\",\n \"extra_comment_1\": null,\n \"client_phone\": \"\",\n \"extra_comment_2\": null,\n \"extra_comment_3\": null,\n \"channels\": {\n \"id\": 18337,\n \"transports\": [\n \"telegram\"\n ]\n },\n \"region_id\": null,\n \"country_id\": null,\n \"custom_fields\": {}\n },\n \"by_client\": true,\n \"hook_type\": \"new_request\",\n \"event_time\": \"2023-01-25T09:32:10.134614Z\"\n}\n\n{\n \"id\": 22113,\n \"name\": \"tag\",\n \"description\": \"taggg\",\n \"group_id\": 14779,\n \"group_name\": \"test\",\n \"client_id\": 30247382,\n \"channel_id\": 18337,\n \"transport\": \"telegram\",\n \"all_client_channels\": [\n 18337\n ],\n \"hook_type\": \"add_tag_to_client\",\n \"event_time\": \"2023-01-25T09:46:00.603275Z\"\n}\n\n{\n \"id\": 6385,\n \"name\": \"ABC1\",\n \"description\": \"My tag description\",\n \"group_id\": 1128,\n \"group_name\": \"группа тегов\",\n \"client_id\": 29030799,\n \"request_id\": 8705737,\n \"channel_id\": 17320,\n \"transport\": \"insta_local\",\n \"hook_type\": \"add_tag_to_request\",\n \"event_time\": \"2023-01-25T12:06:00.603275Z\"\n}\n\n{\n \"id\": 6385,\n \"name\": \"ABC1\",\n \"description\": \"My tag description\",\n \"group_id\": 1128,\n \"group_name\": \"группа тегов\",\n \"client_id\": 29030799,\n \"hook_type\": \"delete_tag_from_client\",\n \"event_time\": \"2023-01-06T08:19:06Z\"\n}\n\n{\n \"id\": 6385,\n \"name\": \"ABC1\",\n \"description\": \"My tag description\",\n \"group_id\": 1128,\n \"group_name\": \"группа тегов\",\n \"request_id\": 8705737,\n \"hook_type\": \"delete_tag_from_request\",\n \"event_time\": \"2023-01-25T09:46:00.603275Z\"\n}\n\n{\n \"id\": 30247382,\n \"phone\": \"[tg] 734937551\",\n \"name\": \"Ольга Шуст\",\n \"avatar\": \"https://storage.chat2desk.com/companies/clients/avatars/2023-1/5797f8bfca0befda2.jpg\",\n \"client_source\": null,\n \"assigned_name\": null,\n \"comment\": \"VIP\",\n \"extra_comment_1\": null,\n \"client_phone\": \"+73456789009\",\n \"extra_comment_2\": null,\n \"extra_comment_3\": null,\n \"channels\": {\n \"id\": null,\n \"transports\": [\n null\n ]\n },\n \"region_id\": null,\n \"country_id\": null,\n \"custom_fields\": {},\n \"hook_type\": \"client_updated\",\n \"event_time\": \"2023-01-25T09:40:12.518169Z\"\n}\n\nclient_added_to_blacklist: a client was added / removed to/from blacklist
\n{\n \"id\": 97370263,\n \"phone\": \"[chat] c78b4ab2e85c4c9f601e\",\n \"name\": null,\n \"avatar\": null,\n \"assigned_name\": null,\n \"comment\": null,\n \"region_id\": null,\n \"country_id\": null,\n \"extra_comment_1\": null,\n \"extra_comment_2\": null,\n \"extra_comment_3\": null,\n \"client_created\": \"2024-04-26T07:57:40 UTC\",\n \"client_updated\": \"2024-04-26T07:57:40 UTC\",\n \"tags\": [],\n \"is_blocked\": true,\n \"hook_type\": \"client_added_to_blacklist\",\n \"event_time\": \"2024-04-26T08:50:18.801711Z\"\n}\n\n{\n \"dialog_id\": 4236638,\n \"request_id\": 8891506,\n \"created\": 1674636968,\n \"updated\": 1674638907,\n \"channel_id\": 18337,\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"current_operator_id\": 40818,\n \"transport\": \"telegram\",\n \"hook_type\": \"close_dialog\",\n \"event_time\": \"2023-01-25T09:28:27.111923Z\"\n}\n\n{\n \"dialog_id\": 4236638,\n \"request_id\": 8891506,\n \"created\": 1674636968,\n \"updated\": 1674638907,\n \"channel_id\": 18337,\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"transport\": \"telegram\",\n \"end_message_id\": 115816049,\n \"hook_type\": \"close_request\",\n \"event_time\": \"2023-01-25T09:28:27.106220Z\"\n}\n\n{\n \"dialog_id\": 4236638,\n \"request_id\": 8891565,\n \"created\": 1674636968,\n \"updated\": 1674639504,\n \"channel_id\": 18337,\n \"client_id\": 30247382,\n \"operator_id\": 40818,\n \"current_operator_id\": 40818,\n \"transport\": \"telegram\",\n \"last_operator_id\": null,\n \"scenario_id\": null,\n \"hook_type\": \"dialog_transferred\",\n \"event_time\": \"2023-01-25T09:38:24.422610Z\"\n}\n\n{\n \"transport\": \"telegram\",\n \"channel_id\": 17313,\n \"hook_type\": \"device_update\",\n \"status\": \"Created\",\n \"event_time\": \"2021-12-06T07:59:37Z\"\n}\n\n{\n \"qrcode_data\": \"OxrhCyoevcoool+z5GKz5GKz5GKz5GK\nz5GK\",\n \"qrcode_image\":\n \"data:image/png;base64,iVBORw0KG…=\",\n \"phone\": 1630507770,\n \"device_owner\": \"client\",\n \"hook_type\": \"new_qr_code\",\n \"event_time\": \"2023-01-25T09:43:12.494933Z\"\n}\n\n{\n \"hook_type\": \"ticket_created\",\n \"timestamp\": \"2024-06-18T12:00:00Z\",\n \"ticket\": {\n \"id\": \"TICK-2\",\n \"reporter_id\": 110889,\n \"assignee_id\": 12321,\n \"summary\": \"Non-compliance with the Pantone color palette\",\n \"description\": \"A large batch of Malibu Blue paint did not comply with the color palette. The paint had a maroon tint.\",\n \"status\": 1,\n \"priority\": 2,\n \"deadline\": \"2005-07-19T12:00:00Z\",\n \"request_ids\": [\n \"49284\",\n \"443556\"\n ],\n \"created_at\": \"1956-01-03T10:00:00Z\",\n \"updated_at\": \"1995-05-18T11:00:00Z\"\n }\n}\n\n{\n \"hook_type\": \"ticket_updated\",\n \"timestamp\": \"1995-05-18T11:00:00Z\",\n \"ticket\": {\n \"id\": \"TICK-1\",\n \"reporter_id\": 12321,\n \"updater_id\": \"Public API\",\n \"assignee_id\": 443556,\n \"summary\": \"URGENT Delivery problem\",\n \"description\": \"Problem with delivery with package 49284 to Mel Gibson and Sophie Marceau\",\n \"status\": 2,\n \"priority\": 3,\n \"deadline\": \"2005-07-10T12:00:00Z\",\n \"request_ids\": [\n \"5813\",\n \"2134\"\n ],\n \"created_at\": \"1956-01-03T10:00:00Z\",\n \"updated_at\": \"1995-05-18T11:00:00Z\"\n },\n \"updates\": {\n \"update_summary\": \"Delivery problem -> URGENT Delivery problem\",\n \"update_description\": \"Problem with delivery with package 49284 to Mel Gibson -> Problem with delivery with package 49284 to Mel Gibson and Sophie Marceau\",\n \"update_status\": \"1 → 2\",\n \"update_priority\": \"2 → 3\",\n \"update_assignee\": \"12321 → 443556\",\n \"update_deadline\": \"2005-07-19 → 2005-07-10\",\n \"attach_requests\": \"[2134]\",\n \"detach_requests\": \"[1123]\"\n }\n}\n\n{\n \"hook_type\": \"ticket_deleted\",\n \"timestamp\": \"2005-07-11T11:00:00Z\",\n \"id\": \"1\",\n \"ticket\": {\n \"id\": \"TICK-1\",\n \"reporter_id\": 12321,\n \"updater_id\": \"Public API\",\n \"assignee_id\": 443556,\n \"summary\": \"URGENT Delivery problem\",\n \"description\": \"Problem with delivery with package 49284 to Mel Gibson and Sophie Marceau\",\n \"status\": 2,\n \"priority\": 3,\n \"deadline\": \"2005-07-10T12:00:00Z\",\n \"request_ids\": [\n \"5813\",\n \"2134\"\n ],\n \"created_at\": \"1956-01-03T10:00:00Z\",\n \"updated_at\": \"1995-05-18T11:00:00Z\"\n },\n \"deleted by\": \"12321\"/\"Public API\"\n}\n\nai_hints_requested: this webhook is for AI (Artificial Intelligence) provider and used in 2 ways:
\nAn operator (agent) or the System requested AI hints (suggestions) in prompter mode. Hints (suggestions) from AI provider are expected in return. To understand the context the provider should have all
messages using webhooks inbox and outbox events.
Example of data:
{\"client_id\": 11910, \"operator_id\": 1, \"dialog_id\": 331, \"request_id\": 2343, \"channel_id\": 1, \"message_id\": 8205 [event_time] => 2022-07-28T23:01:40Z}
In return, AI provider should send hints (suggestions) in the following format:
\"message_id\": 8205, \"hints\": [{\"id\": 1, \"text\": \"answer 1\", \"url\": \"\", \"relevance\": 90, \"link\": \"\"},{\"id\": 2, \"text\": \"answer 2\", \"url\": \"\", \"relevance\": 97, \"link\": \"\"}]
An operator (agent) has chosen one AI hint from the list above. Used to teach AI engine on correct answers.
Example of data:
{\n \"client_id\": 11910, \n \"message_id\": 8205, \n \"hint_id\": 2, \n \"hook_type\": \"ai_hints_requested\",\n \"event_time\": 2022-07-28T23:01:40Z\n}\n\nTo ensure that webhook events are coming from a trusted source and have not been tampered with, we use HMAC-based signature verification.
\nEach webhook request contains the following headers:
\nX-Signature — the HMAC signature (hex-encoded)
X-Timestamp — a UNIX timestamp (seconds since epoch)
To verify the request, the recipient should:
\nsignature_data = raw_body+X-Timestamp
Generate HMAC-SHA256 using a secret key:
\nThe key is your API token, hashed with MD5.
\nThe algorithm used is HMAC with SHA-256.
\nCompare the computed signature with the value of the X-Signature header.
If the signatures match, the request is considered valid.
\ndef verify_signature(data, timestamp, received_signature)\n secret = \"md5_api_token\"\n json_data_with_timestamp = data + timestamp\n digest = OpenSSL::Digest.new('sha256')\n calculated_signature = OpenSSL::HMAC.hexdigest(digest, secret, json_data_with_timestamp)\n calculated_signature == received_signature\nend\ndata = '{\"message_id\":28780,\"type\":\"from_client\",\"text\":\"test7\",\"transport\":\"widget\",\"client_id\":12568,\"operator_id\":null,\"dialog_id\":942,\"channel_id\":1,\"photo\":null,\"coordinates\":null,\"audio\":null,\"pdf\":null,\"client\":{\"id\":12568,\"phone\":\"[chat] 1d0bb2e221762cfcc05c\",\"client_phone\":null,\"name\":\"[chat] 1d0bb2e221762cfcc05c\",\"assigned_name\":null,\"external_id\":null},\"hook_type\":\"inbox\",\"request_id\":5357,\"attachments\":[],\"is_new_request\":false,\"is_new_client\":false,\"insta_comment\":false,\"extra_data\":{},\"is_new\":true,\"event_time\":\"2025-04-03T11:50:06.984494Z\"}'\ntimestamp = \"1743681006\"\nreceived_signature = \"88b574d8237e1b7740f88102018b734d3dd5bc6803c509a3694eff9721b0c595\"\nverify_signature(data, timestamp, received_signature)\n\ndefmodule WebhookValidator do\n def verify_signature(data, timestamp, received_signature) do\n json_data_with_timestamp = data <> timestamp\n secret = \"md5_api_token\"\n calculated_signature =\n :crypto.mac(:hmac, :sha256, secret, json_data_with_timestamp)\n |> Base.encode16(case: :lower)\n calculated_signature == received_signature\n end\nend\ndata = \"{\\\"message_id\\\":28780,\\\"type\\\":\\\"from_client\\\",\\\"text\\\":\\\"test7\\\",\\\"transport\\\":\\\"widget\\\",\\\"client_id\\\":12568,\\\"operator_id\\\":null,\\\"dialog_id\\\":942,\\\"channel_id\\\":1,\\\"photo\\\":null,\\\"coordinates\\\":null,\\\"audio\\\":null,\\\"pdf\\\":null,\\\"client\\\":{\\\"id\\\":12568,\\\"phone\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"client_phone\\\":null,\\\"name\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"assigned_name\\\":null,\\\"external_id\\\":null},\\\"hook_type\\\":\\\"inbox\\\",\\\"request_id\\\":5357,\\\"attachments\\\":[],\\\"is_new_request\\\":false,\\\"is_new_client\\\":false,\\\"insta_comment\\\":false,\\\"extra_data\\\":{},\\\"is_new\\\":true,\\\"event_time\\\":\\\"2025-04-03T11:50:06.984494Z\\\"}\"\ntimestamp = \"1743681006\"\nreceived_signature = \"88b574d8237e1b7740f88102018b734d3dd5bc6803c509a3694eff9721b0c595\"\nWebhookValidator.verify_signature(data, timestamp, received_signature)\n\nfunction verify_signature($data, $timestamp, $received_signature) {\n $secret = \"md5_api_token\";\n $json_data_with_timestamp = $data . $timestamp;\n $calculated_signature = hash_hmac('sha256', $json_data_with_timestamp, $secret);\n return $calculated_signature === $received_signature;\n}\n$data = \"{\\\"message_id\\\":28780,\\\"type\\\":\\\"from_client\\\",\\\"text\\\":\\\"test7\\\",\\\"transport\\\":\\\"widget\\\",\\\"client_id\\\":12568,\\\"operator_id\\\":null,\\\"dialog_id\\\":942,\\\"channel_id\\\":1,\\\"photo\\\":null,\\\"coordinates\\\":null,\\\"audio\\\":null,\\\"pdf\\\":null,\\\"client\\\":{\\\"id\\\":12568,\\\"phone\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"client_phone\\\":null,\\\"name\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"assigned_name\\\":null,\\\"external_id\\\":null},\\\"hook_type\\\":\\\"inbox\\\",\\\"request_id\\\":5357,\\\"attachments\\\":[],\\\"is_new_request\\\":false,\\\"is_new_client\\\":false,\\\"insta_comment\\\":false,\\\"extra_data\\\":{},\\\"is_new\\\":true,\\\"event_time\\\":\\\"2025-04-03T11:50:06.984494Z\\\"}\";\n$timestamp = \"1743681006\";\n$received_signature = \"88b574d8237e1b7740f88102018b734d3dd5bc6803c509a3694eff9721b0c595\";\nif (verify_signature($data, $timestamp, $received_signature)) {\n echo \"Signature is valid.\";\n} else {\n echo \"Signature is invalid.\";\n}\n\nconst crypto = require('crypto');\nfunction verifySignature(data, timestamp, receivedSignature) {\n const secret = \"md5_api_token\"; \n const jsonDataWithTimestamp = data + timestamp;\n const calculatedSignature = crypto\n .createHmac('sha256', secret)\n .update(jsonDataWithTimestamp)\n .digest('hex');\n return calculatedSignature === receivedSignature;\n}\nconst data = \"{\\\"message_id\\\":28780,\\\"type\\\":\\\"from_client\\\",\\\"text\\\":\\\"test7\\\",\\\"transport\\\":\\\"widget\\\",\\\"client_id\\\":12568,\\\"operator_id\\\":null,\\\"dialog_id\\\":942,\\\"channel_id\\\":1,\\\"photo\\\":null,\\\"coordinates\\\":null,\\\"audio\\\":null,\\\"pdf\\\":null,\\\"client\\\":{\\\"id\\\":12568,\\\"phone\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"client_phone\\\":null,\\\"name\\\":\\\"[chat] 1d0bb2e221762cfcc05c\\\",\\\"assigned_name\\\":null,\\\"external_id\\\":null},\\\"hook_type\\\":\\\"inbox\\\",\\\"request_id\\\":5357,\\\"attachments\\\":[],\\\"is_new_request\\\":false,\\\"is_new_client\\\":false,\\\"insta_comment\\\":false,\\\"extra_data\\\":{},\\\"is_new\\\":true,\\\"event_time\\\":\\\"2025-04-03T11:50:06.984494Z\\\"}\";\nconst timestamp = \"1743681006\";\nconst receivedSignature = \"88b574d8237e1b7740f88102018b734d3dd5bc6803c509a3694eff9721b0c595\";\nverifySignature(data, timestamp, receivedSignature)\n\nTo test your webhoook you can use this service: https://webhook.site/
\nImportant! Do not forget to change your webhook URL after testing.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fd48af25-7842-46a7-8b99-4ec44abe4e86"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"89bcfd2a-debe-484b-a4b1-1f2572f0d075"}}],"_postman_id":"c156e2a3-3e11-44dd-8ad7-852cd6cf7740"},{"name":"Operators & Access rights","item":[{"name":"operators","id":"ab521470-bb04-4b23-b7e9-4fb243d5cc65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/operators/","description":"Returns a list of your operators (agents) in the System.
\n","urlObject":{"path":["v1","operators",""],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Phone number of operator.
\n","type":"text/plain"},"key":"phone","value":""},{"disabled":true,"description":{"content":"Email of operator.
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"Operator is considered online (online = 1) if he or she if logged in in\nany status. If an operator manually logs out or the system turns him or her offline\nbecause of inactivity, online becomes 0.
\n","type":"text/plain"},"key":"online","value":""},{"disabled":true,"description":{"content":"Id of operator’s status (see GET operators/statuses)
\n","type":"text/plain"},"key":"status_id","value":""},{"disabled":true,"description":{"content":"Shows operators who cannot receive new chats (true) or who can receive new chats (false).
\n","type":"text/plain"},"key":"disableNewChats","value":null},{"disabled":true,"description":{"content":"Operators role in the chat center (for example: operator or supervisor).
\n","type":"text/plain"},"key":"role","value":null}],"variable":[]}},"response":[{"id":"59a27a84-a1b4-4a1e-b7d3-0b1bfecb8048","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.chat2desk.com/v1/operators/?email=&access_rights_id&first_name&last_name&status_id=","description":"Creates a new operator (agent) in the System.
\n","urlObject":{"path":["v1","operators",""],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Email of operator.
\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"Access rights ID. Defines operator role in the chat center. Can be Supervisor, Operator, or a custom role (see GET Access rights).
\n","type":"text/plain"},"key":"access_rights_id","value":null},{"disabled":true,"description":{"content":"Operator avatar. Specify a publicly available image URL.
\n","type":"text/plain"},"key":"avatar","value":null},{"disabled":true,"description":{"content":"External system operator identifier. If you have an operator in another platform or CRM system, you can save the operator ID in the external system in this field.
\n","type":"text/plain"},"key":"external_id","value":null},{"description":{"content":"First name of operator.
\n","type":"text/plain"},"key":"first_name","value":null},{"description":{"content":"Last name of operator.
\n","type":"text/plain"},"key":"last_name","value":null},{"description":{"content":"Id of operator’s status (see GET operators/statuses).
\n","type":"text/plain"},"key":"status_id","value":""}],"variable":[]}},"response":[{"id":"b0735b5e-011e-41dd-9c7c-929caaaa9575","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.chat2desk.com/v1/operators/:id","description":"Returns a list of your operators (agents) in the System.
\n","urlObject":{"path":["v1","operators",":id"],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Email of operator.
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"Access rights ID. Defines operator role in the chat center. Can be Supervisor, Operator, or a custom role (see GET Access rights).
\n","type":"text/plain"},"key":"access_rights_id","value":null},{"disabled":true,"description":{"content":"Operator avatar. Specify a publicly available image URL.
\n","type":"text/plain"},"key":"avatar","value":""},{"disabled":true,"description":{"content":"External system operator identifier. If you have an operator in another platform or CRM system, you can save the operator ID in the external system in this field.
\n","type":"text/plain"},"key":"external_id","value":""},{"disabled":true,"description":{"content":"First name of operator.
\n","type":"text/plain"},"key":"first_name","value":null},{"disabled":true,"description":{"content":"Last name of operator.
\n","type":"text/plain"},"key":"last_name","value":null},{"disabled":true,"description":{"content":"Id of operator’s status (see GET operators/statuses).
\n","type":"text/plain"},"key":"status_id","value":""}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"1b21f916-b9cc-4bfb-b6f4-31341370d4e3","name":"Successful Response","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/operators/statuses","description":"Returns a list of available operators’ working statuses.
\n","urlObject":{"path":["v1","operators","statuses"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"af32cd41-770e-463d-854c-ebeaa14fc479","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/operators_groups","description":"Returns a list of operator groups in the System. For operators groups see Settings > Operators section on the site.
\n","urlObject":{"path":["v1","operators_groups"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"a92afd0f-097d-4257-9421-0c91c2ff8cfc","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.chat2desk.com/v1/access_rights","description":"Returns a list of your operators (agents) in the System.
\n","urlObject":{"path":["v1","access_rights"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"4e05bda9-76a8-4d56-9378-3665c46a92b6","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.chat2desk.com/v1/access_rights/:id","description":"Returns a list of your operators (agents) in the System.
\n","urlObject":{"path":["v1","access_rights",":id"],"host":["https://api.chat2desk.com"],"query":[],"variable":[{"id":"a1aac853-78e6-472c-bcba-d3046a9b7eed","type":"any","value":"","key":"id"}]}},"response":[{"id":"a9e274d4-a460-4b82-ace7-004fa57f6ae3","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Working with operators (agents) and Access rights.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"71497a8f-1a63-4fbd-b230-adc2e1bdbfc7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"dffb3b5a-181f-41d8-adb3-8db541c79b95"}}],"_postman_id":"dc3c3a54-0cd0-4182-848c-a2ef5d42c528"},{"name":"Tags","item":[{"name":"tags","id":"4679eb81-5d87-4804-ade2-609dca8302bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Get this token in Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/tags/","description":"Returns a list of your tags with their info like label, description and tag group. These tags can be applied both to clients and to requests (see TERMS for request).
\n","urlObject":{"path":["v1","tags",""],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"b6e728bb-ff93-4f8e-bcbc-0c24d319b25f","name":"tags","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Get this token in Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/tags/103429","description":"Returns an info on a tag specified. 103429 here is an example of tag id.
\n","urlObject":{"path":["v1","tags","103429"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"883b3569-ff54-4de5-91f7-7d6d300e4f69","name":"tags/Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{ \n \"tag_group_id\": 1,\n \"tag_label\": \"ABC1\",\n \"tag_description\": \"My tag description\",\n \"tag_bg_color\": \"5b9ee6\",\n \"tag_text_color\": \"ffffff\",\n \"order_show\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/tags","description":"Creates a new tag. Tags can also be created manually on the site in Settings > Tags section.
\nExample:\n{\n\"tag_group_id\": 1,\n\"tag_label\": \"ABC1\",\n\"tag_description\": \"My tag description\",\n\"tag_bg_color\": \"5b9ee6\",\n\"tag_text_color\": \"ffffff\",\n\"order_show\": 5\n}
\nToken from Settings > API section (under admin account).
\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tag_ids\": [103429,103430],\n \"assignee_type\": \"request\",\n \"assignee_id\": \"165505634\"\n}"},"url":"https://api.chat2desk.com/v1/tags/assign_to","description":"Assigns one or more tags to a client or a request.
\nExample:
{
\"tag_ids\": [1,2],
\"assignee_type\": \"client\" or \"request\",
\"assignee_id\": \"1020\"
}
tags (GET).Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"tag_group_name\": \"Tags group 1\",\n \"order_show\": 1,\n \"display\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/tag_groups","description":"Creates a new tag group. Tag groups can also be created manually on the site in Settings > Tags section.
\nExample:\n{\n\"tag_group_name\": \"Name of the group\"\n\"order_show\": 5,\n\"display\": 0 or 1\n}
\nToken from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"request_id\": 165505634\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/tags/103429/delete_from","description":"Deletes a tag from a client or a request. The tag is not deleted from the available tags list.
\nExample:\n{\n\"client_id\": 1020\nor\n\"request_id\": 627172\n}
\nWorking with client's and request's tags.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e1415c4a-ecf0-48da-b429-e0a454e911ba"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a1776567-7575-4ade-9fec-65a16a10afb7"}}],"_postman_id":"b8b7af3c-7845-462b-8a91-a652e7c491bb"},{"name":"Tickets","item":[{"name":"tickets","id":"39c6cc2c-4938-4f8e-973f-b6fe3534623a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/tickets/","description":"Returns a list of your tickets with their info. You can filter the list of tickets by reporter, assignee, status priority and request.
\nSome fields in response:
\n","urlObject":{"path":["v1","tickets",""],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Ticket status, number from 1 to 4 (see /v1/help/tickets)
\n","type":"text/plain"},"key":"status","value":"1"},{"disabled":true,"description":{"content":"Ticket priority, number from 1 to 3 (see /v1/help/tickets)
\n","type":"text/plain"},"key":"priority","value":"2"},{"disabled":true,"description":{"content":"ID of the operator assigned for the ticket
\n","type":"text/plain"},"key":"assignee_id","value":"110889"},{"disabled":true,"description":{"content":"ID of the operator who last modified the ticket
\n","type":"text/plain"},"key":"updater_id","value":"110889"},{"disabled":true,"description":{"content":"ID of the operator who created the ticket
\n","type":"text/plain"},"key":"reporter_id","value":"12321"},{"disabled":true,"description":{"content":"ID of request linked to the ticket, only one allowed
\n","type":"text/plain"},"key":"request_id","value":"49284"},{"disabled":true,"description":{"content":"Order of records returned (asc, desc). Default is ascending order.
\n","type":"text/plain"},"key":"order","value":"asc"},{"disabled":true,"description":{"content":"Number of records returned. Default is 20, maximum is 200.
\n","type":"text/plain"},"key":"limit","value":"40"},{"disabled":true,"description":{"content":"Offset from the 1st record of the list. Default is 0.
\n","type":"text/plain"},"key":"offset","value":"80"}],"variable":[]}},"response":[{"id":"1ae0e82c-0976-4184-ae60-e79418b60572","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API token","description":"Token from Settings > API section (under admin account)."}],"url":{"raw":"https://api.chat2desk.com/v1/tickets/","protocol":"https","host":["api","chat2desk","com"],"path":["v1","tickets",""],"query":[{"key":"status","value":"1","description":"Ticket status, number from 1 to 4 (see /v1/help/tickets)","disabled":true},{"key":"priority","value":"2","description":"Ticket priority, number from 1 to 3 (see /v1/help/tickets)","disabled":true},{"key":"assignee_id","value":"110889","description":"ID of the operator assigned for the ticket","disabled":true},{"key":"updater_id","value":"110889","description":"ID of the operator who last modified the ticket","type":"text","disabled":true},{"key":"reporter_id","value":"12321","description":"ID of the operator who created the ticket","disabled":true},{"key":"request_id","value":"49284","description":"ID of request linked to the ticket, only one allowed","type":"text","disabled":true},{"key":"order","value":"asc","description":"Order of records returned (asc, desc). Default is ascending order.","disabled":true},{"key":"limit","value":"40","description":"Number of records returned. Default is 20, maximum is 200.","type":"text","disabled":true},{"key":"offset","value":"80","description":"Offset from the 1st record of the list. Default is 0.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"TICK-1\",\n \"deadline\": \"2005-07-19T12:00:00Z\",\n \"summary\": \"Delivery problem\",\n \"description\": \"Problem with delivery with package 49284 to Mel Gibson\",\n \"status\": 1,\n \"priority\": 2,\n \"created_at\": \"1956-01-03T10:00:00Z\",\n \"updated_at\": \"1995-05-18T11:00:00Z\",\n \"assignee_id\": 110889,\n \"updater_id\": 110889,\n \"reporter_id\": 12321,\n \"request_ids\": [\n \"49284\",\n \"443556\"\n ]\n },\n {\n \"id\": \"TICK-2\",\n \"deadline\": \"2005-07-19T12:00:00Z\",\n \"summary\": \"Non-compliance with the Pantone color palette\",\n \"description\": \"A large batch of Malibu Blue paint did not comply with the color palette. The paint had a maroon tint.\",\n \"status\": 1,\n \"priority\": 2,\n \"created_at\": \"1956-01-03T10:00:00Z\",\n \"updated_at\": \"1995-05-18T11:00:00Z\",\n \"assignee_id\": 12321,\n \"updater_id\": 12321,\n \"reporter_id\": 110889,\n \"request_ids\": [\n \"49284\",\n \"443556\"\n ]\n }\n ],\n \"meta\": {\n \"total\": 2,\n \"limit\": 20,\n \"offset\": 0\n },\n \"status\": \"success\"\n}"},{"id":"be1ddbf6-5237-4e79-b379-5b4381356ad4","name":"Unsuccessful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"API token","description":"Token from Settings > API section (under admin account)."}],"url":{"raw":"https://api.chat2desk.com/v1/tickets/?priority=Urgent&status=To do&assignee_id=Catherine&reporter_id=Sophie&updater_id=Mel&request_id=49284, 443556&order=positive&limit=201&offset=next","protocol":"https","host":["api","chat2desk","com"],"path":["v1","tickets",""],"query":[{"key":"priority","value":"Urgent","description":"Ticket status, number from 1 to 4 (see /v1/help/tickets)"},{"key":"status","value":"To do","description":"Ticket priority, number from 1 to 3 (see /v1/help/tickets)"},{"key":"assignee_id","value":"Catherine","description":"ID of the operator assigned for the ticket"},{"key":"reporter_id","value":"Sophie","description":"ID of the operator who created the ticket"},{"key":"updater_id","value":"Mel","description":"ID of the operator who last modified the ticket"},{"key":"request_id","value":"49284, 443556","description":"ID of request linked to the ticket, only one allowed"},{"key":"order","value":"positive","description":"Order of records returned (asc, desc). Default is ascending order."},{"key":"limit","value":"201","description":"Number of records returned. Default is 20, maximum is 200."},{"key":"offset","value":"next","description":"Offset from the 1st record of the list. Default is 0."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"bad_request\",\n \"errors\": {\n \"reporter_id\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"updater_id\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"assignee_id\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"priority\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"status\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"request_id\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"order\": [\n {\n \"text\": \"Only 'asc' or 'desc' are allowed.\",\n \"error\": \"invalid_filter_and_sorting_params\"\n }\n ],\n \"limit\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"unsupported_value\"\n }\n ],\n \"offset\": [\n {\n \"text\": \"Parameter must be a numeric value.\",\n \"error\": \"invalid_filter_and_sorting_params\"\n }\n ],\n \"id\": [\n {\n \"text\": \"Parameter 'id' cannot be specified. Use /v1/tickets/Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/tickets/2","description":"Returns a list of your tickets with their info. You can filter the list of tickets by reporter, assignee, status priority and request.
\nSome fields in response:
\n","urlObject":{"path":["v1","tickets","2"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"d80d9474-3665-4efb-9a5e-3beb7a2f9490","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"summary\": \"Delivery problem\",\n \"description\": \"Problem with delivery with package 49284 to Mel Gibson\",\n \"priority\": 2,\n \"assignee_id\": 110889,\n \"reporter_id\": 197136,\n \"deadline\": \"2005-07-19T12:00:00Z\",\n \"request_ids\": [\n \"49284\",\n \"443556\"\n ],\n \"status\": 1\n}\n\n/*\n \"summary\" — Ticket title (up to 255 characters)\n \"description\" — Ticket description\n \"priority\" — Ticket priority. Check /v1/help/tickets in Data types and values for available values\n \"assignee_id\" — (Optional) ID of the operator who will be assigned for the ticket\n \"reporter_id\" — (Optional) ID of the operator by whom the ticket will be created. If ommited, Administrator will be used.\n \"deadline\" — (Optional) Deadline date and time in ISO 8601 format\n \"issue_ids\" — (Optional) Array of request IDs which will be linked to the ticket\n \"status\" — (Optional) Ticket status. Check /v1/help/tickets in Data types and values for available values. If omitted, \"To do\" will be used.\n*/","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/tickets/","description":"Returns a list of your tickets with their info. You can filter the list of tickets by reporter, assignee, status priority and request.
\nSome fields in response:
\n","urlObject":{"path":["v1","tickets",""],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"43542f81-19bb-4c6e-9037-944d22f894c4","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"summary\": \"URGENT Delivery problem\",\n \"description\": \"Problem with delivery with package 49284 to Mel Gibson and Sophie Marceau\",\n \"priority\": 2,\n \"assignee_id\": 443556,\n \"deadline\": \"2005-07-19T12:00:00Z\",\n \"request_ids\": [\n \"1123\",\n \"5813\",\n \"2134\"\n ],\n \"status\": 2\n}\n\n\n/*\n \"summary\" — Ticket title (up to 255 characters)\n \"description\" — Ticket description\n \"priority\" — Ticket priority. Check /v1/help/tickets in Data types and values for available values\n \"assignee_id\" — (Optional) ID of the operator who will be assigned for the ticket\n \"deadline\" — (Optional) Deadline date and time in ISO 8601 format\n \"issue_ids\" — (Optional) Array of request IDs which will be linked to the ticket\n \"status\" — (Optional) Ticket status. Check /v1/help/tickets in Data types and values for available values. If omitted, \"To do\" will be used.\n*/","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/tickets/Returns a list of your tickets with their info. You can filter the list of tickets by reporter, assignee, status priority and request.
\nSome fields in response:
\n","urlObject":{"path":["v1","tickets","Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/tickets/2","description":"Deletes specified webhook.
222421 here is an example of webhook id.
Working with Tickets
\n","_postman_id":"950efef1-40eb-47aa-936a-4eff7d43ce01"},{"name":"Templates","item":[{"name":"templates","id":"c8734159-606e-4913-8b48-3d4ee12c7ac0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[{"id":"07de73b5-dfdc-4efa-bf0a-b6917efe9b3e","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.chat2desk.com/v1/templates/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"shortcut\": \"universe\",\n \"text\": \"42\",\n \"name\": \"Ultimate Question\",\n \"file\": \"https://upload.wikimedia.org/wikipedia/commons/5/56/Answer_to_Life.png\",\n \"group_id\": 1,\n \"type\": \"common\",\n \"user_id\": null,\n \"created\": \"1979-10-12T20:29:36 UTC\"\n },\n {\n \"id\": 2,\n \"shortcut\": \"off\",\n \"text\": \"Have you tried turning it off and on again?\",\n \"name\": \"first question\",\n \"file\": \"https://cdn.comedy.co.uk/images/library/people/180x200/t/the_it_crowd_roy.jpg\",\n \"group_id\": 1,\n \"type\": \"common\",\n \"user_id\": null,\n \"created\": \"2006-02-03T16:57:00 UTC\"\n }\n ],\n \"meta\": {\n \"total\": 2,\n \"limit\": 20,\n \"offset\": 0\n },\n \"status\": \"success\"\n}"}],"_postman_id":"c8734159-606e-4913-8b48-3d4ee12c7ac0"},{"name":"templates/Шаблон не может одновременно принадлежать пользователю и быть в группе
\n","urlObject":{"path":["v1","templates"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"c6eddee7-c620-4a76-9c54-4616812beea4","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Шаблон не может одновременно принадлежать пользователю и быть в группе
\n","urlObject":{"path":["v1","templates","1"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c2ce7e3-f031-4750-9b24-36248b357a8a"},{"name":"templates/Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[],"_postman_id":"ba313939-5b1e-4f44-aa75-fd2f974232c2"},{"name":"templates_groups/Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"channel_id\": 44413\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/scenarios/menu_items","description":"Returns a list of available self-service menu items. Self-service menu is a set of commands which your client can select in messenger to receive predefined replies. In messengers that support buttons, the menu can be shown using them. See Settings > Self-service menu section on the site).
\nExample:
\n{\n \"channel_id\": 57270\n}
\nSome fields in the results:
\nToken from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"client_id\":17340089,\n \"menu_item_id\":179617\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/scenarios/send_menu_item","description":"Sends self-service menu item to a client. \nSelf-service menu is a set of commands which your client can select in messenger to receive predefined replies. In messengers that support buttons, the menu can be shown using them. See Settings > Self-service menu section on the site).
\nExample:\n{\n \"client_id\":17340089,\n \"menu_item_id\":179617\n}
\nWorking with self-service menu items.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"040d69f1-3a5c-4ee6-839c-c5b4075e5603"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e9a58a49-1631-40db-a9e4-ed5634f2f657"}}],"_postman_id":"3296344a-a419-482a-ab84-a96e7913441e"},{"name":"Data types and values","item":[{"name":"api_modes","id":"ab301ff4-3cc1-4cdb-bd3d-d270e34794e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/help/api_modes","description":"Returns a list of available API access levels.
\n","urlObject":{"path":["v1","help","api_modes"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"14c6a840-8434-4764-814b-3da9e4fe3811","name":"api_modes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Returns a list of available transports (see TERMS) and their supported attachments.
\n","urlObject":{"path":["v1","help","transports"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"d2942577-3ae4-43e9-8213-4c35f88c825c","name":"transports","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/help/message_types","description":"Returns a list of available message types.
\n","urlObject":{"path":["v1","help","message_types"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"d58ac962-caf3-4165-822d-c0c296b88812","name":"message_types","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/help/dialog_states","description":"Returns a list of available dialog states.
\n","urlObject":{"path":["v1","help","dialog_states"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"cc673ed4-8854-4b3d-9ebe-44ac98e09311","name":"dialog_states","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Returns a list of available operator (agent) roles.
\n","urlObject":{"path":["v1","help","roles"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"31223501-8a5c-43cd-908d-f6913a4949d4","name":"roles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Returns a list of available countries in the System. This list is used to display in client's infocard on the site based on client's mobile number (where known).
\n","urlObject":{"path":["v1","countries"],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[{"id":"620e74b2-d135-4333-8596-42d7bcb84e8f","name":"countries","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/regions","description":"Returns a list of available regions. This list is used to display in client's infocard on the site based on client's mobile number (where known).
\n","urlObject":{"path":["v1","regions"],"host":["https://api.chat2desk.com"],"query":[{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[{"id":"0cf24b5c-ba66-41eb-be7e-33f0756389d9","name":"regions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Working with data types and possible values.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"216da7bb-6d4d-4b20-8127-63ef34df7f28"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"69cdd0ab-b78f-4f65-ad14-c9ea4064cc15"}}],"_postman_id":"6ff7a29a-6c0c-4e5f-b38f-436b7c390659"},{"name":"Other","item":[{"name":"companies/info","id":"f7c77547-5e31-4afe-87d3-c17db1f7a1e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/companies/info","description":"Stores any text info which relates to your company as a whole – unlike per-client basis.
\nThere are 3 text fields to store the info. To read back the info, use api_info (GET).
Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/companies/api_info","description":"Returns current API version, your API access level, number of API requests per month and more.
\nThe following API packages are available for connection:
\nSome fields in the reply:
\napi_modes (GET).companies (PUT)).Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/statistics?report=request_stats&date=2021-11-22","description":"Returns aggregated statistics data such as operators’ reaction and reply times, number of (new) clients and requests per day, operators activity, ratings, requests and more. See Reports > General reports > Aggregated statistics section on the site.
\nImportant! You must have Aggregated statistics paid feature turned on for your company. Contact administration.
\n","urlObject":{"path":["v1","statistics"],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Name of 5 available statistic reports:
\nDay (in your company’s time zone) for which statistics will be returned. You can specify 1 day only. Keep in mind, that statistics for current day is calculated next day (tomorrow) at around 2 a.m.
\n","type":"text/plain"},"key":"date","value":"2021-11-22"},{"disabled":true,"description":{"content":"Number of records returned (default is 20).
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":""}],"variable":[]}},"response":[{"id":"1113e174-e18e-4da3-8355-6356121305ea","name":"request_stats","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/web_analytics_data?date_from=2021-11-20&date_from=2021-11-21&order=asc","description":"Returns a list of URLs and UTM marks of clients’ chats along with Google, Yandex, Comagic and Roistat user ids. Useful for marketing purposes.
\nTo obtain this data, you must have URL/UTM tracking feature turned on. See Settings > URL tracking section on the site.
\nAlso, your clients must start chats using our widget with messengers — see Settings > Widget.
\n","urlObject":{"path":["v1","web_analytics_data"],"host":["https://api.chat2desk.com"],"query":[{"description":{"content":"Starting date of the data
\n","type":"text/plain"},"key":"date_from","value":"2021-11-20"},{"description":{"content":"Ending date
\n","type":"text/plain"},"key":"date_from","value":"2021-11-21"},{"description":{"content":"Order: asc or desc
\n","type":"text/plain"},"key":"order","value":"asc"},{"disabled":true,"description":{"content":"Number of records returned (maximum is 200, default is 20).
\n","type":"text/plain"},"key":"limit","value":null},{"disabled":true,"description":{"content":"Offset from the 1st record of the list (default is 0).
\n","type":"text/plain"},"key":"offset","value":null}],"variable":[]}},"response":[{"id":"232a14d8-0d81-405d-a405-50d80e03b8e8","name":"web_analytics_data","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/templates/","description":"Returns a list of templates for quick answers by your operators (agents). See Settings > Templates section on the site.
\nSpecify template id (for example templates/1) to get an info on an individual template.
\n","urlObject":{"path":["v1","templates",""],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"bf33d3ff-aff5-4f3c-9d5b-4ea50b5383cf","name":"templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n","type":"text"}],"url":"https://api.chat2desk.com/v1/channels","description":"Returns list of your channels with info such as connected transports (messengers) on each channel.
\n","urlObject":{"path":["v1","channels"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[{"id":"82179025-ae74-46de-a887-904bb784c7c4","name":"channels","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\r\n \"custom_fields\": {\"1\":\"Field 1\",\"2\":\"Field 2\",\"3\":\"Field 3\"}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/companies","description":"Stores any text info which relates to your company as a whole – unlike per-client basis.
\nThere are 3 text fields to store the info. To read back the info, use api_info (GET).
Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"mode\": \"online\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/companies/switch_mode","description":"Switches company’s current working mode. Working mode affects autoreplies (see Settings > General section on the site).
\nStatus can be online and offline.
\n","urlObject":{"path":["v1","companies","switch_mode"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb6e5983-277f-49a3-b971-96ae78fcaade"},{"name":"qr_decode","id":"6e2b2c4e-0ca2-4a01-8320-082e445c9ad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"body":{"mode":"raw","raw":"{\n \"image_path\": \"https://cdn.britannica.com/17/155017-050-9AC96FC8/Example-QR-code.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chat2desk.com/v1/qr_decode","description":"Decodes QR code for direct URL with QR code picture.
\n","urlObject":{"path":["v1","qr_decode"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e2b2c4e-0ca2-4a01-8320-082e445c9ad1"},{"name":"delete_outbox","id":"63a0acfb-5aaf-4d51-b106-da3881f6be95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token from Settings > API section (under admin account).
\n"}],"url":"https://api.chat2desk.com/v1/gateway/delete_outbox","description":"Deletes all outgoing messages that yet have not been sent.
\n","urlObject":{"path":["v1","gateway","delete_outbox"],"host":["https://api.chat2desk.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63a0acfb-5aaf-4d51-b106-da3881f6be95"}],"id":"ccf840e0-d217-49b0-84e1-1cca4e5b40ec","description":"Other API functions.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e0bef60f-8f57-4848-81a0-9d6567af7fbe"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f50bd4cd-d46c-4eb4-8a40-1f836124af16"}}],"_postman_id":"ccf840e0-d217-49b0-84e1-1cca4e5b40ec"}],"event":[{"listen":"prerequest","script":{"id":"0cf7431c-39c8-4d5d-8da8-066b059a7e3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0f861b3f-ad24-43cd-b1cf-99a25c1bdc59","type":"text/javascript","exec":[""]}}],"variable":[{"key":"brand","value":"Chat2Desk","type":"string"},{"key":"token","value":"