SiteUP API
API versão 1.0.0 · OpenAPI 3.1.0 · 303 operações
Servidor: https://app.siteup.com.br
API completa da plataforma SiteUP.
Recursos
- Atendimento: contatos, conversas, mensagens, caixas multi-canal
- Kanban: funnels, stages, items, atribuição de agentes
- Automação: regras, webhooks, integrações
- Analytics: relatórios, métricas
- Equipe: agentes, times, perfis
Autenticação
Header api_access_token: <seu-token> na maioria dos endpoints. Endpoints /public/api/v1/* usam identificadores públicos.
A referência interativa tem busca, parâmetros, exemplos de código e teste de chamadas direto na página.
Operações da API
Gerar Oportunidades 10
- GET
/api/v1/accounts/{account_id}/reactivation_campaignsListar campanhas de reativação - POST
/api/v1/accounts/{account_id}/reactivation_campaignsCriar campanha de reativação (rascunho) - GET
/api/v1/accounts/{account_id}/reactivation_campaigns/{id}Detalhe da campanha de reativação - POST
/api/v1/accounts/{account_id}/reactivation_campaigns/preview_audiencePrever o público da reativação - GET
/api/v1/accounts/{account_id}/reactivation_campaigns/templatesTemplates aprovados para reativação (API oficial) - POST
/api/v1/accounts/{account_id}/reactivation_campaigns/cost_estimateEstimar custo de uma reativação (API oficial) - GET
/api/v1/accounts/{account_id}/reactivation_campaigns/metricsResultados da reativação por modo de envio - POST
/api/v1/accounts/{account_id}/reactivation_campaigns/{id}/startIniciar campanha de reativação - POST
/api/v1/accounts/{account_id}/reactivation_campaigns/{id}/pausePausar campanha de reativação - POST
/api/v1/accounts/{account_id}/reactivation_campaigns/{id}/resumeRetomar campanha de reativação
Oportunidades 5
- GET
/api/v1/accounts/{account_id}/opportunitiesListar oportunidades - GET
/api/v1/accounts/{account_id}/opportunities/summaryContador de oportunidades por tipo - POST
/api/v1/accounts/{account_id}/opportunities/{id}/dismissDispensar oportunidade - POST
/api/v1/accounts/{account_id}/opportunities/{id}/sendEnviar mensagem de uma oportunidade - POST
/api/v1/accounts/{account_id}/opportunities/{id}/funnelMandar oportunidade para um funil
Contas 4
- POST
/platform/api/v1/accountsCreate an Account - GET
/platform/api/v1/accounts/{account_id}Get an account details - PATCH
/platform/api/v1/accounts/{account_id}Update an account - DELETE
/platform/api/v1/accounts/{account_id}Delete an Account
Usuários da Conta 3
- GET
/platform/api/v1/accounts/{account_id}/account_usersList all Account Users - POST
/platform/api/v1/accounts/{account_id}/account_usersCreate an Account User - DELETE
/platform/api/v1/accounts/{account_id}/account_usersDelete an Account User
Bots 5
- GET
/platform/api/v1/agent_botsList all AgentBots - POST
/platform/api/v1/agent_botsCreate an Agent Bot - GET
/platform/api/v1/agent_bots/{id}Get an agent bot details - PATCH
/platform/api/v1/agent_bots/{id}Update an agent bot - DELETE
/platform/api/v1/agent_bots/{id}Delete an AgentBot
Usuários 5
- POST
/platform/api/v1/usersCreate a User - GET
/platform/api/v1/users/{id}Get an user details - PATCH
/platform/api/v1/users/{id}Update a user - DELETE
/platform/api/v1/users/{id}Delete a User - GET
/platform/api/v1/users/{id}/loginGet User SSO Link
Bots da Conta 5
- GET
/api/v1/accounts/{account_id}/agent_botsList all AgentBots - POST
/api/v1/accounts/{account_id}/agent_botsCreate an Agent Bot - GET
/api/v1/accounts/{account_id}/agent_bots/{id}Get an agent bot details - PATCH
/api/v1/accounts/{account_id}/agent_bots/{id}Update an agent bot - DELETE
/api/v1/accounts/{account_id}/agent_bots/{id}Delete an AgentBot
Agentes 4
- GET
/api/v1/accounts/{account_id}/agentsList Agents in Account - POST
/api/v1/accounts/{account_id}/agentsAdd a New Agent - PATCH
/api/v1/accounts/{account_id}/agents/{id}Update Agent in Account - DELETE
/api/v1/accounts/{account_id}/agents/{id}Remove an Agent from Account
Respostas Prontas 4
- GET
/api/v1/accounts/{account_id}/canned_responsesList all Canned Responses in an Account - POST
/api/v1/accounts/{account_id}/canned_responsesAdd a New Canned Response - PATCH
/api/v1/accounts/{account_id}/canned_responses/{id}Update Canned Response in Account - DELETE
/api/v1/accounts/{account_id}/canned_responses/{id}Remove a Canned Response from Account
Contatos 11
- GET
/api/v1/accounts/{account_id}/contactsList Contacts - POST
/api/v1/accounts/{account_id}/contactsCreate Contact - GET
/api/v1/accounts/{account_id}/contacts/{id}Show Contact - PUT
/api/v1/accounts/{account_id}/contacts/{id}Update Contact - DELETE
/api/v1/accounts/{account_id}/contacts/{id}Delete Contact - GET
/api/v1/accounts/{account_id}/contacts/{id}/conversationsContact Conversations - GET
/api/v1/accounts/{account_id}/contacts/searchSearch Contacts - POST
/api/v1/accounts/{account_id}/contacts/filterContact Filter - POST
/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxesCreate contact inbox - GET
/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxesGet Contactable Inboxes - POST
/api/v1/accounts/{account_id}/actions/contact_mergeMerge Contacts
Etiquetas de Contato 2
- GET
/api/v1/accounts/{account_id}/contacts/{id}/labelsList Labels - POST
/api/v1/accounts/{account_id}/contacts/{id}/labelsAdd Labels
Atribuição de Conversas 1
- POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignmentsAssign Conversation
Conversas 13
- GET
/api/v1/accounts/{account_id}/conversations/metaGet Conversation Counts - GET
/api/v1/accounts/{account_id}/conversationsConversations List - POST
/api/v1/accounts/{account_id}/conversationsCreate New Conversation - POST
/api/v1/accounts/{account_id}/conversations/filterConversations Filter - GET
/api/v1/accounts/{account_id}/conversations/{conversation_id}Conversation Details - PATCH
/api/v1/accounts/{account_id}/conversations/{conversation_id}Update Conversation - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_statusToggle Status - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_priorityToggle Priority - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_typing_statusToggle Typing Status - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributesUpdate Custom Attributes - GET
/api/v1/accounts/{account_id}/conversations/{conversation_id}/labelsList Labels - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/labelsAdd Labels - GET
/api/v1/accounts/{account_id}/conversations/{conversation_id}/reporting_eventsConversation Reporting Events
Atributos Personalizados 5
- GET
/api/v1/accounts/{account_id}/custom_attribute_definitionsList all custom attributes in an account - POST
/api/v1/accounts/{account_id}/custom_attribute_definitionsAdd a new custom attribute - GET
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}Get a custom attribute details - PATCH
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}Update custom attribute in Account - DELETE
/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}Remove a custom attribute from account
Filtros Personalizados 5
- GET
/api/v1/accounts/{account_id}/custom_filtersList all custom filters - POST
/api/v1/accounts/{account_id}/custom_filtersCreate a custom filter - GET
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}Get a custom filter details - PATCH
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}Update a custom filter - DELETE
/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}Delete a custom filter
Caixas de Entrada 10
- GET
/api/v1/accounts/{account_id}/inboxesList all inboxes - POST
/api/v1/accounts/{account_id}/inboxesCreate an inbox - GET
/api/v1/accounts/{account_id}/inboxes/{id}Get an inbox - PATCH
/api/v1/accounts/{account_id}/inboxes/{id}Update Inbox - GET
/api/v1/accounts/{account_id}/inboxes/{id}/agent_botShow Inbox Agent Bot - POST
/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_botAdd or remove agent bot - GET
/api/v1/accounts/{account_id}/inbox_members/{inbox_id}List Agents in Inbox - POST
/api/v1/accounts/{account_id}/inbox_membersAdd a New Agent - PATCH
/api/v1/accounts/{account_id}/inbox_membersUpdate Agents in Inbox - DELETE
/api/v1/accounts/{account_id}/inbox_membersRemove an Agent from Inbox
Integrações 4
- GET
/api/v1/accounts/{account_id}/integrations/appsList all the Integrations - POST
/api/v1/accounts/{account_id}/integrations/hooksCreate an integration hook - PATCH
/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}Update an Integration Hook - DELETE
/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}Delete an Integration Hook
Etiquetas 5
- GET
/api/v1/accounts/{account_id}/labelsList all labels - POST
/api/v1/accounts/{account_id}/labelsCreate a label - GET
/api/v1/accounts/{account_id}/labels/{id}Get a label - PATCH
/api/v1/accounts/{account_id}/labels/{id}Update a label - DELETE
/api/v1/accounts/{account_id}/labels/{id}Delete a label
Mensagens 3
- GET
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messagesGet messages - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messagesCreate New Message - DELETE
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}Delete a message
Perfil 2
- GET
/api/v1/profileFetch user profile - PUT
/api/v1/profileUpdate user profile
Relatórios 12
- GET
/api/v1/accounts/{account_id}/reporting_eventsAccount Reporting Events - GET
/api/v2/accounts/{account_id}/reportsGet Account reports - GET
/api/v2/accounts/{account_id}/reports/summaryGet Account reports summary - GET
/api/v2/accounts/{account_id}/reports/conversationsAccount Conversation Metrics - GET
/api/v2/accounts/{account_id}/reports/conversations/Agent Conversation Metrics - GET
/api/v2/accounts/{account_id}/summary_reports/channelGet conversation statistics grouped by channel type - GET
/api/v2/accounts/{account_id}/summary_reports/inboxGet conversation statistics grouped by inbox - GET
/api/v2/accounts/{account_id}/summary_reports/agentGet conversation statistics grouped by agent - GET
/api/v2/accounts/{account_id}/summary_reports/teamGet conversation statistics grouped by team - GET
/api/v2/accounts/{account_id}/reports/first_response_time_distributionGet first response time distribution by channel - GET
/api/v2/accounts/{account_id}/reports/inbox_label_matrixGet inbox-label matrix report - GET
/api/v2/accounts/{account_id}/reports/outgoing_messages_countGet outgoing messages count grouped by entity
Times 9
- GET
/api/v1/accounts/{account_id}/teamsList all teams - POST
/api/v1/accounts/{account_id}/teamsCreate a team - GET
/api/v1/accounts/{account_id}/teams/{team_id}Get a team details - PATCH
/api/v1/accounts/{account_id}/teams/{team_id}Update a team - DELETE
/api/v1/accounts/{account_id}/teams/{team_id}Delete a team - GET
/api/v1/accounts/{account_id}/teams/{team_id}/team_membersList Agents in Team - POST
/api/v1/accounts/{account_id}/teams/{team_id}/team_membersAdd a New Agent - PATCH
/api/v1/accounts/{account_id}/teams/{team_id}/team_membersUpdate Agents in Team - DELETE
/api/v1/accounts/{account_id}/teams/{team_id}/team_membersRemove an Agent from Team
Webhooks 10
- GET
/api/v1/accounts/{account_id}/webhooksList all webhooks - POST
/api/v1/accounts/{account_id}/webhooksAdd a webhook - PATCH
/api/v1/accounts/{account_id}/webhooks/{webhook_id}Update a webhook object - DELETE
/api/v1/accounts/{account_id}/webhooks/{webhook_id}Delete a webhook - POST
/api/v1/accounts/{account_id}/whatsapp_groups/{id}/register_webhookRegistrar webhook WAHA do grupo - GET
/api/v1/accounts/{account_id}/whatsapp_group_webhooksListar webhooks de entrada dos grupos - POST
/api/v1/accounts/{account_id}/whatsapp_group_webhooksCriar webhook de entrada dos grupos - GET
/api/v1/accounts/{account_id}/whatsapp_group_webhooks/{id}Detalhe do webhook de grupos (webhook_url + token) - PUT
/api/v1/accounts/{account_id}/whatsapp_group_webhooks/{id}Atualizar webhook de grupos - DELETE
/api/v1/accounts/{account_id}/whatsapp_group_webhooks/{id}Excluir webhook de grupos
Regras de Automação 5
- GET
/api/v1/accounts/{account_id}/automation_rulesList all automation rules in an account - POST
/api/v1/accounts/{account_id}/automation_rulesAdd a new automation rule - GET
/api/v1/accounts/{account_id}/automation_rules/{id}Get a automation rule details - PATCH
/api/v1/accounts/{account_id}/automation_rules/{id}Update automation rule in Account - DELETE
/api/v1/accounts/{account_id}/automation_rules/{id}Remove a automation rule from account
Central de Ajuda 5
- GET
/api/v1/accounts/{account_id}/portalsList all portals in an account - POST
/api/v1/accounts/{account_id}/portalsAdd a new portal - PATCH
/api/v1/accounts/{account_id}/portals/{id}Update a portal - POST
/api/v1/accounts/{account_id}/portals/{id}/categoriesAdd a new category - POST
/api/v1/accounts/{account_id}/portals/{id}/articlesAdd a new article
API Pública - Contatos 3
- POST
/public/api/v1/inboxes/{inbox_identifier}/contactsCreate a contact - GET
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}Get a contact - PATCH
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}Update a contact
API Pública - Conversas 6
- GET
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversationsList all conversations - POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversationsCreate a conversation - GET
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}Get a single conversation - POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_statusResolve a conversation - POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typingToggle typing status - POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/update_last_seenUpdate last seen
API Pública - Mensagens 3
- GET
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messagesList all messages - POST
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messagesCreate a message - PATCH
/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}Update a message
Pesquisa CSAT 1
- GET
/survey/responses/{conversation_uuid}Get CSAT survey page
Funis 6
- GET
/api/v1/accounts/{account_id}/funnelsListar funnels - POST
/api/v1/accounts/{account_id}/funnelsCriar funnel - GET
/api/v1/accounts/{account_id}/funnels/{id}Obter funnel - PUT
/api/v1/accounts/{account_id}/funnels/{id}Atualizar funnel - DELETE
/api/v1/accounts/{account_id}/funnels/{id}Excluir funnel - GET
/api/v1/accounts/{account_id}/funnels/{id}/stage_statsEstatísticas por etapa
Ofertas 6
- GET
/api/v1/accounts/{account_id}/offersListar ofertas - POST
/api/v1/accounts/{account_id}/offersCriar oferta - GET
/api/v1/accounts/{account_id}/offers/searchBuscar ofertas por texto - GET
/api/v1/accounts/{account_id}/offers/{id}Buscar oferta por ID - PATCH
/api/v1/accounts/{account_id}/offers/{id}Atualizar oferta - DELETE
/api/v1/accounts/{account_id}/offers/{id}Deletar oferta
Itens Kanban 21
- GET
/api/v1/accounts/{account_id}/kanban_itemsListar kanban items - POST
/api/v1/accounts/{account_id}/kanban_itemsCriar kanban item - POST
/api/v1/accounts/{account_id}/kanban_items/reorderReordenar kanban items - GET
/api/v1/accounts/{account_id}/kanban_items/{id}Obter kanban item - PUT
/api/v1/accounts/{account_id}/kanban_items/{id}Atualizar kanban item - DELETE
/api/v1/accounts/{account_id}/kanban_items/{id}Excluir kanban item - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/move_to_stageMover item para etapa - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/moveMover item - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/change_statusMudar status - GET
/api/v1/accounts/{account_id}/kanban_items/reportsRelatórios de kanban items - GET
/api/v1/accounts/{account_id}/kanban_items/searchBuscar kanban items - GET
/api/v1/accounts/{account_id}/kanban_items/filterFiltrar kanban items - GET
/api/v1/accounts/{account_id}/kanban_items/exportExportar kanban items (CSV) - POST
/api/v1/accounts/{account_id}/kanban_items/importImportar kanban items (CSV) - POST
/api/v1/accounts/{account_id}/kanban_items/bulk_move_itemsMover múltiplos itens de etapa - POST
/api/v1/accounts/{account_id}/kanban_items/bulk_assign_agentAtribuir agente em massa - POST
/api/v1/accounts/{account_id}/kanban_items/bulk_set_priorityDefinir prioridade em massa - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/time_reportRelatório de tempo do item - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/stage_time_breakdownTempo por etapa - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/countsContagens do item - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/checklist_progress_by_agentProgresso do checklist por agente
Checklist 9
- POST
/api/v1/accounts/{account_id}/kanban_items/{id}/create_checklist_itemCriar item do checklist - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/assign_agent_to_checklist_itemAtribuir agente ao item do checklist - DELETE
/api/v1/accounts/{account_id}/kanban_items/{id}/remove_agent_from_checklist_itemRemover agente do item do checklist - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/get_checklistListar checklist do item - DELETE
/api/v1/accounts/{account_id}/kanban_items/{id}/delete_checklist_itemExcluir item do checklist - PATCH
/api/v1/accounts/{account_id}/kanban_items/{id}/update_checklist_itemAtualizar item do checklist - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/toggle_checklist_itemMarcar/desmarcar item do checklist - POST
/api/v1/accounts/{account_id}/kanban_items/{id}/duplicate_checklistDuplicar checklist para outro item - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/search_checklistBuscar no checklist
Notas 4
- POST
/api/v1/accounts/{account_id}/kanban_items/{id}/create_noteCriar nota - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/get_notesListar notas do item - PATCH
/api/v1/accounts/{account_id}/kanban_items/{id}/update_noteAtualizar nota - DELETE
/api/v1/accounts/{account_id}/kanban_items/{id}/delete_noteExcluir nota
Tarefas 5
- GET
/api/v1/accounts/{account_id}/tasksListar tarefas - POST
/api/v1/accounts/{account_id}/tasksCriar tarefa - GET
/api/v1/accounts/{account_id}/tasks/{id}Obter tarefa - PATCH
/api/v1/accounts/{account_id}/tasks/{id}Atualizar tarefa - DELETE
/api/v1/accounts/{account_id}/tasks/{id}Excluir tarefa
Mensagens Agendadas 4
- GET
/api/v1/accounts/{account_id}/conversations/{conversation_id}/scheduled_messagesListar mensagens agendadas - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/scheduled_messagesCriar mensagem agendada - PATCH
/api/v1/accounts/{account_id}/conversations/{conversation_id}/scheduled_messages/{id}Atualizar mensagem agendada - DELETE
/api/v1/accounts/{account_id}/conversations/{conversation_id}/scheduled_messages/{id}Excluir mensagem agendada
Anexos 1
- POST
/api/v1/accounts/{account_id}/uploadUpload de arquivo
Lead Capture 7
- POST
/api/leads/capture/{slug}Captura de lead publico - GET
/lead-capture.jsScript JS embed - GET
/api/v1/accounts/{account_id}/lead_capture_endpointsListar endpoints - POST
/api/v1/accounts/{account_id}/lead_capture_endpointsCriar endpoint - GET
/api/v1/accounts/{account_id}/lead_capture_endpoints/{id}Detalhe - PATCH
/api/v1/accounts/{account_id}/lead_capture_endpoints/{id}Atualizar - DELETE
/api/v1/accounts/{account_id}/lead_capture_endpoints/{id}Excluir
Captain (Agente IA) 5
- GET
/api/v1/accounts/{account_id}/agent_bots/{agent_bot_id}/ai_agent_documentsListar knowledge base - POST
/api/v1/accounts/{account_id}/agent_bots/{agent_bot_id}/ai_agent_documentsAdicionar ao knowledge base - GET
/api/v1/accounts/{account_id}/agent_bots/{agent_bot_id}/ai_agent_documents/{id}Detalhe do documento - DELETE
/api/v1/accounts/{account_id}/agent_bots/{agent_bot_id}/ai_agent_documents/{id}Remover documento - POST
/api/v1/accounts/{account_id}/agent_bots/{agent_bot_id}/ai_agent_documents/{id}/retryReprocessar documento
Disparo de Mensagens 4
- GET
/api/v1/accounts/{account_id}/broadcastsListar broadcasts - POST
/api/v1/accounts/{account_id}/broadcastsCriar broadcast - GET
/api/v1/accounts/{account_id}/broadcasts/{id}Detalhe do broadcast - DELETE
/api/v1/accounts/{account_id}/broadcasts/{id}Cancelar broadcast
VOIP 10
- GET
/api/v1/accounts/{account_id}/voip_settingsBuscar config VOIP - PATCH
/api/v1/accounts/{account_id}/voip_settingsAtualizar config VOIP - GET
/api/v1/accounts/{account_id}/voip_devicesListar dispositivos VOIP - POST
/api/v1/accounts/{account_id}/voip_devicesAdicionar dispositivo VOIP - GET
/api/v1/accounts/{account_id}/voip_devices/{id}Detalhe do dispositivo - PATCH
/api/v1/accounts/{account_id}/voip_devices/{id}Atualizar dispositivo - DELETE
/api/v1/accounts/{account_id}/voip_devices/{id}Remover dispositivo - POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/voip_callsIniciar chamada VOIP - GET
/api/v1/accounts/{account_id}/voip_sla_policiesListar SLAs - PATCH
/api/v1/accounts/{account_id}/voip_sla_policies/{id}Atualizar SLA
VOIP - Analytics 15
- GET
/api/v1/accounts/{account_id}/voip_analytics/funnelFunil de chamadas - GET
/api/v1/accounts/{account_id}/voip_analytics/financialMétricas financeiras - GET
/api/v1/accounts/{account_id}/voip_analytics/by_agentMétricas por agente - GET
/api/v1/accounts/{account_id}/voip_analytics/by_originMétricas por origem - GET
/api/v1/accounts/{account_id}/voip_analytics/dailySérie diária - GET
/api/v1/accounts/{account_id}/voip_analytics/distanceDistribuição por distância - GET
/api/v1/accounts/{account_id}/voip_analytics/calls_per_leadChamadas por lead - GET
/api/v1/accounts/{account_id}/voip_analytics/attendance_rateTaxa de comparecimento - GET
/api/v1/accounts/{account_id}/voip_analytics/lead_speedVelocidade de resposta ao lead - GET
/api/v1/accounts/{account_id}/voip_analytics/fcr_rateTaxa de resolução na 1a chamada - GET
/api/v1/accounts/{account_id}/voip_analytics/setup_checklistChecklist de configuração - GET
/api/v1/accounts/{account_id}/voip_analytics/compareComparar com período anterior - GET
/api/v1/accounts/{account_id}/voip_analytics/recent_summariesResumos de IA recentes - GET
/api/v1/accounts/{account_id}/voip_analytics/targetsConsultar metas do mês - PATCH
/api/v1/accounts/{account_id}/voip_analytics/targetsDefinir metas do mês
Call Records 3
- GET
/api/v1/accounts/{account_id}/call_recordsListar chamadas - GET
/api/v1/accounts/{account_id}/call_records/{id}Detalhe da chamada - PATCH
/api/v1/accounts/{account_id}/call_records/{id}Atualizar chamada
Lead Scoring 1
- GET
/api/v1/accounts/{account_id}/contacts/{contact_id}/lead_scoresHistorico de scoring
Groups 9
- GET
/api/v1/accounts/{account_id}/whatsapp_groupsListar grupos - POST
/api/v1/accounts/{account_id}/whatsapp_groupsCriar grupo (WAHA + SiteUP) - GET
/api/v1/accounts/{account_id}/whatsapp_groups/{id}Detalhe do grupo - PUT
/api/v1/accounts/{account_id}/whatsapp_groups/{id}Atualizar grupo - DELETE
/api/v1/accounts/{account_id}/whatsapp_groups/{id}Excluir / leave grupo - POST
/api/v1/accounts/{account_id}/whatsapp_groups/adoptAdotar grupo, canal ou comunidade já existente - POST
/api/v1/accounts/{account_id}/whatsapp_group_launches/provisionProvisionar em lote as salas de um lançamento - GET
/api/v1/accounts/{account_id}/whatsapp_groups/{id}/invite_codeCódigo / link de convite - POST
/api/v1/accounts/{account_id}/whatsapp_groups/{id}/revoke_invite_codeRevogar invite
Members 6
- POST
/api/v1/accounts/{account_id}/whatsapp_groups/{id}/sync_membersSincronizar membros (async job) - GET
/api/v1/accounts/{account_id}/whatsapp_groups/{whatsapp_group_id}/membersListar membros - POST
/api/v1/accounts/{account_id}/whatsapp_groups/{whatsapp_group_id}/membersAdicionar membros - DELETE
/api/v1/accounts/{account_id}/whatsapp_groups/{whatsapp_group_id}/members/{id}Remover membro - POST
/api/v1/accounts/{account_id}/whatsapp_groups/{whatsapp_group_id}/members/{id}/promotePromover a admin - POST
/api/v1/accounts/{account_id}/whatsapp_groups/{whatsapp_group_id}/members/{id}/demoteRebaixar admin
Campaigns 7
- GET
/api/v1/accounts/{account_id}/whatsapp_group_campaignsListar campanhas - POST
/api/v1/accounts/{account_id}/whatsapp_group_campaignsCriar campanha - GET
/api/v1/accounts/{account_id}/whatsapp_group_campaigns/{id}Detalhe campanha - PUT
/api/v1/accounts/{account_id}/whatsapp_group_campaigns/{id}Atualizar campanha - DELETE
/api/v1/accounts/{account_id}/whatsapp_group_campaigns/{id}Excluir campanha - GET
/api/v1/accounts/{account_id}/whatsapp_group_campaigns/{id}/healthHealth da campanha - GET
/api/v1/accounts/{account_id}/whatsapp_group_campaigns/{id}/broadcastsBroadcasts da campanha
Broadcasts 4
- GET
/api/v1/accounts/{account_id}/whatsapp_group_broadcastsListar disparos - POST
/api/v1/accounts/{account_id}/whatsapp_group_broadcastsCriar disparo - GET
/api/v1/accounts/{account_id}/whatsapp_group_broadcasts/{id}Detalhe do disparo - POST
/api/v1/accounts/{account_id}/whatsapp_group_broadcasts/{id}/cancelCancelar disparo agendado/queued
Sequences 5
- GET
/api/v1/accounts/{account_id}/whatsapp_group_sequencesListar sequências - POST
/api/v1/accounts/{account_id}/whatsapp_group_sequencesCriar sequência - GET
/api/v1/accounts/{account_id}/whatsapp_group_sequences/{id}Detalhe sequência - PUT
/api/v1/accounts/{account_id}/whatsapp_group_sequences/{id}Atualizar sequência - DELETE
/api/v1/accounts/{account_id}/whatsapp_group_sequences/{id}Excluir sequência
Activities 1
- GET
/api/v1/accounts/{account_id}/whatsapp_group_activitiesLog de atividades
WAHA 3
- GET
/api/v1/accounts/{account_id}/whatsapp_groups/available_waha_sessionsSessões WAHA disponíveis - GET
/api/v1/accounts/{account_id}/whatsapp_groups/inbox_statusStatus live das inboxes WAHA - POST
/api/v1/accounts/{account_id}/whatsapp_groups/resolve_sessionResolver sessão WAHA para inbox
Inbox API 1
- GET
/public/api/v1/inboxes/{inbox_identifier}Inbox details
Account 2
- GET
/api/v1/accounts/{account_id}Get account details - PATCH
/api/v1/accounts/{account_id}Update account
Audit Logs 1
- GET
/api/v1/accounts/{account_id}/audit_logsList Audit Logs in Account
Agentes (Kanban) 3
- POST
/api/v1/accounts/{account_id}/kanban_items/{id}/assign_agentAtribuir agente - DELETE
/api/v1/accounts/{account_id}/kanban_items/{id}/remove_agentRemover agente - GET
/api/v1/accounts/{account_id}/kanban_items/{id}/assigned_agentsListar agentes atribuídos