Retorna todos os Atendentes do chatbot
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","attendants"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"acd39328-42d4-4ebf-91b7-b1d4d8331858","name":"200 - success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRetorna todos os canais do bot
\n","urlObject":{"path":["api","channels"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"a5a812c0-248b-446c-bc05-aa4562cb3818","name":"200 - success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerEsse endpoint pode ser usado para adicionar um novo contato ao seu chatbot
\n","urlObject":{"path":["api","contacts"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"0e3f72eb-a4bc-4c27-9b60-dc2744973af3","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerEsse endpoint pode ser usado para adicionar múltiplos contatos ao seu chatbot. O body a ser enviado deve ser um array de objetos que contém os seguintes atributos.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts","batch"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"1f7d8897-3a36-4ade-82e9-204787729608","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerDepreciado. Endpoint utilizado para retornar o contato ao fluxo Suri quando o mesmo foi redirecionado para uma API externa pela regra de Redirecionar para API, utilizando Intenção de IA. Veja mais detalhes sobre esse tipo de integração em nosso Manual de Integração.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","backtosuri"],"host":["CHATBOT-URL"],"query":[{"key":"intentName","value":"NOME_DA_INTENÇÃO"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"8b921d4a-70cb-4c4d-8e9a-3ac38d4d3fc4","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerDepreciado. Endpoint utilizado para enviar o usuário para determinada cadência, experiência atrelada à Intenções de IA.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","startcadence"],"host":["CHATBOT-URL"],"query":[{"key":"cadenceId","value":"ID_CADENCIA"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"672f0ee5-2415-4b4f-a0a8-1c6a107b6894","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerEndpoint utilizado para finalizar um atendimento.
\nOpcionalmente, como query param você pode passar o ID do motivo de atendimento, que deve ser um ID válido (ou seja, previamente criado no Portal, em Configurações > Motivos do Atendimento).
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","finishattendance"],"host":["CHATBOT-URL"],"query":[{"key":"attendanceReasonId","value":"cbxxxx"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"e1dd91ae-1f25-428f-9d9a-0bd0d80c8e82","name":"200 - success - Encerrar atendimento com motivo","originalRequest":{"method":"POST","header":[],"url":{"raw":"CHATBOT-URL/api/contacts/USER-ID/finishattendance?attendanceReasonId=cb43294","host":["CHATBOT-URL"],"path":["api","contacts","USER-ID","finishattendance"],"query":[{"key":"attendanceReasonId","value":"cb43294"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"server","value":"Kestrel"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Fri, 14 Jan 2022 13:24:15 GMT"},{"key":"forwarded","value":"host=babysuri-web-tq2.conveyor.cloud; proto=http"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": null\n}"},{"id":"6e5ac796-8b38-4a28-b0b9-9b2b225cdf82","name":"200 - success - Encerrar atendimento com motivo","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerEndpoint utilizado para tirar um contato da fila de esperando atendimento.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","cancelattendancerequest"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"c253ac22-6086-4ea4-a1f0-c1ef92105006","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerMove um contato para a fila de esperando atendimento para um determinado departamento e/ou atendente.
\nLembre-se de substituir ID_DEPARTAMENTO e ID_ATENDENTE para os IDs de departamento e atendente, respectivamente.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","requestattendance"],"host":["CHATBOT-URL"],"query":[{"key":"department","value":"ID_DEPARTAMENTO"},{"key":"agent","value":"ID_ATENDENTE"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"f23e92df-1837-4bf0-9aba-1191e0ed202c","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAdiciona variável ao contato em questão. Você poderá utilizar as variáveis em requisições da API, como busca por contato ou dentro do Flow, no chatbot.
\nAs variáveis encontram-se no atributo Variables do contato, definido como o modelo User aqui na documentação.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","addvariable"],"host":["CHATBOT-URL"],"query":[{"key":"name","value":"VARIABLE_NAME"},{"key":"value","value":"VARIABLE_VALUE"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"053481bd-8391-44a6-86b6-76dabf159aed","name":"200 - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRemove variável previamente criada no contato. Caso a variável não exista, não ocorrem erros, apenas nenhuma ação é tomada.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","removevariable"],"host":["CHATBOT-URL"],"query":[{"key":"name","value":"VARIABLE_NAME"}],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"9a18af79-2499-4f22-a6e4-a2371f9d9335","name":"200 - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAtualiza o campo Observações de um contato. Este é o mesmo campo que fica à mostra no Portal de atendimento, na coluna de detalhes do contato.
\nAtenção: o tamanho máximo do texto a ser enviado no Body é de 4000 caracteres.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","contacts",":user_id","updateusernote"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"ebf911e1-f629-4641-963d-9c15b87842e3","name":"200 - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer[DEPRECATED - Utilizar o endpoint https://documenter.getpostman.com/view/17684221/UUxz9mt5#36567385-3347-4752-8e85-ad870a1d9624]
\nUma requisição a essa rota pode ser com ou sem continuationToken. Se o continuationToken não estiver definido, será retornada a primeira página daquela requisição.
O limit representa o tamanho da página à ser retornada. É importante falar que para um conjunto de páginas, o limit deve ser constante.
A página retornada terá o seguinte formato
\n{\n \"Items\":{...},\n \"ContinuationToken\":\"\"\n}\n\nListagem de contatos utilizando filtros. Precisa de um objeto (body) na seguinte estrutura:
\nA página retornada terá o seguinte formato
\n{\n \"Items\":{...},\n \"ContinuationToken\":\"\"\n}\n\nEndpoint usado para enviar mensagens de texto (não templates) para contatos já cadastrados (via ID).
\nImportante lembrar: tal mensagem só será de fato enviada caso o contato em questão possua uma sesão ativa. Caso contrário apenas mensagens templates são permitidas.
\nOnde o objeto message está definido da seguinte forma:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"e8cfae00-3665-4869-a3a3-ca3482685cb1","name":"Status de Escrevendo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"wp350628444809181:5571991038445\",\n \"typing\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"CHATBOT-URL/api/messages/send"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"86"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:54:55 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": null,\n \"error\": \"Message cannot be null\",\n \"validationErrors\": null\n}"}],"_postman_id":"37b762b2-1d1c-47d1-964c-57932e674109"},{"name":"Mensagem de texto","id":"481e1dd2-f275-4a8e-8840-03bafcd7b0d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"Endpoint usado para enviar mensagens de texto (não templates) para contatos já cadastrados (via ID).
\nImportante lembrar: tal mensagem só será de fato enviada caso o contato em questão possua uma sesão ativa. Caso contrário apenas mensagens templates são permitidas.
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto MessageContext está definido como:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"481e1dd2-f275-4a8e-8840-03bafcd7b0d4"},{"name":"Mensagem de texto com import","id":"0a839a0c-acc3-4512-a9a3-6021557d7266","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user\": {\r\n \"name\": \"Endpoint usado para enviar mensagens de texto (não templates) para contatos não cadastrados, passando o contado a ser importado junto da mensagem.
\nImportante lembrar: tal mensagem só será de fato enviada caso o contato em questão seja de um canal de provedor não oficial do WhatsApp, isto é, Z-API. Para canais oficiais, de provedor Gupshup ou Cloud API, utilizar o endpoint de envio de Mensagem de template com import.
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto MessageContext está definido como:
\n","urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a839a0c-acc3-4512-a9a3-6021557d7266"},{"name":"Mensagem de anexo","id":"2cb85589-07ae-4b52-b444-882c667ecabc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"USER-ID\",\r\n \"message\": {\r\n \"attachment\": {\r\n \"type\": \"image\",\r\n \"fileName\": \"imagem\",\r\n \"payload\": {\r\n \"url\": \"Endpoint usado para enviar mensagens de anexo.
\nSemelhante ao endpoint de mensagem de texto com import, caso seja passado o objeto user ao invés de userId, o mesmo será importado na base.
\nOnde o objeto message está definido como:
\nE o objeto MessageContext está definido como:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"12e76fc7-7ec3-4b83-b4ef-3b9099888855","name":"200 - success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"Envia mensagem de pagamento.
\nMensagens de pagamento do WhatsApp utilizam Payments API, que permitem enviar mensagens estruturadas com botões de link de pagamento de cartão e/ou PIX Copia e Cola e/ou boleto (linha digitável). Mensagens de pagamento tendem a ser mais performáticas e converter mais as cobranças enviadas devido à praticidade oferecida pelo botão de copiar PIX ou Linha digitável de boleto e a simplicidade do acesso ao link de pagamento.
\nO envio segue o mesmo padrão das demais mensagens, onde você pode passar o atributo user caso queira importar/atualizar um contato ao mesmo tempo que envia a mensagem ou então o atributo userId se deseje apenas utilizar um contato que já existe em sua base. O mesmo vale para o atributo message. A única diferença está de fato em um novo atributo enviado dentro de message: OrderParameters). Seguem exemplos:
\nEnvio de template com import de contato:
\n{\n \"user\": {\n \"name\": \"<Nome do contato>\",\n \"phone\": \"<Telefone do contato com DDI e DDD>\",\n \"email\": null,\n \"gender\": 0,\n \"channelId\": \"<Id do canal>\",\n \"channelType\": 1,\n \"defaultDepartmentId\": null\n },\n \"message\": {\n // ...\n }\n // ...\n}\n\nEnvio de template sem o import de contato:
\n{\n \"userId\": \"<ID do contato>\",\n \"message\": {\n // ...\n }\n // ...\n}\n\nO objeto message está definido da seguinte forma:
\nO objeto PaymentSettings é o responsável por renderizar os tipos de pagamento disponíveis na cobrança. Deve ser passado ao menos um dos atributos (pix_dynamic_code, boleto ou payment_link) e no máximo 2. Ou seja, só é possível ter uma das seguintes combinações de cobrança:
\n- \n
PIX + Link
\n \nPIX + Boleto
\n \nLlink + Boleto
\n \nSomente PIX, somente Boleto ou somente Link
\n \n
Seguem abaixo detalhes de cada um deles:
\npix_dynamic_code:
\npayment_link:
\nBoleto:
\nO objeto Product está definido como:
\nE o objeto MessageContext está definido como:
\n","urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"93c5d380-b852-4d36-aaa1-0e936816090e"},{"name":"Mensagem de template via id","id":"f1fcf7fa-0236-4279-bef4-2a493a9b152f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"Endpoint usado para enviar mensagens templates para contatos já cadastrados (via ID).
\nOpcionalmente também é possível definir um comportamento para ser executado quando o contato responder tal mensagem (ver detalhes mais abaixo)
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto responseAction está definido como:
\nO objeto buttonActions é definido como um Map chave=valor, onde a chave é o título do botão da template e o valor um objeto contendo o type e sendTo novamente, conforme exemplo abaixo:
\n{\n \"Texto do botão 1\": {\n \"type\": 1,\n \"sendTo\": \"cbXXXX\"\n }\n \"Texto do botão 2\": {\n \"type\": 2,\n \"sendTo\": \"cbYYYY\"\n }\n}\n\nLembrando que, caso o contato não clique em um botão da template, mas sim DIGITE uma resposta, o comportamento configurado em type e sendTo geral é utilizado.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1fcf7fa-0236-4279-bef4-2a493a9b152f"},{"name":"Mensagem de template com import","id":"c2b019b1-e688-405d-9acd-0a78a98a042d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user\": {\r\n \"name\": \"Endpoint usado para enviar mensagens templates para contatos não cadastrados (enviando contato junto para importar)
\nOpcionalmente também é possível definir um comportamento para ser executado quando o contato responder tal mensagem (ver detalhes mais abaixo)
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto responseAction está definido como:
\nO objeto buttonActions é definido como um Map chave=valor, onde a chave é o título do botão da template e o valor um objeto contendo o type e sendTo novamente, conforme exemplo abaixo:
\n{\n \"Texto do botão 1\": {\n \"type\": 1,\n \"sendTo\": \"cbXXXX\"\n }\n \"Texto do botão 2\": {\n \"type\": 2,\n \"sendTo\": \"cbYYYY\"\n }\n}\n\nLembrando que, caso o contato não clique em um botão da template, mas sim DIGITE uma resposta, o comportamento configurado em type e sendTo geral é utilizado.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2b019b1-e688-405d-9acd-0a78a98a042d"},{"name":"Mensagem de template com arquivo e import","id":"5e731e92-e5bf-48ba-904b-188434a43f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Envia mensagem template com arquivos.
\nLembrando que mensagens templates do WhatsApp somente aceitam:
\n- \n
imagens nos formatos JPG e PNG,
\n \nvídeos no formato MP4 e
\n \ndocumentos no formato PDF
\n \n
Se uma mensagem template é cadastrada e aprovada no WhatsApp com um tipo de arquivo, somente este tipo de arquivo é possível ser enviado através dela. Por exemplo, se a template tiver sido criada com arquivo do tipo PDF, somente será possível enviar esta template passando um arquivo no formato PDF.
\nO parâmetro mediaTemplateType pode ter os seguintes valores:
- \n
\nimage\n
\nvideo\n
\ndocument\n
O ID da template do WhatsApp é um GUID e pode ser encontrado clicando na template no Portal, na página de Configurações > Modelos de mensagem > selecionando a template desejada. É o campo Identificador mais abaixo.
\nOpcionalmente também é possível definir um comportamento para ser executado quando o contato responder tal mensagem (ver detalhes mais abaixo)
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto responseAction está definido como:
\nO objeto buttonActions é definido como um Map chave=valor, onde a chave é o título do botão da template e o valor um objeto contendo o type e sendTo novamente, conforme exemplo abaixo:
\n{\n \"Texto do botão 1\": {\n \"type\": 1,\n \"sendTo\": \"cbXXXX\"\n }\n \"Texto do botão 2\": {\n \"type\": 2,\n \"sendTo\": \"cbYYYY\"\n }\n}\n\nLembrando que, caso o contato não clique em um botão da template, mas sim DIGITE uma resposta, o comportamento configurado em type e sendTo geral é utilizado.
\n","urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e731e92-e5bf-48ba-904b-188434a43f06"},{"name":"Mensagem de template com arquivo via id","id":"c85b90ce-b605-4af3-bc38-b78fc1050c56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": \"Envia mensagem template com arquivos.
\nLembrando que mensagens templates do WhatsApp somente aceitam:
\n- \n
imagens nos formatos JPG e PNG,
\n \nvídeos no formato MP4 e
\n \ndocumentos no formato PDF
\n \n
Se uma mensagem template é cadastrada e aprovada no WhatsApp com um tipo de arquivo, somente este tipo de arquivo é possível ser enviado através dela. Por exemplo, se a template tiver sido criada com arquivo do tipo PDF, somente será possível enviar esta template passando um arquivo no formato PDF.
\nO parâmetro mediaTemplateType pode ter os seguintes valores:
- \n
\nimage\n
\nvideo\n
\ndocument\n
O ID da template do WhatsApp é um GUID e pode ser encontrado clicando na template no Portal, na página de Configurações > Modelos de mensagem > selecionando a template desejada. É o campo Identificador mais abaixo.
\nOpcionalmente também é possível definir um comportamento para ser executado quando o contato responder tal mensagem (ver detalhes mais abaixo)
\nOnde o objeto message está definido da seguinte forma:
\nE o objeto responseAction está definido como:
\nO objeto buttonActions é definido como um Map chave=valor, onde a chave é o título do botão da template e o valor um objeto contendo o type e sendTo novamente, conforme exemplo abaixo:
\n{\n \"Texto do botão 1\": {\n \"type\": 1,\n \"sendTo\": \"cbXXXX\"\n }\n \"Texto do botão 2\": {\n \"type\": 2,\n \"sendTo\": \"cbYYYY\"\n }\n}\n\nLembrando que, caso o contato não clique em um botão da template, mas sim DIGITE uma resposta, o comportamento configurado em type e sendTo geral é utilizado.
\n","urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"c85b90ce-b605-4af3-bc38-b78fc1050c56"},{"name":"Mensagem de template de pagamento","id":"b6b21701-e254-4e39-a00f-21483420fc6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user\": {\r\n \"name\": \"Mensagens de pagamento do WhatsApp utilizam Payments API, que permitem enviar templates estruturadas com botões de link de pagamento de cartão e/ou PIX Copia e Cola e/ou boleto. Mensagens de pagamento tendem a ser mais performáticas e converter mais as cobranças enviadas devido à praticidade oferecida pelo botão de copiar PIX e linha digitável de boleto e a simplicidade do acesso ao link de pagamento .
\nO envio segue o mesmo padrão das demais templates, onde você pode passar o atributo user caso queira importar/atualizar um contato ao mesmo tempo que envia a mensagem ou então o atributo userId se deseje apenas utilizar um contato que já existe em sua base. O mesmo vale para o atributo message. A única diferença está de fato em um novo atributo enviado dentro de message: OrderParameters). Seguem exemplos:
\nEnvio de template com import de contato:
\n{\n \"user\": {\n \"name\": \"<Nome do contato>\",\n \"phone\": \"<Telefone do contato com DDI e DDD>\",\n \"email\": null,\n \"gender\": 0,\n \"channelId\": \"<Id do canal>\",\n \"channelType\": 1,\n \"defaultDepartmentId\": null\n },\n \"message\": {\n // ...\n }\n // ...\n}\n\nEnvio de template sem o import de contato:
\n{\n \"userId\": \"<ID do contato>\",\n \"message\": {\n // ...\n }\n // ...\n}\n\nO objeto message está definido da seguinte forma:
\nO objeto orderParameters está definido da seguinte maneira:
\nO array paymentSettings pode ter NO MÁXIMO 2 itens e ter NO MÌNIMO 1 item, não podendo repetir 2 itens iguais (por exemplo, dois PIX ou dois Links de pagamento juntos). Ou seja, só é possível ter uma das seguintes combinações de cobrança:
\n- \n
PIX + Link
\n \nPIX + Boleto
\n \nLlink + Boleto
\n \nSomente PIX, somente Boleto ou somente Link
\n \n
Seguem abaixo as definições dos tipos de pagamento disponíveis:
\nCopiar Chave PIX:
\nPixDynamicCode:
\nLink de Pagamento:
\nPaymentLink:
\nCopiar linha digitável de boleto:
\nBoleto:
\nO objeto Order está definido como:
\nTax:
\nItem:
\nE o objeto responseAction está definido como:
\n","urlObject":{"path":["api","messages","send"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6b21701-e254-4e39-a00f-21483420fc6b"},{"name":"Listar Mensagens do Contato","id":"d1c22709-70d0-426c-afa8-183299fb11fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Endpoint usado para recuperar mensagens de um contato definido por USER-ID.
\n","urlObject":{"path":["api","contacts",":user_id","messages"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"USER-ID","key":"user_id"}]}},"response":[{"id":"6bb24d94-cd5f-4565-bc29-d7b1b820e88a","name":"200 - success","originalRequest":{"method":"GET","header":[],"url":{"raw":"CHATBOT-URL/api/contacts/USER-ID/messages?limit=3","host":["CHATBOT-URL"],"path":["api","contacts","USER-ID","messages"],"query":[{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"server","value":"Kestrel"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Wed, 24 Nov 2021 18:56:04 GMT"},{"key":"forwarded","value":"host=suristaging-un7.conveyor.cloud; proto=https"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"attachment\": null,\n \"conversationId\": \"wc1797:1819\",\n \"createdAt\": 1637685179209,\n \"id\": \"msg_2QD3C5ZgpJDqu9iqYkRLIQ\",\n \"origin\": \"rest\",\n \"senderId\": null,\n \"text\": \"João Pedro encerrou atendimento\",\n \"type\": \"SystemMessage\"\n },\n {\n \"attachment\": null,\n \"conversationId\": \"wc1797:1819\",\n \"createdAt\": 1629131319437,\n \"id\": \"msg_1RMLjFLaUd34QZKxcVjpF1\",\n \"origin\": \"web\",\n \"senderId\": \"cb1797\",\n \"text\": \"Bom dia, tudo bom? É feriado prolongado por aqui nos 03 a 05 de setembro e toda nossa equipe está descansando, voltamos a partir do dia 06 e entraremos em contato, tá bom? Muito obrigado! 😊🙌\",\n \"type\": \"AgentMessage\"\n }\n ],\n \"error\": null\n}"},{"id":"7e149335-4b2c-4d79-b714-30ad4b91a5a3","name":"404 - bad request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRetorna todas as templates do bot
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"70f5a843-b22d-4629-a55d-638051f86ba7","name":"200 - success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRetorna template pelo id
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates",":template_id"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"{{template_id}}","key":"template_id"}]}},"response":[{"id":"05e7d8ba-4947-4129-9c65-f28801ee6bdf","name":"200 - success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCria template simples - isto é, sem variáveis ou botões
\nEste endpoint é o mesmo utilizado para os demais de criação de template. Dividimos somente para fins didáticos, pois a única mudança são em alguns atributos enviados no BODY.
\nO Body deste endpoint é composto por
\n- \n
- template: Objeto representando a template a ser criada, que tem como campos: \n
- \n
templateExample: String representando um exemplo de corpo da template. No caso de template simples, como não possuem variáveis, deve ser sempre igual ao template.body.
\n \nbodyExamples: Array de exemplos de variável. No caso de template simples, como não possuem variáveis, deve-se enviar array vazio [].
\n \n
O retorno deste endpoint é:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"8f508234-c175-4035-8bdf-ec9e8de28bb1","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCria template com variáveis
\nEste endpoint é o mesmo utilizado para os demais de criação de template. Dividimos somente para fins didáticos, pois a única mudança são em alguns atributos enviados no BODY.
\nO Body deste endpoint é composto por
\n- \n
- template: Objeto representando a template a ser criada, que tem como campos: \n
¹ Variáveis NÃO PODEM conter quebras de linha, TABs ou mais de 4 espaços consecutivos, caso contrário a template será rejeitada pela Meta
\n- \n
templateExample: String representando um exemplo de corpo da template. Deve ser similar ao template.body, porém adicionando no lugar das variáveis, um exemplo de variável preenchida [entre colchetes]
\n- \n
- Exemplo, se o template.body é \"Olá {{1}}, tudo bem?\", templateExample deverá ser \"Olá [Victor], tudo bem?\", substituindo o conteúdo dos colchetes por um exemplo de como tal variável será utilizada na prática \n
\nbodyExamples: Array de exemplos de variável. Basicamente, todos os exemplos utilizados entre colchetes no campo templateExample, devem compor o array
\n- \n
- Utilizando o mesmo exemplo anterior, como templateExample é \"Olá [Victor], tudo bem?\", bodyExamples deverá ser [\"Victor\"] \n
\n
O retorno deste endpoint é:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"101dca37-7d6c-4f2c-85dd-e5d617202b00","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"template\": {\r\n \"title\": \"Iniciando contato teste com variáveis 2\",\r\n \"body\": \"Olá {{1}}. Gostaria de falar com você sobre {{2}}, poderia nos responder para darmos continuidade?\",\r\n \"subject\": \"TESTE\",\r\n \"channelId\": \"wp350628444809181\",\r\n \"category\": \"MARKETING\"\r\n },\r\n \"templateExample\": \"Olá [Victor]. Gostaria de falar com você sobre [seu boleto em atraso], poderia nos responder para darmos continuidade?\",\r\n \"bodyExamples\": [\r\n \"Victor\",\r\n \"seu boleto em atraso\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"CHATBOT-URL/api/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"795"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 26 Mar 2025 18:52:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"$type\": \"ChatbotMaker.BDK.Models.WhatsAppTemplateMessage, ChatbotMaker.BDK\",\n \"isWhatsappTemplate\": true,\n \"channelName\": \"WhatsApp Numero Teste\",\n \"channelId\": \"wp350628444809181\",\n \"channelProvider\": 7,\n \"messageId\": \"1148854936803355\",\n \"messageName\": \"iniciando_contato_teste_com_variaveis_2\",\n \"rejectedReason\": null,\n \"footer\": null,\n \"headerType\": null,\n \"limitedTimeOffer\": null,\n \"subType\": 0,\n \"category\": \"MARKETING\",\n \"templateType\": null,\n \"attachmentsFiles\": [],\n \"variableExamples\": [\n \"Victor\",\n \"seu boleto em atraso\"\n ],\n \"buttons\": [],\n \"status\": 1,\n \"id\": \"cb44358:template:50123\",\n \"chatbotId\": \"cb44358\",\n \"title\": \"Iniciando contato teste com variáveis 2\",\n \"body\": \"Olá {{1}}. Gostaria de falar com você sobre {{2}}, poderia nos responder para darmos continuidade?\",\n \"subject\": \"TESTE\",\n \"parameters\": 2\n },\n \"error\": null\n}"}],"_postman_id":"5c50b0ad-04b2-4e2c-ac56-54b87cd064ea"},{"name":"Criar Template com Botões","id":"b77ffe38-9f27-402f-818d-5af5952ba98f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"template\": {\r\n \"title\": \"Título da template\",\r\n \"body\": \"Corpo da template\",\r\n \"buttons\": [\r\n {\r\n \"text\": \"Ver plano\",\r\n \"type\": 0,\r\n \"url\": \"https://suri.ai/planos/{{1}}\",\r\n \"example\": \"123\"\r\n },\r\n {\r\n \"text\": \"Ligar\",\r\n \"type\": 1,\r\n \"phone\": \"+5585991976502\"\r\n },\r\n {\r\n \"text\": \"Claro!\",\r\n \"type\": 2\r\n },\r\n {\r\n \"text\": \"Não consigo agora\",\r\n \"type\": 2\r\n }\r\n ],\r\n \"subject\": \"Assunto\",\r\n \"channelId\": \"Id do canal\",\r\n \"category\": \"MARKETING\"\r\n },\r\n \"templateExample\": \"Corpo da template\",\r\n \"bodyExamples\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"CHATBOT-URL/api/templates","description":"Cria template com botões
\nEste endpoint é o mesmo utilizado para os demais de criação de template. Dividimos somente para fins didáticos, pois a única mudança são em alguns atributos enviados no BODY.
\nExistem algumas regras para criação de templates com botões:
\n- \n
Template pode ter no máximo 10 botões
\n \nPode ter no máximo 1 botão de LIGAR
\n \nPode ter no máximo 2 botões de URL e eles têm que estar juntos (um pós o outro - por exemplo, não é permitido botão de URL + LIGAR + URL, deve ser LIGAR + URL + URL)
\n \nPode ter quantos botões de RESPOSTA RÁPIDA for necessário contanto que respeite o limite máximo de 10 botões
\n \nOs botões de RESPOSTA RÁPIDA devem sempre ser os últimos, caso utilizados junto com outros tipos de botão, como LIGAR ou URL
\n \n
O Body deste endpoint é composto por
\n- \n
- template: Objeto representando a template a ser criada, que tem como campos: \n
Onde Button é definido da seguinte forma:
\n¹ O telefone do botão de LIGAR deve iniciar com +DDI (em caso de números do Brasil, +55) e devem ter DDD + telefone. Ex: +5585988776655
\n² O link do botão de URL pode ser um link dinâmico, isto é, conter uma variável no final da URL. Ex: se eu quero enviar o site https://site.com/123 mas essa rota final pode ser alterada para '456', por exemplo, basta enviar a url com uma variável como sufixo entre 2 chaves, como em https://site.com/{{1}}
\n³ Ao utilizar um link com variável no final, devemos fornecer um exemplo de como essa variável irá ser preenchida. Como no exemplo anterior, {{1}} pode ser preenchida com '123', então enviamos isso no example
\n- \n
templateExample: String representando um exemplo de corpo da template. Se a template não possuir variáveis, deve ser sempre igual ao template.body.
\n \nbodyExamples: Array de exemplos de variável. Se a template não possuir variáveis, deve-se enviar array vazio [].
\n \n
O retorno deste endpoint é:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"d18cb35b-fb2c-4d53-ab4e-a75e747fdd00","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"template\": {\r\n \"title\": \"Iniciando contato com botões\",\r\n \"body\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\r\n \"buttons\": [\r\n {\r\n \"text\": \"Ver plano\",\r\n \"type\": 0,\r\n \"url\": \"https://suri.ai/planos/{{1}}\",\r\n \"example\": \"123\"\r\n },\r\n {\r\n \"text\": \"Ligar\",\r\n \"type\": 1,\r\n \"phone\": \"+5585991976502\"\r\n },\r\n {\r\n \"text\": \"Claro!\",\r\n \"type\": 2\r\n },\r\n {\r\n \"text\": \"Não consigo agora\",\r\n \"type\": 2\r\n }\r\n ],\r\n \"subject\": \"TESTE\",\r\n \"channelId\": \"wp350628444809181\",\r\n \"category\": \"MARKETING\"\r\n },\r\n \"templateExample\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\r\n \"bodyExamples\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"CHATBOT-URL/api/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1230"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 26 Mar 2025 18:10:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"$type\": \"ChatbotMaker.BDK.Models.WhatsAppTemplateMessage, ChatbotMaker.BDK\",\n \"isWhatsappTemplate\": true,\n \"channelName\": \"WhatsApp Numero Teste\",\n \"channelId\": \"wp350628444809181\",\n \"channelProvider\": 7,\n \"messageId\": \"4134822173506105\",\n \"messageName\": \"iniciando_contato_com_botoes\",\n \"rejectedReason\": null,\n \"footer\": null,\n \"headerType\": null,\n \"limitedTimeOffer\": null,\n \"subType\": 0,\n \"category\": \"MARKETING\",\n \"templateType\": null,\n \"attachmentsFiles\": [],\n \"variableExamples\": [],\n \"buttons\": [\n {\n \"$type\": \"ChatbotMaker.BDK.Models.TemplateButtonUrl, ChatbotMaker.BDK\",\n \"url\": \"https://suri.ai/planos/{{1}}\",\n \"example\": \"123\",\n \"type\": 0,\n \"text\": \"Ver plano\"\n },\n {\n \"$type\": \"ChatbotMaker.BDK.Models.TemplateButtonNumber, ChatbotMaker.BDK\",\n \"phone\": \"+5585991976502\",\n \"type\": 1,\n \"text\": \"Ligar\"\n },\n {\n \"$type\": \"ChatbotMaker.BDK.Models.Gupshup.TemplateButtonReply, ChatbotMaker.BDK\",\n \"type\": 2,\n \"text\": \"Claro!\"\n },\n {\n \"$type\": \"ChatbotMaker.BDK.Models.Gupshup.TemplateButtonReply, ChatbotMaker.BDK\",\n \"type\": 2,\n \"text\": \"Não consigo agora\"\n }\n ],\n \"status\": 1,\n \"id\": \"cb44358:template:50114\",\n \"chatbotId\": \"cb44358\",\n \"title\": \"Iniciando contato com botões\",\n \"body\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\n \"subject\": \"TESTE\",\n \"parameters\": 0\n },\n \"error\": null\n}"}],"_postman_id":"b77ffe38-9f27-402f-818d-5af5952ba98f"},{"name":"Criar Template com Arquivo","id":"e6354d14-4cd1-4166-9f37-bee7955e270a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"template\": {\r\n \"title\": \"Título da template\",\r\n \"body\": \"Corpo da template\",\r\n \"subject\": \"TESTE\",\r\n \"channelId\": \"Id do canal\",\r\n \"category\": \"MARKETING | UTILITY\",\r\n \"headerType\": 0\r\n },\r\n \"templateExample\": \"Corpo da template\",\r\n \"bodyExamples\": [],\r\n \"sampleFile\": {\r\n \"url\": \"https://cbmstg.blob.core.windows.net/chatbots/cb46398932/logo-whatsapp.png\",\r\n \"fileName\": \"logo-whatsapp.png\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"CHATBOT-URL/api/templates","description":"Cria template com arquivo no cabeçalho
\nEste endpoint é o mesmo utilizado para os demais de criação de template. Dividimos somente para fins didáticos, pois a única mudança são em alguns atributos enviados no BODY.
\nO Body deste endpoint é composto por
\n- \n
- template: Objeto representando a template a ser criada, que tem como campos: \n
- \n
templateExample: String representando um exemplo de corpo da template. Se não possuir variáveis, deve ser sempre igual ao template.body.
\n \nbodyExamples: Array de exemplos de variável. Se não possuir variáveis, deve-se enviar array vazio [].
\n \nsampleFile: Arquivo padrão da template, isto é, ao enviar pelo Portal, ele será listado e o atendente pode apenas selecioná-lo ao invés de enviar um novo arquivo (segue imagem abaixo). É um objeto que tem a seguinte estrutura:
\n \n
*Um dos atributos url ou base64File devem ser enviados. Se ambos forem passados, a prioridade é utilizar url.
\nO retorno deste endpoint é:
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","templates"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"75dacb02-83f1-49bb-b160-d3e9df21d4ec","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"template\": {\r\n \"title\": \"Iniciando contato teste com cabeçalho 2\",\r\n \"body\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\r\n \"subject\": \"TESTE\",\r\n \"channelId\": \"wp350628444809181\",\r\n \"category\": \"MARKETING\",\r\n \"headerType\": 0\r\n },\r\n \"templateExample\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\r\n \"bodyExamples\": [],\r\n \"sampleFile\": {\r\n \"url\": \"https://cbmstg.blob.core.windows.net/chatbots/cb46398932/logo-whatsapp.png\",\r\n \"fileName\": \"logo-whatsapp.png\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"CHATBOT-URL/api/templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"897"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 26 Mar 2025 17:41:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"$type\": \"ChatbotMaker.BDK.Models.WhatsAppTemplateMessage, ChatbotMaker.BDK\",\n \"isWhatsappTemplate\": true,\n \"channelName\": \"WhatsApp Numero Teste\",\n \"channelId\": \"wp350628444809181\",\n \"channelProvider\": 7,\n \"messageId\": \"676451034861611\",\n \"messageName\": \"iniciando_contato_teste_com_cabecalho_2\",\n \"rejectedReason\": null,\n \"footer\": null,\n \"headerType\": 0,\n \"limitedTimeOffer\": null,\n \"subType\": 0,\n \"category\": \"MARKETING\",\n \"templateType\": null,\n \"attachmentsFiles\": [\n {\n \"url\": \"https://cbmstgstaging.blob.core.windows.net/content/cb44358/templates/cb44358:template:50103/logo-whatsapp.png\",\n \"fileName\": \"logo-whatsapp.png\"\n }\n ],\n \"variableExamples\": [],\n \"buttons\": [],\n \"status\": 1,\n \"id\": \"cb44358:template:50103\",\n \"chatbotId\": \"cb44358\",\n \"title\": \"Iniciando contato teste com cabeçalho 2\",\n \"body\": \"Este é um teste de inicio de contato, poderia nos responder para darmos continuidade?\",\n \"subject\": \"TESTE\",\n \"parameters\": 0\n },\n \"error\": null\n}"}],"_postman_id":"e6354d14-4cd1-4166-9f37-bee7955e270a"}],"id":"173d2992-079e-4cd0-aa8c-d942af1e1eb9","_postman_id":"173d2992-079e-4cd0-aa8c-d942af1e1eb9","description":"","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}}},{"name":"Campanhas","item":[{"name":"Nova Campanha","id":"60a01920-7fdd-4501-be30-557db60f0be6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CampaignName\": \"Teste API\",\n \"ChannelId\": \"Cria uma nova campanha
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"69ea139c-e212-4949-9215-6c430005a12c","name":"Nova Campanha","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"CampaignName\": \"Teste API\",\n \"ChannelId\": \"Retorna informações sobre a campanha especificada
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns",":id"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"string","key":"id"}]}},"response":[{"id":"ce839ae2-0446-49ad-a874-dcff85f812c6","name":"Métricas da Campanha","originalRequest":{"method":"GET","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id","host":["CHATBOT-URL"],"path":["api","campaigns",":id"],"variable":[{"key":"id","value":"cb64191"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"891"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:43:34 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"cb6491\",\n \"chatbotId\": \"cb4358\",\n \"name\": \"Nome da Campanha\",\n \"channelId\": \"wp350628449181\",\n \"when\": \"2026-02-10T12:41:47.739Z\",\n \"expiration\": \"2026-02-11T12:41:00Z\",\n \"expirationFlowId\": \"\",\n \"scheduled\": false,\n \"scheduledJobId\": null,\n \"status\": 5,\n \"totalContacts\": 1,\n \"totalSent\": 1,\n \"totalDelivered\": 1,\n \"totalRead\": 0,\n \"totalErrors\": 0,\n \"totalAnswered\": 0,\n \"totalExpired\": 0,\n \"processingErrors\": [],\n \"actions\": [\n {\n \"type\": 0,\n \"templateId\": \"cb4438:template:5003\",\n \"templateFile\": null,\n \"templateOfferExpiration\": null,\n \"templateName\": null,\n \"templateCategory\": null\n }\n ],\n \"dateCreate\": \"2026-02-10T09:41:47.0099259Z\",\n \"createdByPlatformUserId\": \"cb117\",\n \"dateStart\": \"2026-02-10T12:42:00.0721808Z\",\n \"startedByPlatformUserId\": null,\n \"dateCancel\": \"0001-01-01T00:00:00Z\",\n \"cancelledByPlatformUserId\": null,\n \"response\": {\n \"type\": 0,\n \"sendTo\": \"cb44359\",\n \"ignorePortfolio\": false\n },\n \"buttonsResponse\": []\n },\n \"error\": null,\n \"validationErrors\": null\n}"}],"_postman_id":"fa2f7edd-e47f-4ef3-9a9c-248b8af2b234"},{"name":"Contatos da Campanha","id":"b486b0b5-c66d-4d96-ae20-75c4bc15d20e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"CHATBOT-URL/api/campaigns/:id/export","description":"Retorna informações sobre os usuários da campanha
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","export"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"string","key":"id"}]}},"response":[{"id":"6651c0f6-bedc-48e1-b80c-711806e30bfc","name":"Contatos da Campanha","originalRequest":{"method":"GET","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/export","host":["CHATBOT-URL"],"path":["api","campaigns",":id","export"],"variable":[{"key":"id","value":"cb64191"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"245"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:42:55 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"Número\": \"5571910385\",\n \"Nome\": \"John Brown\",\n \"Status\": \"Entregue\",\n \"Mensagem de erro\": null,\n \"Parametros\": \"Parâmetro de template 1\",\n \"Variaveis\": {\n \"variavel_Usuario_1\": \"valorTeste1\"\n }\n }\n ],\n \"error\": null,\n \"validationErrors\": null\n}"}],"_postman_id":"b486b0b5-c66d-4d96-ae20-75c4bc15d20e"},{"name":"Iniciar Campanha","id":"1233ca01-7ad0-4466-ad5d-fb250bf4b43a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"CHATBOT-URL/api/campaigns/:id/start","description":"Inicia uma campanha que está em espera
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","start"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"string","key":"id"}]}},"response":[{"id":"52e1682f-3178-4b8d-8e63-ea0928a4b559","name":"Iniciar Campanha","originalRequest":{"method":"PUT","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/start","host":["CHATBOT-URL"],"path":["api","campaigns",":id","start"],"variable":[{"key":"id","value":"cb63305"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"81"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:39:54 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": null,\n \"error\": \"No Campaign Found\",\n \"validationErrors\": null\n}"},{"id":"39e51b60-1817-4de1-af93-ec4f1f793bfa","name":"Iniciar Campanha","originalRequest":{"method":"PUT","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/start","host":["CHATBOT-URL"],"path":["api","campaigns",":id","start"],"variable":[{"key":"id","value":"cb63305"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"117"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:40:55 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": null,\n \"error\": \"Campaign already started or still in processing state\",\n \"validationErrors\": null\n}"},{"id":"4cdbc555-80ea-4aaf-819c-af1865b38084","name":"Iniciar Campanha","originalRequest":{"method":"PUT","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/start","host":["CHATBOT-URL"],"path":["api","campaigns",":id","start"],"variable":[{"key":"id","value":"cb64191"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"883"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:41:59 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": \"cb641\",\n \"chatbotId\": \"cb443\",\n \"name\": \"Campanha\",\n \"channelId\": \"wp350628444\",\n \"when\": \"2026-02-10T12:41:47.739Z\",\n \"expiration\": \"2026-02-11T12:41:00Z\",\n \"expirationFlowId\": \"\",\n \"scheduled\": false,\n \"scheduledJobId\": null,\n \"status\": 1,\n \"totalContacts\": 1,\n \"totalSent\": 0,\n \"totalDelivered\": 0,\n \"totalRead\": 0,\n \"totalErrors\": 0,\n \"totalAnswered\": 0,\n \"totalExpired\": 0,\n \"processingErrors\": [],\n \"actions\": [\n {\n \"type\": 0,\n \"templateId\": \"cb4438:template:5003\",\n \"templateFile\": null,\n \"templateOfferExpiration\": null,\n \"templateName\": null,\n \"templateCategory\": null\n }\n ],\n \"dateCreate\": \"2026-02-10T09:41:47.0099259Z\",\n \"createdByPlatformUserId\": \"cb115\",\n \"dateStart\": \"0001-01-01T00:00:00Z\",\n \"startedByPlatformUserId\": null,\n \"dateCancel\": \"0001-01-01T00:00:00Z\",\n \"cancelledByPlatformUserId\": null,\n \"response\": {\n \"type\": 0,\n \"sendTo\": \"cb4435\",\n \"ignorePortfolio\": false\n },\n \"buttonsResponse\": []\n },\n \"error\": null,\n \"validationErrors\": null\n}"}],"_postman_id":"1233ca01-7ad0-4466-ad5d-fb250bf4b43a"},{"name":"Listar Campanhas","id":"d303d248-068e-4b9e-898c-a430acbed6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"CHATBOT-URL/api/campaigns","description":"Inicia uma campanha que está em espera
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"69634ff0-7de4-417b-8532-169f8ea3011d","name":"Listar Campanhas","originalRequest":{"method":"GET","header":[],"url":"CHATBOT-URL/api/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Content-Length","value":"243150"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:47:42 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"cb47797\",\n \"chatbotId\": \"cb44358\",\n \"name\": \"Teste Campanha Antiga\",\n \"channelId\": \"wp350628444809181\",\n \"when\": \"2024-10-26T21:57:09.865Z\",\n \"expiration\": null,\n \"expirationFlowId\": null,\n \"scheduled\": false,\n \"scheduledJobId\": null,\n \"status\": 5,\n \"totalContacts\": 2,\n \"totalSent\": 2,\n \"totalDelivered\": 2,\n \"totalRead\": 2,\n \"totalErrors\": 0,\n \"totalAnswered\": 1,\n \"totalExpired\": 0,\n \"processingErrors\": [],\n \"actions\": [\n {\n \"type\": 0,\n \"templateId\": \"cb44358:template:46467\",\n \"templateFile\": null,\n \"templateOfferExpiration\": null,\n \"templateName\": null,\n \"templateCategory\": null\n }\n ],\n \"dateCreate\": \"2024-10-26T18:57:10.2421942Z\",\n \"createdByPlatformUserId\": \"cb1036\",\n \"dateStart\": \"2024-10-26T21:58:43.1985064Z\",\n \"startedByPlatformUserId\": null,\n \"dateCancel\": \"0001-01-01T00:00:00\",\n \"cancelledByPlatformUserId\": null,\n \"response\": {\n \"type\": 0,\n \"sendTo\": \"cb44359\",\n \"ignorePortfolio\": false\n },\n \"buttonsResponse\": []\n },\n {\n \"id\": \"cb47798\",\n \"chatbotId\": \"cb44358\",\n \"name\": \"Teste campanha antiga 2\",\n \"channelId\": \"wp350628444809181\",\n \"when\": \"2024-10-26T22:05:34.422Z\",\n \"expiration\": null,\n \"expirationFlowId\": null,\n \"scheduled\": false,\n \"scheduledJobId\": null,\n \"status\": 5,\n \"totalContacts\": 2,\n \"totalSent\": 2,\n \"totalDelivered\": 2,\n \"totalRead\": 2,\n \"totalErrors\": 0,\n \"totalAnswered\": 2,\n \"totalExpired\": 0,\n \"processingErrors\": [],\n \"actions\": [\n {\n \"type\": 0,\n \"templateId\": \"cb44358:template:46467\",\n \"templateFile\": null,\n \"templateOfferExpiration\": null,\n \"templateName\": null,\n \"templateCategory\": null\n }\n ],\n \"dateCreate\": \"2024-10-26T19:05:35.0469394Z\",\n \"createdByPlatformUserId\": \"cb1036\",\n \"dateStart\": \"2024-10-26T22:06:02.6592996Z\",\n \"startedByPlatformUserId\": null,\n \"dateCancel\": \"0001-01-01T00:00:00\",\n \"cancelledByPlatformUserId\": null,\n \"response\": {\n \"type\": 0,\n \"sendTo\": \"cb44359\",\n \"ignorePortfolio\": false\n },\n \"buttonsResponse\": []\n }\n ],\n \"error\": null,\n \"validationErrors\": null\n}"}],"_postman_id":"d303d248-068e-4b9e-898c-a430acbed6b7"},{"name":"Cancelar Campanha","id":"added8a8-8868-4a14-a24a-e42db1604ba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"CHATBOT-URL/api/campaigns/:id/cancel","description":"Cancela uma campanha que está em estádo de espera ou sendo executada
\nStartFragment
\nEndFragment
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","cancel"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"cb6419","key":"id"}]}},"response":[{"id":"239d7bf7-5ba2-4304-91b2-d9f46adf38bb","name":"Cancelar Campanha","originalRequest":{"method":"PUT","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/cancel","host":["CHATBOT-URL"],"path":["api","campaigns",":id","cancel"],"variable":[{"key":"id","value":"cb64192"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"65"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:46:12 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": null,\n \"validationErrors\": null\n}"},{"id":"ee70d353-c883-42ad-a1f7-a92f5d1ae11e","name":"Cancelar Campanha","originalRequest":{"method":"PUT","header":[],"url":{"raw":"CHATBOT-URL/api/campaigns/:id/cancel","host":["CHATBOT-URL"],"path":["api","campaigns",":id","cancel"],"variable":[{"key":"id","value":"cb6419"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"Content-Length","value":"81"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 10 Feb 2026 12:46:22 GMT"},{"key":"Server","value":"Kestrel"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"data\": null,\n \"error\": \"No Campaign Found\",\n \"validationErrors\": null\n}"}],"_postman_id":"added8a8-8868-4a14-a24a-e42db1604ba4"}],"id":"d5645af8-bed2-4843-a3e1-ee12b20b32ab","_postman_id":"d5645af8-bed2-4843-a3e1-ee12b20b32ab","description":"","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}}},{"name":"Shop","item":[{"name":"Categories","item":[{"name":"Criar categoria","id":"07e2d2db-9bb6-4902-aad4-b0089461f284","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"12345\",\n \"name\": \"Teste\",\n \"description\": \"Categoria para dispositivos eletrônicos\",\n \"children\": [\n {\n \"id\": \"123\",\n \"name\": \"Sub 1\",\n \"description\": \"Subcategoria para smartphones\",\n \"children\": []\n },\n {\n \"id\": \"123\",\n \"name\": \"Sub 2 \",\n \"description\": \"Subcategoria para tablets\",\n \"children\": []\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"CHATBOT-URL/api/shop/categories","description":"Uma vez criada, será retornado o Id dessa categoria do lado da Suri, o que permitirá acesso futuro a esse item para busca e modificação.
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","categories"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"7df78c52-97bc-422c-afb3-aac234b139ef","name":"201 - created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerOs produtos possuem a propriedade Dimensions, é importante que Dimensions estejam de acordo com Attributes, nela poderão ser definidas os SKUs referentes ao produto, estoques e preços por loja.
\nO item será salvo do lado da SURI com o mesmo id passado.
\nOBS.: Para criar um produto, é necessário que a categoria a qual esse produto fará parte já esteja criada, caso o contrário, não será possível a criação do produto.
\nEstrutura do Objeto JSON
\nEstrutura do Objeto JSON
\nCampos Principais
\n\n
Estrutura de ShopBrand
\n\n
Estrutura de Image
\n\n
Estrutura de Attribute
\nEstrutura de Option
\n\n
Estrutura de Dimension
\nEstrutura de StockMap
\n\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","products"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"b82c3c9d-09a2-4919-9e34-44e0797777f9","name":"Criar Produto","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer
Descrição do Endpoint
\nEste endpoint permite a execução de operações em lote para produtos, incluindo a possibilidade de deletar produtos com base em seus identificadores. O máximo de requisições permitidas por chamada é de 200.
\nEstrutura do Objeto JSON
\nCampos Principais
\nEstrutura de Data
\nO data deve sempre ser passado o \"id\" -> Id do produto, os outros campos obrigatórios fica de acordo com o type informado.
\n\n
Resposta
\nA resposta do endpoint contém informações sobre o sucesso da operação, dados adicionais e possíveis erros.
\nEstrutura da Resposta
\n\n
Response
\n{\n \"success\": true,\n \"data\": \"batch_350d4efe9a374ef6bc4089d4d7e22636\",\n \"error\": null,\n \"errorCode\": null\n}\nAPI Request Description
\nThis endpoint retrieves the results of a batch request for products based on the provided batch_id. It returns a response indicating the success of the request along with detailed information about each product request made in the batch.
The response will include the following fields:
\n- \n
\nsuccess: A boolean indicating whether the batch request was successful. \n
\ndata: An object containing:- \n
\nid: The identifier for the batch request. \n
\nrequests: An array of objects, each representing an individual product request with the following fields:- \n
\nproductId: The unique identifier of the product. \n
\nstatus: The current status of the request (e.g., processed, pending). \n
\nupdatedAt: A timestamp indicating when the request was last updated. \n
\nerrorMessage: Any error message associated with the request, if applicable. \n
\n
\nisCompleted: A boolean indicating whether all requests in the batch have been completed. \n
\nfinishedAt: A timestamp indicating when the batch processing finished. \n
\n
In case of an error, the response will also include:
\n- \n
\nerror: A message detailing the error, if any occurred during processing. \n
\nerrorCode: A code representing the type of error encountered. \n
Example Response
\n{\n \"success\": true,\n \"data\": {\n \"id\": \"\",\n \"requests\": [\n {\n \"productId\": \"\",\n \"status\": \"\",\n \"updatedAt\": 0,\n \"errorMessage\": null\n }\n ],\n \"isCompleted\": true,\n \"finishedAt\": 0\n },\n \"error\": null,\n \"errorCode\": null\n}\n\nImportant Notes
\n- \n
Ensure that the
\nbatch_idprovided corresponds to a valid batch request. \nThe endpoint will return a 200 status code if the request is successful.
\n \n
JSON Object Structure
\nMain Fields
\n\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","products","batch",":bach_id"],"host":["CHATBOT-URL"],"query":[],"variable":[{"type":"any","value":"batch_a52017bf4a704b1b9adc2d5e0a426c60","key":"bach_id"}]}},"response":[{"id":"d4d99d7d-a909-4700-b8cd-a4c58bef186e","name":"201 - created","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer
Para modificar um produto será necessário passar o id dele no lado da Suri, caso ele não seja encontrado, será retornado um erro
\nEsse endpoint é de update total, é necessário que seja feito o envio do objeto completo para não sobrescrever dados.
\nAs imagens serão atualizadas se receber um array, para limpar é necessário enviar com \"Images: null\".
Para as imagens de variante, para limpar é necessário enviar um image.url: \"\"
Ativar ou desativar um produto. É necessário passar o id dele, caso ele não seja encontrado, será retornado um erro.
\nParamêtro status deve ser true ou false.
ShopOrderFilter
\n\n
ShopCustomer
\n\n
PlatformUserAction
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","orders"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"fdb0f46a-b2a3-4feb-ae81-f064ff55cdb0","name":"200 - ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAssim como no recebimento dos status via webhook, o pedido também pode ter a logística atualizada diretamente pela API.
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","orders","logistic"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"a11f6e46-8228-4f44-99ed-f39ca8680039","name":"Atualizar status pedido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGateway de pagamento via API
\nCadastro
\nAgora também existe a possibilidade de criação de pagamentos em uma API externa. Basta cadastrar na plataforma da SURI uma conta de pagamento do tipo API EXTERNA, onde, durante o processo de compra, essa API será chamada para que seja retornado a opção de pagamento, seja ele PIX (Chave copia e cola) ou Cartão (Link de checkout externo).
\nAo clicar, será direcionado para a próxima tela:
\nAqui você pode adicionar:
\n- \n
O nome referente a essa conta;
\n \nO endpoint que será chamado para buscar as informações de pagamento;
\n \nE os headers que serão enviados juntos com request, caso necessário.
\n \n
Obs.: Ao clicar em salvar, será feita uma requisição(GET) para o endpoint cadastrado, onde é esperado receber o Status Code 200 como resposta, somente assim as configurações serão salvas.
\nProcesso de compra
\nDurante o processo de compra, estará disponível para o cliente as opções de pagamento (Pix e Cartão), ao clicar, será feita uma requisição(POST) para o endpoint cadastrado como no exemplo abaixo:
\nApiGatewayOrderPaymentInfoRequest
\ncurl -X POST \"https://SEU_BASE_URL_AQUI\" \\\n -H \"Content-Type: application/json\" \\\n -H \"Accept: application/json\" \\\n -H \"<HEADERS CADASTRADOS>\" \\\n -d '{\n \"paymentMethod\": 0,\n \"order\": {\n \"id\": \"49925\",\n \"friendlyCode\": null,\n \"chatbotId\": \"cb5584\",\n \"userId\": \"wpclicb55840:5585982387333\",\n \"channelId\": \"wpclicb55840\",\n \"sessionId\": \"d10e57cce5ee415796410947da75094d\",\n \"isInSemiAutomatic\": false,\n \"providerTransactionId\": null,\n \"providerSellerId\": null,\n \"status\": 3,\n \"seller\": null,\n \"customer\": null,\n \"logistic\": null,\n \"payment\": null,\n \"itemsAmount\": 0,\n \"feeAmount\": 0,\n \"appliedDiscountBase\": null,\n \"discountAmount\": 0,\n \"orderDiscountAmount\": 0,\n \"totalAmount\": 0,\n \"coupon\": null,\n \"isRebuy\": false,\n \"items\": [],\n \"creator\": 0,\n \"platformUser\": null,\n \"requestAssistance\": false,\n \"requestAssistanceDate\": null,\n \"requestAssistanceBy\": 0,\n \"assistanceAttendanceId\": null,\n \"hasAssistance\": false,\n \"createdDate\": \"2025-03-17T20:42:05.1920325Z\",\n \"receivedDate\": null,\n \"finalizedDate\": null,\n \"canceledDate\": \"2025-03-18T13:04:16.7594912Z\",\n \"canceledBy\": 0,\n \"canceledReason\": null,\n \"errorDate\": null,\n \"message\": null,\n \"recaptchaKey\": null,\n \"problems\": 0,\n \"problem\": 0,\n \"errorMessages\": [],\n \"catalogErrorMessages\": [],\n \"step\": 1,\n \"minOrderValue\": null,\n \"satisfactionSurvey\": {\n \"grade\": 0,\n \"comment\": null\n },\n \"lastNotification\": 0,\n \"isExternalOrder\": false,\n \"isRecoveredOrder\": true,\n \"isAcceptedOrderRecovery\": false,\n \"itemsReserved\": false,\n \"useGenerativeAI\": false,\n \"settings\": {\n \"initialCatalogType\": 0,\n \"initialCatalogId\": null\n },\n \"isInEditMode\": false,\n \"orderHash\": null,\n \"origin\": null,\n \"referral\": null\n }\n }'\n\nComo resposta, a API deve retornar:
\nApiGatewayOrderPaymentInfoResponse
\nOBS.:
\n- \n
PIX deve retornar pelo menos uma das duas opções (Link ou Código)
\n \nCartão deve sempre retornar um Link externo
\n{\n \"paymentLink\": \"https://pagamentos.exemplo.com/pay/abc123\",\n \"paymentCode\": \"ABC123\",\n \"paymentId\": \"pay_789xyz\"\n }\n\nUpdate do pedido
\n \n
Para fazer atualizações do status do pedido, deve ser enviado uma requisição a para:CHATBOT-URL/api/shop/orders/payment seguindo o mesmo padrão de autenticação das demais rotas da API (Bearer token, utilizando o mesmo token das outras requisições)
Passando como body:
\n{\n \"orderId\": \"49925\",\n \"paymentStatus\": \"Paid\",\n \"orderStatus\": \"Finalized\"\n}\n\n🪙 Possíveis valores de ShopPaymentStatus
\n📦 Possíveis valores de ShopOrderStatus
\n","_postman_id":"ab3f54b6-9e7e-4e83-8405-180d0fa3b6e0","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}}},{"name":"Clientes","item":[{"name":"Importar/Atualizar cliente","id":"99d34cf4-8fb8-42c4-a9a6-13a5f2945180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"providerId\": \"CLI-001\",\n \"phone\": \"5585987755801\",\n \"channelId\": \"wp332148629991857\",\n \"channelType\": 1,\n \"name\": \"João da Silva\",\n \"email\": \"joao@email.com\",\n \"gender\": 0,\n \"identificationDocument\": \"123456789\",\n \"personalDocument\": \"12345678900\",\n \"corporateDocument\": \"12345678000100\",\n \"birthDate\": \"1990-05-15\",\n \"isCorporate\": false,\n \"corporateName\": null,\n \"tradeName\": null,\n \"note\": \"Cliente VIP\",\n \"defaultDepartmentId\": null,\n \"defaultAgentId\": null,\n \"variables\": {\n \"origem\": \"ecommerce\",\n \"plano\": \"premium\"\n },\n \"stateInscription\": null,\n \"addresses\": [\n {\n \"name\": \"Casa\",\n \"street\": \"Rua das Flores\",\n \"number\": \"123\",\n \"complement\": \"Apto 45\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Fortaleza\",\n \"state\": \"CE\",\n \"zipCode\": \"60000000\",\n \"country\": \"BR\"\n }\n ],\n \"fiscalAddresses\": null,\n \"canEditUserDocuments\": true,\n \"canEditUserAddresses\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"CHATBOT-URL/api/shop/users","description":"Cria ou atualiza um cliente no sistema. Se o cliente já existir (identificado por phone + channelId ou por userId), os dados informados serão atualizados. Caso contrário, um novo contato será criado.
A identificação do cliente pode ser feita de duas formas:
\n- \n
Por telefone: envie
\nphone,channelIdechannelType. Se o contato não existir, será criado automaticamente. \nPor ID: envie
\nuserIddiretamente. O contato já deve existir. \n
Dados do cliente
\nDados para o processo de compra
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","users"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"d9b1e5d4-fad4-4fcf-be2c-b9196080ce8c","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRetorna os dados completos de um cliente, incluindo informações do contato e dados para o processo de compra.
\nParâmetros de rota
\nRetorno
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","users",":userId"],"host":["CHATBOT-URL"],"query":[],"variable":[{"id":"296eac9d-e779-4b21-8070-4c96d7421bf7","description":{"content":"ID do cliente (formato: channelId:phone)
\n","type":"text/plain"},"type":"any","value":"wp332148629991857:5585987755801","key":"userId"}]}},"response":[{"id":"eafe2997-e8a2-4d81-9ae7-e7791ca37497","name":"200 - success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerExemplo de uso do mesmo endpoint de importação utilizando userId ao invés de phone + channelId. Quando userId é fornecido, o contato já deve existir — os campos phone, channelId e channelType são ignorados.
Útil quando você já possui o ID do cliente e deseja apenas atualizar os dados.
\n","auth":{"type":"bearer","bearer":{"token":"SHOP_TOKEN"},"isInherited":true,"source":{"_postman_id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","id":"08e2e338-ea76-4d5a-9cee-7feeaa63f4e3","name":"Shop","type":"folder"}},"urlObject":{"path":["api","shop","users"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"519b6ceb-aec0-4a50-bb56-dca9fe8dc0e7","name":"200 - success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerLista histórico de atendimentos do chatbot para fins de métricas, podendo opcionalmente também retornar os contatos que atualmente estão Esperando ou Em atendimento.
\nO filtro consiste no seguinte objeto:
\n","urlObject":{"path":["api","attendances"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"5065f272-839e-4897-bb9b-af9e1b9bf1da","name":"200 - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerLista todos os fluxos conversacionais do chatbot, definidos na tela de fluxos do Portal.
\n","auth":{"type":"bearer","bearer":{"token":"CHABOT-TOKEN"},"isInherited":true,"source":{"_postman_id":"b620644f-3971-4e54-97f3-5f581b67df79","id":"b620644f-3971-4e54-97f3-5f581b67df79","name":"APIs","type":"folder"}},"urlObject":{"path":["api","flows"],"host":["CHATBOT-URL"],"query":[],"variable":[]}},"response":[{"id":"61b174be-0cfc-4851-ac99-4be1cbaedc8c","name":"200 - OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerWebhooks
\nExistem 5 tipos de eventos que podem ser entregues no seu webhook, eles são:
\n- \n
new-contact
\n \nchange-queue
\n \nfinish-attendance
\n \nmessage-received
\n \nmessage-sent
\n \n
O estrutura abaixo é a base de todos os eventos. O informação em payload muda de acordo com o respectivo tipo de evento, que são descritos na próxima seção.
\n{\n \"id\": \"cb1000000\",\n \"type\": \"new-contact\",\n \"timestamp\":1580142086287,\n \"payload\": \n}\n\nEventos
\nNovo contato (new-contact)
\n{\n ...\n \"payload\": \n}\n\nTroca de fila (change-queue)
\n{\n ...\n \"payload\": {\n \"from\": \"automatic\",\n \"to\": \"waiting\",\n \"user\": ,\n \"attendant\": \n }\n}\n\nFinalização de atendimento (finish-attandance)
\n{\n ...\n \"payload\": {\n \"attendanceTime\": 245,\n \"departmentId\": \"cbxxxxxx\",\n \"tags\": [\"tag1\", \"tag2\"],\n \"user\": ,\n \"attendant\": ,\n \"messages\":Array\n }\n}\n\nMensagem Recebida (message-received)
\n{\n ...\n \"payload\"{\n \"user\": ...,\n \"message\": ...\n }\n}\n\nMensagem Enviada (message-sent)
\n{\n ...\n \"payload\": {\n \"user\": ...,\n \"channel\": ...,\n \"message\": ...,\n \"messageId\": ...,\n \"attendant\": ...\n }\n}\n\nUser
\nSession
\nChannelType
\nBlob
\nGenderType
\nAttendant
\nMessage
\nCustomData
\nMensagem modelo (Template)
\nAttachmentFile
\nTemplateButton
\nMessageOut (Mensagem enviada)
\nVeja abaixo cada um dos tipos citados na tabela acima:
\n