# Orkesio API 2.4.2 > Documentação estável. Use o contrato para payloads e os guias para fluxos. ## Contrato - [OpenAPI](https://docs.orkesio.com/openapi-bundled.json) - [Origem e versão](https://docs.orkesio.com/release.json) ## Guias - [Visão geral](https://docs.orkesio.com/docs/collections/overview.md) - [Server URL da API](https://docs.orkesio.com/docs/collections/server-url.md) - [Instâncias e sessões](https://docs.orkesio.com/docs/collections/instances.md) - [Início rápido](https://docs.orkesio.com/docs/collections/getting-started.md) - [Autenticação](https://docs.orkesio.com/docs/collections/authentication.md) - [Identificadores e eventos](https://docs.orkesio.com/docs/collections/concepts.md) - [Proxy da instância](https://docs.orkesio.com/docs/collections/proxy.md) - [Integrações](https://docs.orkesio.com/docs/collections/integrations.md) - [Webhooks: configuração e eventos](https://docs.orkesio.com/docs/collections/integrations-webhooks.md) - [Grupos](https://docs.orkesio.com/docs/collections/groups.md) - [Canais e newsletters](https://docs.orkesio.com/docs/collections/newsletters.md) - [Catálogo comercial](https://docs.orkesio.com/docs/collections/business-catalog.md) - [Chats e contatos](https://docs.orkesio.com/docs/collections/chats-and-contacts.md) - [Mensagens e mídias](https://docs.orkesio.com/docs/collections/messages-and-media.md) - [Download de mídias](https://docs.orkesio.com/docs/collections/media-downloads.md) - [Filas de mensagem](https://docs.orkesio.com/docs/collections/message-queues.md) - [Mensagem em massa](https://docs.orkesio.com/docs/collections/bulk-messaging.md) - [Histórico de mensagens](https://docs.orkesio.com/docs/collections/message-history-retention.md) - [Entrega e status](https://docs.orkesio.com/docs/collections/message-delivery.md) - [Erros e confiabilidade](https://docs.orkesio.com/docs/collections/errors-and-retries.md) ## Referência por operação - [Consultar status do servidor](https://docs.orkesio.com/reference/getServerStatus.md) - [Criar Instancia](https://docs.orkesio.com/reference/createInstance.md) - [Rotacionar token da instância](https://docs.orkesio.com/reference/rotateInstanceToken.md) - [Listar todas as instâncias](https://docs.orkesio.com/reference/listAllInstances.md) - [Conectar instância ao WhatsApp](https://docs.orkesio.com/reference/connectInstance.md) - [Desconectar instância](https://docs.orkesio.com/reference/disconnectInstance.md) - [Reiniciar a conexão da instância](https://docs.orkesio.com/reference/resetInstance.md) - [Verificar status da instância](https://docs.orkesio.com/reference/getInstanceStatus.md) - [Consultar limites atuais de novas conversas no WhatsApp](https://docs.orkesio.com/reference/getWAMessageLimits.md) - [Nomear campos personalizados de leads](https://docs.orkesio.com/reference/updateFieldsMap.md) - [Atualizar nome da instância](https://docs.orkesio.com/reference/updateInstanceName.md) - [Atualizar campos administrativos](https://docs.orkesio.com/reference/updateAdminFields.md) - [Obter configuração de proxy da instância](https://docs.orkesio.com/reference/getProxyConfig.md) - [Configurar ou alterar o proxy](https://docs.orkesio.com/reference/updateProxyConfig.md) - [Proxy Interno - Listar países disponíveis](https://docs.orkesio.com/reference/listRegionCountries.md) - [Proxy Interno - Listar cidades disponíveis](https://docs.orkesio.com/reference/listRegionCities.md) - [Altera o nome do perfil do WhatsApp](https://docs.orkesio.com/reference/updateProfileName.md) - [Altera a imagem do perfil do WhatsApp](https://docs.orkesio.com/reference/updateProfileImage.md) - [Deletar instância](https://docs.orkesio.com/reference/deleteInstance.md) - [Buscar configurações de privacidade](https://docs.orkesio.com/reference/getInstancePrivacy.md) - [Alterar configurações de privacidade](https://docs.orkesio.com/reference/setPrivacySetting.md) - [Atualizar status de presença da instância](https://docs.orkesio.com/reference/updateInstancePresence.md) - [Enviar mensagem de texto](https://docs.orkesio.com/reference/sendText.md) - [Enviar mídia (imagem, vídeo, áudio ou documento)](https://docs.orkesio.com/reference/sendMedia.md) - [Enviar cartão de contato (vCard)](https://docs.orkesio.com/reference/sendContact.md) - [Enviar localização geográfica](https://docs.orkesio.com/reference/sendLocation.md) - [Enviar atualização de presença](https://docs.orkesio.com/reference/sendPresence.md) - [Enviar status (stories)](https://docs.orkesio.com/reference/sendStatus.md) - [Enviar menu interativo (botões, carrossel, lista ou enquete)](https://docs.orkesio.com/reference/sendMenu.md) - [Enviar carrossel de mídia com botões](https://docs.orkesio.com/reference/sendCarousel.md) - [Solicitar localização do usuário](https://docs.orkesio.com/reference/sendLocationButton.md) - [Solicitar pagamento](https://docs.orkesio.com/reference/sendRequestPayment.md) - [Atualizar pagamento e pedido](https://docs.orkesio.com/reference/updatePaymentStatus.md) - [Enviar botão PIX](https://docs.orkesio.com/reference/sendPixButton.md) - [Consultar fila async de envio direto](https://docs.orkesio.com/reference/getAsyncQueueStatus.md) - [Limpar fila async de envio direto](https://docs.orkesio.com/reference/clearAsyncQueue.md) - [Configurar delay entre mensagens async](https://docs.orkesio.com/reference/updateDelaySettings.md) - [Baixar arquivo de uma mensagem](https://docs.orkesio.com/reference/downloadMessage.md) - [Buscar mensagens em um chat](https://docs.orkesio.com/reference/findMessages.md) - [Solicitar histórico sob demanda de um chat](https://docs.orkesio.com/reference/requestHistorySync.md) - [Consultar o processamento do histórico inicial](https://docs.orkesio.com/reference/getHistorySyncStatus.md) - [Marcar mensagens como lidas](https://docs.orkesio.com/reference/markMessageRead.md) - [Enviar reação a uma mensagem](https://docs.orkesio.com/reference/reactToMessage.md) - [Apagar Mensagem Para Todos](https://docs.orkesio.com/reference/deleteMessage.md) - [Edita uma mensagem enviada](https://docs.orkesio.com/reference/editMessage.md) - [Fixa ou desafixa uma mensagem](https://docs.orkesio.com/reference/pinMessage.md) - [Criar um novo grupo](https://docs.orkesio.com/reference/createGroup.md) - [Consultar detalhes e membros de um grupo](https://docs.orkesio.com/reference/getGroupInfo.md) - [Obter informações de um grupo pelo código de convite](https://docs.orkesio.com/reference/getGroupInviteInfo.md) - [Gerar link de convite para um grupo](https://docs.orkesio.com/reference/getGroupInviteLink.md) - [Entrar em um grupo usando código de convite](https://docs.orkesio.com/reference/joinGroup.md) - [Sair de um grupo](https://docs.orkesio.com/reference/leaveGroup.md) - [Listar todos os grupos (legado)](https://docs.orkesio.com/reference/listGroups.md) - [Listar grupos em páginas (recomendado)](https://docs.orkesio.com/reference/refreshGroups.md) - [Resetar código de convite do grupo](https://docs.orkesio.com/reference/resetGroupInviteCode.md) - [Configurar permissões de envio de mensagens no grupo](https://docs.orkesio.com/reference/updateGroupAnnounce.md) - [Configurar aprovação para entrada no grupo](https://docs.orkesio.com/reference/updateGroupJoinApproval.md) - [Configurar quem pode adicionar novos membros ao grupo](https://docs.orkesio.com/reference/updateGroupMemberAddMode.md) - [Atualizar descrição do grupo](https://docs.orkesio.com/reference/updateGroupDescription.md) - [Configurar mensagens temporárias em grupo](https://docs.orkesio.com/reference/updateGroupEphemeral.md) - [Atualizar imagem do grupo](https://docs.orkesio.com/reference/updateGroupImage.md) - [Configurar permissão de edição do grupo](https://docs.orkesio.com/reference/updateGroupLocked.md) - [Atualizar nome do grupo](https://docs.orkesio.com/reference/updateGroupName.md) - [Gerenciar participantes do grupo](https://docs.orkesio.com/reference/updateGroupParticipants.md) - [Criar uma comunidade](https://docs.orkesio.com/reference/createCommunity.md) - [Gerenciar grupos em uma comunidade](https://docs.orkesio.com/reference/editCommunityGroups.md) - [Criar canal](https://docs.orkesio.com/reference/createNewsletter.md) - [Listar canais inscritos](https://docs.orkesio.com/reference/listNewsletters.md) - [Buscar informações de um canal](https://docs.orkesio.com/reference/getNewsletterInfo.md) - [Buscar canal por link-chave de convite](https://docs.orkesio.com/reference/getNewsletterInfoWithInvite.md) - [Assinar live updates temporários de um canal](https://docs.orkesio.com/reference/subscribeNewsletterLiveUpdates.md) - [Buscar mensagens de um canal](https://docs.orkesio.com/reference/getNewsletterMessages.md) - [Editar mensagem recente de um canal](https://docs.orkesio.com/reference/editNewsletterMessage.md) - [Deletar mensagem recente de um canal](https://docs.orkesio.com/reference/deleteNewsletterMessage.md) - [Buscar updates de mensagens de um canal](https://docs.orkesio.com/reference/getNewsletterMessageUpdates.md) - [Marcar posts do canal como visualizados](https://docs.orkesio.com/reference/markNewsletterViewed.md) - [Reagir a um post do canal](https://docs.orkesio.com/reference/reactNewsletterMessage.md) - [Seguir canal](https://docs.orkesio.com/reference/followNewsletter.md) - [Deixar de seguir canal](https://docs.orkesio.com/reference/unfollowNewsletter.md) - [Silenciar canal](https://docs.orkesio.com/reference/muteNewsletter.md) - [Remover mute do canal](https://docs.orkesio.com/reference/unmuteNewsletter.md) - [Deletar canal](https://docs.orkesio.com/reference/deleteNewsletter.md) - [Atualizar foto do canal](https://docs.orkesio.com/reference/updateNewsletterPicture.md) - [Atualizar nome do canal](https://docs.orkesio.com/reference/updateNewsletterName.md) - [Atualizar descrição do canal](https://docs.orkesio.com/reference/updateNewsletterDescription.md) - [Atualizar configurações do canal](https://docs.orkesio.com/reference/updateNewsletterSettings.md) - [Pesquisar canais públicos](https://docs.orkesio.com/reference/searchNewsletterDirectory.md) - [Convidar admin do canal](https://docs.orkesio.com/reference/inviteNewsletterAdmin.md) - [Aceitar convite de admin do canal](https://docs.orkesio.com/reference/acceptNewsletterAdminInvite.md) - [Remover admin do canal](https://docs.orkesio.com/reference/removeNewsletterAdmin.md) - [Revogar convite de admin do canal](https://docs.orkesio.com/reference/revokeNewsletterAdminInvite.md) - [Transferir dono do canal](https://docs.orkesio.com/reference/transferNewsletterOwnership.md) - [Ver Webhook da Instância](https://docs.orkesio.com/reference/getWebhook.md) - [Configurar Webhook da Instância](https://docs.orkesio.com/reference/updateWebhook.md) - [Ver últimos erros do webhook local](https://docs.orkesio.com/reference/getWebhookErrors.md) - [Ver Webhook Global](https://docs.orkesio.com/reference/getGlobalWebhook.md) - [Configurar Webhook Global](https://docs.orkesio.com/reference/updateGlobalWebhook.md) - [Ver últimos erros do webhook global](https://docs.orkesio.com/reference/getGlobalWebhookErrors.md) - [Server-Sent Events (SSE)](https://docs.orkesio.com/reference/subscribeSSE.md) - [Criar nova campanha (Simples)](https://docs.orkesio.com/reference/sendSimpleCampaign.md) - [Criar envio em massa avançado](https://docs.orkesio.com/reference/sendAdvancedCampaign.md) - [Controlar campanha de envio em massa](https://docs.orkesio.com/reference/editCampaign.md) - [Limpar mensagens enviadas](https://docs.orkesio.com/reference/clearDoneCampaigns.md) - [Limpar toda fila de mensagens](https://docs.orkesio.com/reference/clearAllCampaigns.md) - [Listar campanhas de envio](https://docs.orkesio.com/reference/listCampaignFolders.md) - [Listar mensagens de uma campanha](https://docs.orkesio.com/reference/listCampaignMessages.md) - [Consultar estado e métricas das campanhas](https://docs.orkesio.com/reference/getCampaignStats.md) - [Bloqueia ou desbloqueia contato do WhatsApp](https://docs.orkesio.com/reference/blockChat.md) - [Lista contatos bloqueados](https://docs.orkesio.com/reference/getBlocklist.md) - [Gerencia labels de um chat](https://docs.orkesio.com/reference/setChatLabels.md) - [Deleta chat](https://docs.orkesio.com/reference/deleteChat.md) - [Arquivar/desarquivar chat](https://docs.orkesio.com/reference/archiveChat.md) - [Configurar mensagens temporárias em chat privado](https://docs.orkesio.com/reference/updateChatEphemeral.md) - [Marcar chat como lido/não lido](https://docs.orkesio.com/reference/markChatRead.md) - [Silenciar chat](https://docs.orkesio.com/reference/muteChat.md) - [Fixar/desafixar chat](https://docs.orkesio.com/reference/pinChat.md) - [Busca chats com filtros](https://docs.orkesio.com/reference/findChats.md) - [Consultar notas internas do chat](https://docs.orkesio.com/reference/getChatNotes.md) - [Recarregar notas internas do chat no WhatsApp](https://docs.orkesio.com/reference/refreshChatNotes.md) - [Editar notas internas do chat](https://docs.orkesio.com/reference/editChatNotes.md) - [Consultar contadores de chats](https://docs.orkesio.com/reference/countChats.md) - [Edita informações de lead](https://docs.orkesio.com/reference/editLead.md) - [Lista tags de lead](https://docs.orkesio.com/reference/listLeadTags.md) - [Cria, edita ou apaga uma tag de lead](https://docs.orkesio.com/reference/editLeadTag.md) - [Retorna lista de contatos do WhatsApp](https://docs.orkesio.com/reference/checkContacts.md) - [Listar todos os contatos com paginacao](https://docs.orkesio.com/reference/listContacts.md) - [Adiciona um contato à agenda](https://docs.orkesio.com/reference/addContact.md) - [Remove um contato da agenda](https://docs.orkesio.com/reference/removeContact.md) - [Consultar detalhes de um chat](https://docs.orkesio.com/reference/getChatDetails.md) - [Verificar Números no WhatsApp](https://docs.orkesio.com/reference/checkChat.md) - [Criar, editar ou deletar etiqueta](https://docs.orkesio.com/reference/editLabel.md) - [Buscar todas as etiquetas](https://docs.orkesio.com/reference/listLabels.md) - [Iniciar recarga de etiquetas do WhatsApp](https://docs.orkesio.com/reference/refreshLabels.md) - [Criar, atualizar ou excluir resposta rápida](https://docs.orkesio.com/reference/editQuickReply.md) - [Listar todas as respostas rápidas](https://docs.orkesio.com/reference/listQuickReplies.md) - [Iniciar chamada de voz](https://docs.orkesio.com/reference/makeCall.md) - [Rejeitar chamada recebida](https://docs.orkesio.com/reference/rejectCall.md) - [Obter configuração do Chatwoot](https://docs.orkesio.com/reference/getChatwootConfig.md) - [Atualizar configuração do Chatwoot](https://docs.orkesio.com/reference/updateChatwootConfig.md) - [Obter o perfil comercial](https://docs.orkesio.com/reference/postBusinessGetProfile.md) - [Obter as categorias de negócios](https://docs.orkesio.com/reference/getBusinessGetCategories.md) - [Atualizar o perfil comercial](https://docs.orkesio.com/reference/postBusinessUpdateProfile.md) - [Listar os produtos do catálogo](https://docs.orkesio.com/reference/getCatalog.md) - [Obter informações de um produto do catálogo](https://docs.orkesio.com/reference/postBusinessCatalogInfo.md) - [Deletar um produto do catálogo](https://docs.orkesio.com/reference/postBusinessCatalogDelete.md) - [Mostrar um produto do catálogo](https://docs.orkesio.com/reference/postBusinessCatalogShow.md) - [Ocultar um produto do catálogo](https://docs.orkesio.com/reference/postBusinessCatalogHide.md) - [Reiniciar a aplicação](https://docs.orkesio.com/reference/postAdminRestart.md) - [Rotacionar admin token](https://docs.orkesio.com/reference/rotateAdminToken.md) - [Consultar avatar de um chat](https://docs.orkesio.com/reference/getChatAvatar.md) - [Criar ou editar um produto do catálogo](https://docs.orkesio.com/reference/postBusinessCatalogSave.md) - [Enviar evento](https://docs.orkesio.com/reference/sendEvent.md) - [Listar coleções do catálogo](https://docs.orkesio.com/reference/listBusinessCatalogCollections.md) - [Criar coleção no catálogo](https://docs.orkesio.com/reference/createBusinessCatalogCollection.md) - [Editar coleção do catálogo](https://docs.orkesio.com/reference/updateBusinessCatalogCollection.md) - [Apagar coleção do catálogo](https://docs.orkesio.com/reference/deleteBusinessCatalogCollection.md) - [Instance](https://docs.orkesio.com/reference/schemas/Instance.md) - [Webhook](https://docs.orkesio.com/reference/schemas/Webhook.md) - [Chat](https://docs.orkesio.com/reference/schemas/Chat.md) - [Message](https://docs.orkesio.com/reference/schemas/Message.md) - [Label](https://docs.orkesio.com/reference/schemas/Label.md) - [Attendant](https://docs.orkesio.com/reference/schemas/Attendant.md) - [MessageQueueFolder](https://docs.orkesio.com/reference/schemas/MessageQueueFolder.md) - [QuickReply](https://docs.orkesio.com/reference/schemas/QuickReply.md) - [Group](https://docs.orkesio.com/reference/schemas/Group.md) - [GroupParticipant](https://docs.orkesio.com/reference/schemas/GroupParticipant.md) - [BusinessCatalogPage](https://docs.orkesio.com/reference/schemas/BusinessCatalogPage.md) - [BusinessProduct](https://docs.orkesio.com/reference/schemas/BusinessProduct.md) - [LeadTag](https://docs.orkesio.com/reference/schemas/LeadTag.md) - [WebhookEvent](https://docs.orkesio.com/reference/schemas/WebhookEvent.md) - [BusinessAddress](https://docs.orkesio.com/reference/schemas/BusinessAddress.md) - [BusinessComplianceInfo](https://docs.orkesio.com/reference/schemas/BusinessComplianceInfo.md) - [BusinessCollectionPage](https://docs.orkesio.com/reference/schemas/BusinessCollectionPage.md) - [BusinessCollection](https://docs.orkesio.com/reference/schemas/BusinessCollection.md) - [BusinessCollectionMutationResult](https://docs.orkesio.com/reference/schemas/BusinessCollectionMutationResult.md) - [Conexão da instância](https://docs.orkesio.com/reference/webhooks/connection.md) - [Sincronização de histórico](https://docs.orkesio.com/reference/webhooks/history.md) - [Mensagens](https://docs.orkesio.com/reference/webhooks/messages.md) - [Entrega e leitura](https://docs.orkesio.com/reference/webhooks/messages_update.md) - [Mensagens de canais](https://docs.orkesio.com/reference/webhooks/newsletter_messages.md) - [Chamadas](https://docs.orkesio.com/reference/webhooks/call.md) - [Contatos](https://docs.orkesio.com/reference/webhooks/contacts.md) - [Digitação e gravação](https://docs.orkesio.com/reference/webhooks/presence.md) - [Alterações de grupos](https://docs.orkesio.com/reference/webhooks/groups.md) - [Definição de etiquetas](https://docs.orkesio.com/reference/webhooks/labels.md) - [Atualizações de chats](https://docs.orkesio.com/reference/webhooks/chats.md) - [Etiquetas de um chat](https://docs.orkesio.com/reference/webhooks/chat_labels.md) - [Processamento de campanhas](https://docs.orkesio.com/reference/webhooks/sender.md) - [Administração](https://docs.orkesio.com/reference/tags/Administra%C3%A7%C3%A3o.md) - [Instancia](https://docs.orkesio.com/reference/tags/Instancia.md) - [Proxy](https://docs.orkesio.com/reference/tags/Proxy.md) - [Perfil](https://docs.orkesio.com/reference/tags/Perfil.md) - [Business](https://docs.orkesio.com/reference/tags/Business.md) - [Chamadas](https://docs.orkesio.com/reference/tags/Chamadas.md) - [Webhooks e SSE](https://docs.orkesio.com/reference/tags/Webhooks%20e%20SSE.md) - [Enviar Mensagem](https://docs.orkesio.com/reference/tags/Enviar%20Mensagem.md) - [Mensagem Async](https://docs.orkesio.com/reference/tags/Mensagem%20Async.md) - [Ações na mensagem e Buscar](https://docs.orkesio.com/reference/tags/A%C3%A7%C3%B5es%20na%20mensagem%20e%20Buscar.md) - [Chats](https://docs.orkesio.com/reference/tags/Chats.md) - [Contatos](https://docs.orkesio.com/reference/tags/Contatos.md) - [Bloqueios](https://docs.orkesio.com/reference/tags/Bloqueios.md) - [Etiquetas](https://docs.orkesio.com/reference/tags/Etiquetas.md) - [Grupos e Comunidades](https://docs.orkesio.com/reference/tags/Grupos%20e%20Comunidades.md) - [Newsletters e Canais](https://docs.orkesio.com/reference/tags/Newsletters%20e%20Canais.md) - [Respostas Rápidas](https://docs.orkesio.com/reference/tags/Respostas%20R%C3%A1pidas.md) - [CRM](https://docs.orkesio.com/reference/tags/CRM.md) - [Mensagem em massa](https://docs.orkesio.com/reference/tags/Mensagem%20em%20massa.md) - [Integração Chatwoot](https://docs.orkesio.com/reference/tags/Integra%C3%A7%C3%A3o%20Chatwoot.md)