{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"05ba8127-e487-42e3-a3b7-4568e8353b83","name":"Chat2Desk Public API México (corregida 2026-10-28)","description":"Esta API esta diseñada para enviar y recibir mensajes, obtener la lista de clientes, añadir etiquetas, establecer webhooks y más.\n\nPara empezar a probar la API:\n\n- Vaya al sitio del Sistema (ver _TÉRMINOS_ más abajo) con la cuenta de administador y abre la sección _API & Scripts > API_.\n    \n- Utilizando la aplicación Postman, copia el token API a esta colección Postman en la sección _Variables_.\n    \n- Asegúrate de tener algunos mensajes de clientes para probar la API.\n    \n\nLas notas a pie de página indican los cambios previstos para la próxima versión.\n\n**¡Importante!** La fecha de lanzamiento puede modificarse.\n\n## CHANGELOG\n\n**06.06.2025**\n\nSe ha añadido la verificación de firma de webhook (HMAC). Consulte la descripción de los webhooks.\n\n**01.05.2025**\n\nCambios en response `/statistics`. Ejemplos añadidos\n\n**17.09.2024**\n\nAñadido nuevo método `companies/info (GET)`\n\n**12.08.2024**\n\nAñadido API para la gestión de Tickets (`/tickets` `GET`, `POST`, `PUT`, `DELETE`)\n\nAñadido nuevos eventos para `webhooks (POST)` `new_ticket`, `ticket_updated`, `ticket_deleted`\n\nAñadido nuevos valores (`help/tickets (GET)`) para Tickets en `Tipo de Datos y Valores`\n\n**03.07.2024**\n\nAñadido nuevo evento para `webhooks (POST)` `client_added_to_blacklist`\n\nAñadido nuevo filtro para canales en `webhooks (POST)`\n\nAñadido nuevo transporte soportado en `messages (POST)` con botones y tipo interactivo\n\nAñadido campo `two_factor` en respuesta `operators (GET)`\n\nAñadido parámetro `attachment_filename` para `messages (POST)` que proporciona el nombre del archivo original\n\nAñadido parámetro attachment para messages/inbox (POST) que proporciona el nombre del archivo original. Tenga en cuenta que `attachment` es requerido; `image` ó `video` no soportan `attachment_filename`\n\n**20.02.2024**\n\nAñadido nuevos eventos para `webhooks (POST)` `operator_status_changed` y `operator_authentication_updated`\n\nAñadido nuevos parámetros _client_phone_ y _custom_fields_ para `message/inbox (POST)`\n\nAñadido la opción de enviar mensajes interactivos de tipo _list_ en Wa dialog para `messages (POST)`\n\nAñadido la opción de enviar mensajes interactivos de tipo _buttons_ en Wa dialog para `messages (POST)`\n\n**26.12.2023**\n\nAñadido nuevos estatus para el evento `outbox_status` en `webhooks (POST)`\n\n**20.06.2023**\n\nAñadido la opción de enviar _inline_buttons_ en wa_dialog para `messages (POST)`\n\nAñadido la opción de enviar botones _keyboard_ en insta_official para `messages (POST)`\n\n**29.05.2023**\n\nRemovido validación en trasporte telegram para `clients (POST)`\n\n**23.05.2023**\n\nAñadido nuevo parámetro de respuesta en `clients (POST)`\n\n**10.05.2023**\n\nAñadido nuevo endpoint `messages/import (POST)`\n\n**10.02.2023**\n\nAñadido nuevo parámetro _direction_reverse_ para `messages (GET)`\n\nAñadido descripción del parámetro _transport_ para `messages (POST)`\n\nAñadido descripción para el parámetro _payload_ para `messages (POST)`\n\nAñadido descripción de filtros para `dialogs (GET)`\n\nAñadido parámetro status para `webhooks (PUT)`\n\nAñadido filtros para `operators (GET)`\n\nAñadido ejemplos para `api_modes (GET)`\n\n`countries (GET)`\n\n`dialog_states (GET)`\n\n`messages_types (GET)`\n\n`roles (GET)`\n\n`transports (GET)`\n\n`api_info (GET)`\n\n`channels (GET)`\n\n`templates (GET)`\n\n**11.01.2023**\n\nAñadido evento _device_updated_ para `webhooks (POST)`\n\nUsando _start_id_ con los filtros de fechas de mensajes _start_date_ y _finish_date_ está ahora prohibido para `messages (GET)`\n\n**01.12.2022**\n\nAñadido descripción para evento _new_tag_ en `webhooks (POST)`\n\n**02.09.2022**\n\nAñadido filtro _client_phone_ para `clients (GET)`\n\n**27.07.2022**\n\nAñadido respuestas de ejemplo para varios comandos GET\n\n**24.03.2022**\n\nAñadido el evento _comment_ para `webhooks (POST)`\n\n**25.11.2021**\n\nSe ha añadido un límite de tarifa a `message (POST)`\n\nAñadido nuevo evento de creación de cliente (usando `message (POST)`) para _new_client_ evento webhook\n\nSe ha añadido el filtro por campos de clientes personalizados para `clients (GET)`\n\n**16.09.2021**\n\nSe han añadido los parámetros _companyID_ y _partnerID_ para `companies/api_info (GET)`\n\nAñadido nuevo método `messages (PUT)`\n\n**01.06.2021**\n\nAñadido evento _outbox_status_ para `webhooks (POST)`\n\nAñadido el parámetro _reply_message_id_ para `messages (POST)`\n\n**08.04.2021**\n\nAñadido el parámetro _assigned_phone_ para `clients (POST)` y `clients (PUT)`\n\n**11.02.2021**\n\nAñadido el parámetro _domain_urls_ para `companies/api_info (GET)`\n\nAñadido el parámetro _post_url_ en _extra_data_ para `messages (GET)`\n\nSe ha añadido la especificación de la respuesta de error.\n\n_No se proporciona el registro de cambios anteriores._\n\n## TÉRMINOS\n\n_Sistema_ — Servicio [Chat2Desk](https://chat2desk.mx/).\n\n_Client_ — es una persona, que envía o recibe mensajes a través del Sistema.\n\n_Transport_ – es un mensajero, red social o chat en línea que es compatible con el Sistema. Como WhatsApp, Viber, Telegram, Facebook, Instagram, VKontakte, chat en línea y más.\n\n_Channel_ — es un grupo de tus cuentas de mensajería. Puede tener muchos canales con diferentes respuestas automáticas, menú de autoservicio, asignación de chat, etc. para cada canal.\n\n_External channel_ — es una fuente de mensajes de cualquier mensajero (transporte) no soportado por el Sistema. Por ejemplo, chat de 3ros, mensajería, app ó CRM.\n\n_Request_ — es un conjunto de mensajes dentro de un diálogo con un cliente. Por regla general, la solicitud comienza con el primer mensaje del cliente y termina cuando se cierra el diálogo. Cuando el cliente continúa chateando en el diálogo cerrado, se inicia una nueva solicitud en el mismo diálogo.\n\n## INFORMACIÓN GENERAL\n\n- Se utiliza la arquitectura RESTful y los métodos GET, PUT, DELETE y POST.\n    \n- Los resultados de los comandos se presentan en formato JSON.\n    \n- Está API utiliza HTTPS.\n    \n- La autorización se basa en el token de API, que está disponible en API & Scripts _\\> API_ en el sitio bajo la cuenta de administrador.\n    \n- Los comandos que devuelven grandes listas de datos admiten la paginación mediante parámetros URL:\n    \n    - _limit_ — número de registros devueltos (el máximo es 200, por defecto es 20).\n        \n    - _offset_ — desplazamiento desde el 1er registro de la lista (por defecto es 0). `Messages (GET)` es una excepción, ya que utiliza _start_id_ en lugar de _offset_. Ejemplo de la solicitud (lista de clientes): `/v1/clients?offset=50&limit=30`\n        \n- En general, el sistema está diseñado para responder a aquellos clientes que contactaron por primera vez con su empresa y por tanto están en la lista de sus clientes (ver `clients (GET)`). Usando `clients (POST)` puede crear un nuevo cliente y luego ponerse en contacto con él o ella. Póngase en contacto con estos clientes recién creados de forma razonable porque tu cuenta de mensajería podría bloquearse por spam en caso de que haya demasiados contactos o mensajes nuevos.\n    \n\n## ANTES DE EMPEZAR\n\nObtenga su token API en el sitio del Sistema, en la sección API & Scripts > API. Encontrará información sobre la API en `api_modes (GET)`. Ingrese el token a esta colección de Postman en la sección _Variables_ usando la aplicación Postman.\n\nHay 2 formas de trabajar con los mensajes:\n\n- Sus clientes utilizan mensajeros habituales, redes sociales, correos electrónicos o nuestro chat en línea para enviar mensajes a su empresa. En este caso utilice `webhooks (POST)` para recibir estos mensajes desde el Sistema. Para responder a los mensajes del cliente use `messages (POST)`.  \n    Si quiere contactar a un cliente que nunca lo ha contactado antes (está es la opción de pago _Escribir primero_) use `client (POST)` para crear a nue, obtén el id del cliente y luego use `messages (POST)` para enviar un mensaje como se mencionó antes.\n    \n- Sus clientes se ponen en contacto con usted a través de su propia aplicación, CRM o formulario de contacto y necesita que el Sistema permita a sus operadores (agentes) y chat bots atender a los clientes. Debería usar un canal externo para pasar mensajes al Sistema desde estas fuentes externas de mensajes usando `messages/inbox (POST)`. Para recibir las respuestas de los operadores y chat bots y enviarlas de vuelta a sus clientes, utilice web hooks (ver `webhooks (POST)`).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"11838732","team":1137960,"collectionId":"05ba8127-e487-42e3-a3b7-4568e8353b83","publishedId":"2sBYHVwzYw","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11838732/2sBYHVwzYw","privateUrl":"https://go.postman.co/documentation/11838732-05ba8127-e487-42e3-a3b7-4568e8353b83","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]},"metaTags":[{"name":"description","value":""},{"name":"title","value":"Chat2Desk Public API México (corregida)"}]},"version":"8.12.12","publishDate":"2026-10-29T21:22:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Chat2Desk Public API México (corregida)","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d1f492d4cdc5c63eb8183a2dce6be6a9de5fe548a8221c847f9384de7455b73a","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYHVwzYw"}