{"id":15285578,"url":"https://github.com/leguass7/maxbotjs","last_synced_at":"2026-04-18T11:02:20.527Z","repository":{"id":53712005,"uuid":"311778184","full_name":"leguass7/maxbotjs","owner":"leguass7","description":"Library for connect to MAXBOT","archived":false,"fork":false,"pushed_at":"2021-03-18T19:37:42.000Z","size":649,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-21T22:38:12.758Z","etag":null,"topics":["api","maxbot","nodejs","package","whatsapp"],"latest_commit_sha":null,"homepage":"https://github.com/leguass7/maxbotjs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leguass7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-10T20:35:07.000Z","updated_at":"2021-03-18T19:37:45.000Z","dependencies_parsed_at":"2022-09-03T02:31:22.740Z","dependency_job_id":null,"html_url":"https://github.com/leguass7/maxbotjs","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/leguass7/maxbotjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leguass7%2Fmaxbotjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leguass7%2Fmaxbotjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leguass7%2Fmaxbotjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leguass7%2Fmaxbotjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leguass7","download_url":"https://codeload.github.com/leguass7/maxbotjs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leguass7%2Fmaxbotjs/sbom","scorecard":{"id":583321,"data":{"date":"2025-08-11","repo":{"name":"github.com/leguass7/maxbotjs","commit":"59640a53290dc0893426b6d401250a54a00ca507"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/27 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/leguass7/maxbotjs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/leguass7/maxbotjs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/leguass7/maxbotjs/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/leguass7/maxbotjs/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/leguass7/maxbotjs/ci.yml/master?enable=pin","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"37 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T19:46:08.602Z","repository_id":53712005,"created_at":"2025-08-20T19:46:08.602Z","updated_at":"2025-08-20T19:46:08.602Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31966217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","maxbot","nodejs","package","whatsapp"],"created_at":"2024-09-30T15:06:20.207Z","updated_at":"2026-04-18T11:02:20.471Z","avatar_url":"https://github.com/leguass7.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"/.github/maxbotjs.svg\" height=\"120\" width=\"90\" alt=\"maxbotjs\" /\u003e\u003c/p\u003e\n\n![standard-image](https://img.shields.io/badge/code%20style-standard-brightgreen.svg) [![NPM](https://img.shields.io/npm/v/maxbotjs.svg)](https://www.npmjs.com/package/maxbotjs) [![Coverage Status](https://coveralls.io/repos/github/leguass7/maxbotjs/badge.svg?branch=master)](https://coveralls.io/github/leguass7/maxbotjs?branch=master) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n# maxbotjs\n \u003e Biblioteca (não oficial) **nodejs** de integração com [MAXBOT](https://maxbot.com.br)\n Por favor, visite o site oficial para entender como funciona.\n\n### O que é MAXBOT?\nÉ uma empresa que trabalha com uma ferramenta completa de atendimento automatizado via WhatsApp.\n\n### Documentação de referência\n- [Site oficial](https://maxbot.com.br)\n- [Docs API](https://mbr.maxbot.com.br/doc-api-v1.php)\n- [Termos de uso](https://mbr.maxbot.com.br/termos-de-uso.php)\n\n### Pré requisitos\nAntes de começar você precisará se cadastrar na *plataforma oficial* e obter um **token** de acesso.\n\n# Começando a usar\n\n## Instalação\n```bash\nyarn add maxbotjs\n```\nou\n```bash\nnpm install maxbotjs\n```\n\n### Instância\n```js\n// index.js\nimport Maxbot from 'maxbotjs'\n\n// create and config instance\nconst maxbot = new Maxbot({\n  token: 'SEU_TOKEN_AQUI',\n  timeout: 1000, // optional: default 3000 (3 seconds)\n})\n```\nou\n\n```js\n// index.js\nimport Maxbot from 'maxbotjs'\n\n// instance\nconst maxbot = new Maxbot()\n\n// config method\nmaxbot.setMe('token', 'SEU_TOKEN_AQUI')\n```\n\n### Teste\n```js\n// example\nmaxbot.getStatus().then(result =\u003e {\n  console.log(result)\n})\n\n// or\n\nconst result = await maxbot.getStatus()\nconsole.log(result)\n```\n\n***\n\n#### Métodos para serem implementados na classe ```Maxbot```\n- [x] [getStatus()](#getstatus)\n- [x] [getSegmentation()](#getsegmentation)\n- [x] [getTemplate()](#gettemplate)\n- [x] [getServiceSector()](#getservicesector)\n- [x] [getAttendant()](#getattendant)\n- [x] [getContact()](#getcontact)\n- [ ] [getProt()](#getprot)\n- [x] [putContact()](#putcontact)\n- [x] [setContact()](#setcontact)\n- [ ] [openFollowup()](#openfollowup)\n- [x] [sendText()](#sendtext)\n- [x] [sendImage()](#sendimage)\n- [x] [sendFile()](#sendfile)\n- [x] [sendSound()](#sendsound)\n\n### Documentação\n\n#### getStatus\nRetorna situação da API\n```js\nconst result = await maxbot.getStatus()\n\n// out\n{\n  status: 1, // Situação do processamento: 1-Sucesso, 0-Falha\n  msg: \"Success\", // Mensagem de contexto do processamento.\n  data: [\n    {\n      createdAt: \"2020-08-22\", //  Data de criação\n      status: \"Active\", // Situação da API\n      lastExecutionAt: \"2020-08-29 21:21:32\", // Data da última execução\n      lastOperation: \"Sound Shooting\" // Última operação executada pela API\n    }\n  ]\n}\n```\n\n#### getSegmentation\nRetorna lista de segmentações incluídas na plataforma\n```js\nconst result = await maxbot.getSegmentation()\n\n// out\n{\n  status: 1,\n  msg: \"Success\",\n  segmentation: [\n    {\n      id: 1452, // ID da segmentação\n      title: \"Negocia\\u00e7\\u00e3o\" // Título da segmentação\n    },\n    {\n      id: 2267,\n      title: \"Proposta Enviada\"\n    }\n    // ...\n  ]\n}\n```\n\n#### getTemplate\n Retorna lista de templates cadastrados na conta Maxbot.\n```js\nconst result = await maxbot.getTemplate()\n\n// out\n{\n  status: 1,\n  msg: \"Success\",\n  template: [\n    {\n      id: 1,\n      type: \"chat\",\n      title: \"Negocia\\u00e7\\u00e3o\",\n      forUse: 0\n    },\n    {\n      id: 2,\n      type: \"followup\",\n      title: \"Abertura de Protocolo\",\n      forUse: 1\n    },\n    {\n      id: 3,\n      type: \"notice\",\n      title: \"Aviso de Postado nos Correios\",\n      forUse: 1\n    }\n    // ...\n  ]\n}\n\n```\n\n#### getServiceSector\nRetorna lista dos setores de atendimento cadastrados.\n\n**Obs.:** *Se o atendimento para o dia da semana estiver configurado para 24 horas, os horários dos turnos serão ignorados.*\n```js\nconst result = await maxbot.getServiceSector()\n\n// out\n{\n  status: 1,\n  msg: \"Success\",\n  serviceSector: [\n    {\n      id: 1, // ID do setor\n      code: \"CO\", // Código do setor\n      name: \"Comercial\", // Nome do setor\n      responsibleName: \"Rodrigo Gomide\", //  Nome do responsável pelo setor\n      responsibleEmail: \"rodrigo@email.com\", //  e-mail do responsável pelo setor\n      responsibleWhatsapp: \"553111116666\", // Número do whatsapp do responsável pelo setor\n      responsibleMobilePhone: \"553111116666\", // Número do celular do responsável pelo setor\n      responsiblePhoneExtension: \"5454\", // Número do ramal do responsável pelo setor\n      operationMondayAnswer: 1, //  Se há atendimento nas segundas-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas)\n      operationMondayShift1: \"08:00-12:00\", // Horário do 1º turno (Hora:Minuto-Hora:Minuto)\n      operationMondayShift2: \"13:00-18:00\", // Horário do 2º turno (Hora:Minuto-Hora:Minuto)\n      operationTuesdayAnswer: 1, // Se há atendimento nas terças-feiras (0 - Não, 1 - Sim, Em Horários Determinados, 2 - Sim, 24 horas)\n      operationTuesdayShift1: \"08:00-12:00\",\n      operationTuesdayShift2: \"13:00-18:00\",\n      operationWednesdayAnswer: 1,\n      operationWednesdayShift1: \"08:00-12:00\",\n      operationWednesdayShift2: \"13:00-18:00\",\n      operationThursdayAnswer: 1,\n      operationThursdayShift1: \"08:00-12:00\",\n      operationThursdayShift2: \"13:00-18:00\",\n      operationFridayAnswer: 1,\n      operationFridayShift1: \"08:00-12:00\",\n      operationFridayShift2: \"13:00-18:00\",\n      operationSaturdayAnswer: 1,\n      operationSaturdayShift1: \"08:00-12:00\",\n      operationSaturdayShift2: \"13:00-18:00\",\n      operationSundayAnswer: 1,\n      operationSundayShift1: \"08:00-12:00\",\n      operationSundayShift2: \"13:00-18:00\",\n      allowServiceWithUnavailableAttendants: 0, // Se permite atendimento quando não houver nenhum atendente on-line (0 - Não, 1 - Sim)\n    },\n    { ... }\n    // ...\n}\n```\n\n#### getAttendant\n```js\nconst result = await maxbot.getAttendant()\n\n// out\n{\n  status: 1,\n  msg: \"Success\",\n  attendant: [\n    {\n      id: 1, // ID do atendente\n      serviceSectorId: [1], // Lista de IDs dos setores de atendimento aos quais o atendente está associado\n      name: \"Pedro Silva\", // Nome do atendente\n      status: 1 // Situação do atendente (0 - Inativo, 1 - Ativo)\n    },\n    {\n      id: 2,\n      serviceSectorId: [2, 3],\n      name: \"Jos\\u00e9 Nogueira\",\n      status: 0\n    },\n    {\n      id: 3,\n      serviceSectorId: [1, 3, 8, 29],\n      name: \"Ant\\u00f4nio Prado\",\n      status: 1\n    }\n  ]\n}\n\n\n```\n\n#### getContact\nRetorna lista de contatos cadastrados no maxbot.\n\n - **Obs. 1:** *Você pode informar a mesma data de início e fim para trazer os contatos do dia, ou informar uma data de início e outra data diferente para o fim para trazer os contatos dentro de um período;*\n - **Obs. 2:** *Se você informar ```whatsapp``` ou ```mobilePhone``` ou ```email``` ou ```externalId```, o informe do período ```dateStart``` e ```dateStop``` fica opicional. Ou seja, você pode fazer uma consulta apenas informando o *whatsapp*, ou o *email* por exemplo. O Maxbot irá localizar o registro com base nos parâmetros informados.;*\n\n```js\nconst result = await maxbot.getContact({\n  dateStart: \"2020-06-01\",\n  dateStop: \"2020-06-18\",\n})\n\n// out\n{\n  status: 1,\n  msg: 'Success',\n  data: [\n    {\n      id: '1',\n      cadDate: '2020-06-08 08:07:16',\n      segmentation: [],\n      tag: 'THER',\n      name: 'Rodrigo',\n      surname: 'Funda\\u00e7\\u00e3o Ther',\n      gender: 'M',\n      birth: '1974-10-22',\n      age: '46',\n      brPersonType: 'J',\n      brCpf: '11122233344',\n      brCnpj: '11222333000144',\n      company: 'Ther Sistemas Ltda',\n      email: 'rodrigo@maxbot.com.br',\n      whatsapp: '5531911112222',\n      mobilePhone: '5531922223333',\n      phone: '3132324455',\n      country: 'BR',\n      state: 'MG',\n      city: 'Vi\\u00e7osa',\n      profession: '',\n      externalId: '5678',\n      avatarUrl: '',\n      obs: '',\n      inAttendance: '0',\n      currentProtocol: '',\n      currentAttendant: ''\n    },\n    {\n      id: '2',\n      cadDate: '2020-06-18 19:10:42',\n      segmentation: [],\n      tag: '',\n      name: 'Dilson',\n      surname: 'Lana',\n      gender: 'M',\n      birth: '',\n      age: '',\n      brPersonType: 'F',\n      brCpf: '',\n      brCnpj: '',\n      company: '',\n      email: '',\n      whatsapp: '5531911112222',\n      mobilePhone: '5531922223333',\n      phone: '',\n      country: 'BR',\n      state: 'SP',\n      city: 'Campinas',\n      profession: '',\n      externalId: '',\n      avatarUrl: '',\n      obs: 'Cliente VIP',\n      inAttendance: '1',\n      currentProtocol: '2345',\n      currentAttendant: 'Keli Marchi'\n    },\n    // ...\n  ]\n}\n```\n\n#### getProt\n```js\n\n```\n\n#### putContact\n```js\nconst result = await maxbot.putContact({\n  segmentation: ['Negocia\\u00e7\\u00e3o', 'Proposta Enviada'],\n  tag: 'VIP',\n  name: 'Jose',\n  surname: 'Silva',\n  gender: 'M',\n  birth: '1974-06-15',\n  brPersonType: 'J',\n  brCpf: '11122233300',\n  brCnpj: '00111222000133',\n  company: 'Empresa Minha Ltda',\n  email: 'jose@email.com',\n  whatsapp: '5531911116666',\n  mobilePhone: '5531911116666',\n  phone: '553155551122',\n  country: 'BR',\n  state: 'MG',\n  city: 'Belo Horizonte',\n  profession: 'ESPORTE',\n  externalId: '667811',\n  avatarUrl: 'https://www.meusite.com.br/foto.jpg',\n  obs: 'Enviar proposta comercial na segunda'\n})\n\n// out\n{\n  status: 1,\n  msg: 'Success',\n  contact_id: 1234\n}\n```\n\n#### setContact\n```js\nconst result = await maxbot.setContact({\n  forContactId: '1234',\n  segmentation: ['Negocia\\u00e7\\u00e3o', 'Proposta Enviada'],\n  tag: 'VIP',\n  name: 'Jose',\n  surname: 'Silva',\n  gender: 'M',\n  birth: '1974-06-15',\n  brPersonType: 'J',\n  brCpf: '11122233300',\n  brCnpj: '00111222000133',\n  company: 'Empresa Minha Ltda',\n  email: 'jose@email.com',\n  whatsapp: '5531911116666',\n  mobilePhone: '5531911116666',\n  phone: '553155551122',\n  country: 'BR',\n  state: 'MG',\n  city: 'Belo Horizonte',\n  profession: 'ESPORTE',\n  externalId: '667811',\n  avatarUrl: 'https://www.meusite.com.br/foto.jpg',\n  obs: 'Enviar proposta comercial na segunda'\n})\n\n// out\n\n{\n  status: 1,\n  msg: 'Success'\n}\n```\n\n#### openFollowup\n```js\n\n```\n\n#### sendText\n```js\nconst result = await maxbot.sendText({ whatsapp: '553191112222'}, 'Mensagem')\n\n// out\n{\n status: 1,\n msg: 'Success'\n}\n\n```\n\n#### sendImage\n```js\n// allowed images ['jpg', 'jpeg', 'png', 'gif']\nconst urlImage = 'https://example.com/image.png'\nconst result = await maxbot.sendImage({ whatsapp: '553191112222' }, urlImage)\n\n// out\n{\n status: 1,\n msg: 'Success'\n}\n\n```\n\n#### sendFile\n```js\n// allowed files ['pdf', 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', 'pps']\nconst urlFile = 'https://example.com/file.pdf'\nconst result = await maxbot.sendFile({ whatsapp: '553191112222' }, urlFile)\n\n// out\n{\n status: 1,\n msg: 'Success'\n}\n```\n\n#### sendSound\n```js\n// allowed sounds ['mp3']\nconst urlSound = 'https://example.com/sound.mp3'\nconst result = await maxbot.sendFile({ whatsapp: '553191112222' }, urlSound)\n\n// out\n{\n status: 1,\n msg: 'Success'\n}\n\n```\n\n***\n\n## Contribuição\nQualquer contribuição será bem vinda.\n\n## Observações importantes\n - Embora os testes estejam devidamente escritos, você não poderá executá-los sem um token de acesso. Ainda não obtivemos acesso a um *token de testes* por parte da ***maxbot.com.br***.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleguass7%2Fmaxbotjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleguass7%2Fmaxbotjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleguass7%2Fmaxbotjs/lists"}