POST /chats

utiliza este endpoint para crear conversaciones en asisteclick desde tu propio sistema por ejemplo, puedes usar este endpoint si quieres enviar un mensaje de bienvenida a tus clientes luego de que confirmen una compra en tu tienda online o por ejemplo, enviar una notificación de pago pendiente a través de un proceso cron en tu propio servidor el documento ofrece ejemplos de código en tres lenguajes de programación (curl, node js, python y ruby) para efectuar una solicitud post y crear una convesación la respuesta obtenida es un objeto json que contiene información el ticket generado { "name" "post /chats", "method" "post", "url" "https //api asisteclick com/v2/chats", "description" "crear una nueva conversacion", "tab" "examples", "examples" { "languages" \[ { "id" "fcavco6a2ddxt6xprslsc", "language" "curl", "code" "curl location request post 'https //api asisteclick com/v2/chats' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data raw '{\\"deptid assigned\\" \\"number\\",\\"userid assigned\\" \\"number\\",\\"status\\" \\"string\\",\\"customer name\\" \\"string\\",\\"customer email\\" \\"string\\",\\"customer phone\\" \\"string\\",\\"channel\\" \\"string\\",\\"source id\\" \\"number\\",\\"subject\\" \\"string\\",\\"custom fields\\" \\"object\\",\\"tags\\" \\"array\\",\\"template id\\" \\"number\\",\\"template parameters\\" \\"array\\"}'", "customlabel" "" }, { "id" "kp5kn57jydnk20mzzcaeo", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'post',\n 'url' 'https //api asisteclick com/v2/tickets',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"deptid assigned\\" \\"number\\",\n \\"userid assigned\\" \\"number\\",\n \\"status\\" \\"string\\",\n \\"customer name\\" \\"string\\",\n \\"customer email\\" \\"string\\",\n \\"customer phone\\" \\"string\\",\n \\"channel\\" \\"string\\",\n \\"source id\\" \\"number\\",\n \\"subject\\" \\"string\\",\n \\"custom fields\\" \\"object\\",\n \\"tags\\" \\"array\\",\n \\"template id\\" \\"number\\",\n \\"template parameters\\" \\"array\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "jblae8d3ja5rmeyjuufys", "language" "python", "code" "import requests\nimport json\n\nurl = \\"https //api asisteclick com/v2/tickets\\"\n\npayload = json dumps({\n \\"deptid assigned\\" \\"number\\",\n \\"userid assigned\\" \\"number\\",\n \\"status\\" \\"string\\",\n \\"customer name\\" \\"string\\",\n \\"customer email\\" \\"string\\",\n \\"customer phone\\" \\"string\\",\n \\"channel\\" \\"string\\",\n \\"source id\\" \\"number\\",\n \\"subject\\" \\"string\\",\n \\"custom fields\\" \\"object\\",\n \\"tags\\" \\"array\\",\n \\"template id\\" \\"number\\",\n \\"template parameters\\" \\"array\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "r28lp1y5urqmpbj rdjle", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api asisteclick com/v2/tickets\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"deptid assigned\\" \\"number\\",\n \\"userid assigned\\" \\"number\\",\n \\"status\\" \\"string\\",\n \\"customer name\\" \\"string\\",\n \\"customer email\\" \\"string\\",\n \\"customer phone\\" \\"string\\",\n \\"channel\\" \\"string\\",\n \\"source id\\" \\"number\\",\n \\"subject\\" \\"string\\",\n \\"custom fields\\" \\"object\\",\n \\"tags\\" \\"array\\",\n \\"template id\\" \\"number\\",\n \\"template parameters\\" \\"array\\"\n})\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "fcavco6a2ddxt6xprslsc" }, "results" { "languages" \[ { "id" "1neiv6h1w9jzcfxuhv1ps", "language" "200", "customlabel" "", "code" "{\n\t\\"code\\" 200,\n\t\\"error\\" 0,\n\t\\"message\\" \\"ticket created\\",\n\t\\"data\\" {\n\t\t\\"ticket id\\" \\"1q8g3\\"\n\t}\n}" }, { "id" "cs31r pmnuspuzrb8qdxw", "language" "404", "customlabel" "", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n }" } ], "selectedlanguageid" "1neiv6h1w9jzcfxuhv1ps" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "token", "kind" "required", "type" "string", "description" "token de acceso", "children" \[] } ], "bodydataparameters" \[ { "name" "deptid assigned", "kind" "required", "type" "number", "description" "el id del departamento al cual se vincula la conversación ", "children" \[] }, { "name" "userid assigned", "kind" "required", "type" "number", "description" "0 o en caso de querer asignar también la conversación a un usuario en particular colocar acá el id del usuario ", "children" \[] }, { "name" "status", "kind" "required", "type" "string", "description" "open / close", "children" \[] }, { "name" "customer name", "kind" "required", "type" "string", "description" "el nombre del cliente ", "children" \[] }, { "name" "customer email", "kind" "optional", "type" "string", "description" "null o el correo electrónico del cliente ", "children" \[] }, { "name" "customer phone", "kind" "optional", "type" "string", "description" "null o el teléfono del cliente en formato whatsapp ", "children" \[] }, { "name" "channel", "kind" "required", "type" "string", "description" "whatsapp / telegram / email", "children" \[] }, { "name" "source id", "kind" "optional", "type" "number", "description" "si channel = 'whatsapp' entonces el número de whatsapp integrado en asisteclick por el cual se enviará el mensaje si channel = 'telegram' entonces el nombre del bot de telegram integrado en asisteclick ", "children" \[] }, { "name" "subject", "kind" "required", "type" "string", "description" "el título de la conversación (solo visible por los usuarios en caso que canal = whatsapp) ", "children" \[] }, { "name" "custom fields", "kind" "optional", "type" "object", "description" "null o vector con valores para campos personalizados {campo valor}", "children" \[ { "name" "campo1", "kind" "optional", "type" "string", "description" "valor1" }, { "name" "campon", "kind" "optional", "type" "number", "description" "valorn" } ] }, { "name" "tags", "kind" "optional", "type" "array", "description" "null o vector con etiquetas de la conversación (opcional) ", "children" \[] }, { "name" "template id", "kind" "optional", "type" "number", "description" "el id de la plantilla aprobada por whatsapp que se enviará al cliente ", "children" \[] }, { "name" "template parameters", "kind" "optional", "type" "array", "description" "en caso que la plantilla tenga parámetros aquí se especifican los valores en un vector de strings ", "children" \[] }, { "name" "telegram chat id", "kind" "optional", "type" "number", "description" "para telegram, el id telegram del destinatario", "children" \[] }, { "name" "ack callback url", "kind" "optional", "type" "string", "description" "para los canales que gestionan notificación de lectura (como whatsapp) se enviarán las notificaciones a la url definida acá puede ser nulo o no estar presente ", "children" \[] }, { "name" "external reference", "kind" "optional", "type" "string", "description" "string o número de referencia externa o metadata", "children" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } ejemplo de un body { "deptid assigned" 0, "userid assigned" 8, "status" "open", "customer name" "luciano", "customer email" null, "customer phone" " 5491150173420", "channel" "whatsapp", "source id" 5491170052719 , "subject" "ahora si!", "custom fields" \[{"cliente" "a 123"}], "tags" \["plan company"], "template id" 6358, "template parameters" \["franco", "maria"], "ack callback url" "https //www empresa com/v1/recepciones", "external reference" "campaña 2024 02" } descripción de los campos campo descripción token el token de la cuenta en asisteclick deptid assigned id del departamento al cual se asigna la conversación userid assigned id del usuario a quien se le asigna la conversación, además de la asignación del departamento colocar 0 si se quiere que la conversación esté en la bandeja sin asignar y visible para todos los usuarios con acceso al departamento indicado en deptid assigned status open si se quiere que la conversación quede en la bandaje sin asignar o asignado a un usuario en particular si el cliente responde su respuesta será anexada a la conversación closed si se quiere que la conversación quede archivada si el cliente responde el bot responderá iniciando una nueva conversación desde el inicio customer name nombre del cliente customer email correo electrónico del cliente puede ser null si channel no es email customer phone el teléfono del cliente en formato whatsapp puede ser null si channel no es whatsapp channel whatsapp o email source id el número de whatsapp integrado en asisteclick por el cual se enviará el mensaje si es un mensaje de telegram entonces colocar el nombre del bot de telegram integrado en asisteclick puede ser null si channel no es whatsapp ni telegram subject el título de la conversación (solo visible por los usuarios en caso que canal = whatsapp) en caso que channel sea email este valor será también el título del email custom fields vector con diccionario de campo y valor el campo y valor aparecerán en la columna derecha de la conversación (columna de metadata) y, en caso de existir en la lógica del bot, serán también procesados por este puede ser null o un vector válido como \[{"cliente" "a 123"}] tags vector con etiquetas de la conversación (opcional) \["customer", "plan company"] template id el id de la plantilla aprobada por whatsapp que se enviará al cliente puede ser null si channel no es whatsapp template parameters en caso que la plantilla tenga parámetros aquí se especifican los valores en un vector de strings en el vector solo se colocan los valores del mensaje en el mismo orden en que figuran los campos en la plantilla puede ser null si channel no es whatsapp o un vector válido como \["franco", "maria"] telegram chat id si channel = 'telegram' colocar el id del usuario o grupo de telegram al cual enviar el mensaje puede ser null si channel no es telegram ack callback url para los envios por whatsapp, en caso de colocar una url de callback, se enviarán notificaciones de envio (sent), recepción (received), lectura (read) y respuesta (replied) puede ser null o no estar presente external reference durante un callback se adjunta el valor de referencia externa recibido en el request original puede ser null o no estar presente callback de notificacion de mensaje en caso de utilizar el campo ack callback url colocando una url válida, asisteclick ejecutará un post a esta url cada vez que el mensaje haya sido procesado por whatsapp ( sent ) el mensaje haya llegado al usuario ( received ) el mensaje haya sido leido ( read ) el usuario envio una primer respuesta ( replied ) para el caso de evento " read " este se envia depenndiendo de la configuración de privacidad en el whatsapp del usuario para el caso del evento " replied " este se envia solo si el ticket es creado con el estado open y únicamente con la recepción del primer mensaje recibido del usuario en tu endpoint definido en ack callback url recibirás un json con la siguiente estructura { "external reference" "campaña 2024 02", "ticket id" "5g9os", "name" "luciano", "phone" "5491150173420", "ack" "read" } para el caso de las respuestas del callback del evento " replied " se incluye también el campo " message " que contiene la respuesta del cliente, se esta manera { "external reference" "campaña 2024 02", "ticket id" "5g9os", "name" "luciano", "phone" "5491150173420", "ack" "replied", "message" "si, me interesa!" } códigos de error 1 customer name field is missing 2 deptid assigned field value is missing 3 deptid assigned field value is invalid 4 userid assigned field is missing 5 userid assigned field value is invalid 6 status field value must be open or closed 7 customer email format is invalid 8 customer phone format is invalid (must be numbers only) 9 must provide customer email, customer phone or telegram chat id 10 channel value must be email, whatsapp or telegram 11 subject field value is invalid 16 customer email field is required when channel is email 17 customer phone field is required when channel is whatsapp 18 source id is invalid or missing this field is required when 'channel' is set to whatsapp 19 custom fields format is not valid (should be field1=value1;field2=value2) or a vector of objects key\ value \[{field1\ value1},{field2\ value2}] 20 callback url is not valid 21 invalid source id provided the company phone number is not linked to a whatsapp channel 22 invalid template id provided whatsapp message needs a template id 23 invalid template id provided whatsapp message needs a valid template id 24 invalid template id provided whatsapp message needs a valid template id 25 invalid template parameters provided whatsapp message needs a valid template parameters vector value in a vector format 26 tags format is not valid (should be tag1;tag2;tag3) or a vector of tags \[tag1,tag2,tag3] 27 telegram chat id field is required when channel is telegram 28 callback url url is not valid 29 ack callback url url is too long it must be less than 2048 characters 32 external reference must be a string 33 external reference is too long it must be less than 20 characters 34 message field is required when status is private