1. API Key
Documentação técnica das API do Messagefy
  • Introdução
  • Começando
  • Guia de Integração
  • Collections Postman
  • OnBoarding
    • OnBoarding para Organizações
  • Me
    • Introdução
    • Sobre
      GET
  • Contas
    • Introdução
    • Criar conta
      POST
    • Listar contas
      GET
    • Buscar por id
      GET
    • Atualizar conta
      PUT
    • Deletar conta
      DELETE
  • API Key
    • Introdução
    • Criar apikey
      POST
    • Listar ApiKeys
      GET
    • Buscar por ID
      GET
    • Atualizar apikey
      PUT
    • Deletar apiKey
      DELETE
  • Administrando Canais
    • Introdução
    • WebHook
      • Criar canal de Webhook
    • Whatsapp
      • Criar canal de Whatsapp
      • Status do Canal Whatsapp
      • Solicitar QRCode
      • Solicitar Pair Code
      • Solicitar Desconectar o número
    • Outbox
      • Listar Mensagens no Outbox do Canal
      • Obter detalhes da Mensagem no Outbox do Canal
      • Reenviar Múltiplas Mensagens no Outbox do Canal
      • Cancelar Mensagem no Outbox do Canal
    • Listar canais
      GET
    • Buscar por id
      GET
    • Atualizar canal
      PUT
    • Deletar canal
      DELETE
    • Transferir canal
      POST
  • Usando o Canal Whatsapp
    • Introdução
    • Contatos e Grupos
      • Solicitar contatos
      • Solicitar informações do contato
      • Solicitar grupos
      • Solicitar presença de contato (online/offline)
      • Solicitar Chats
      • Solicitar informação do grupo
    • Enviando Mensagens
      • Texto, imagem, audio, video, documentos e sticker
      • Enviar contatos
      • Enviar lista de contato
      • Marcar mensagens como lida
    • Excluindo e Editando Mensagens
      • Apagar mensagem para todos
      • Editar mensagem
    • Recuperar Messagens Antigas
  • Recebendo WebHooks
    • Guia Completo de WebHooks
    • Mensagens Recebidas
      • TEXT
      • CONTACT_MESSAGE
      • CONTACTS_MESSAGE
    • Status do canal
    • QRCode gerado retorno
    • Lista de contatos
    • Lista de grupos
    • Mensagem entregue
    • Mensagem lida
    • Download Disponivel
    • Localização e Localização em tempo real
    • Lista de Histórico
    • Ligação recebida e realizada
    • Lista de contatos do grupo
    • Lista de chats
    • Alteração de Grupo
  • Raiz
  • Esquemas
    • Eventos de WebHook
      • Eventos de Conexão
        • PAIR_CODE_GENERATED_RESPONSE: PairCode de conexão
        • INSTANCE_USER_CONNECT_TIMEOUT: Usuário não realizou Login
        • DISCONNECTED: Celular desconectado
        • CONNECTED: Celular conectado
      • Eventos de Mensagens
        • EchoMessage: Eco de Mensagem enviada
      • Eventos de Status de Mensagens
        • MESSAGE_SENT: Mensagem enviada
        • MESSAGE_DELIVERED: Mensagem entregue
        • MESSAGE_READ: Mensagem lida
    • ContatoWhatsapp
    • ContactResponseInfo
    • AccountResponse
    • Organization
    • ResourcePlanResponse
    • ChannelType
    • ChannelStatus
    • Provider
  1. API Key

Criar apikey

dev
https://api-dev.messagefy.io
dev
https://api-dev.messagefy.io
POST
/api/v1/admin/apikey
Esse endpoint criar uma apikey para voce enviar mensagens

Requisição

Authorization
Adicionar parâmetro em header
api-key
Exemplo:
api-key: ********************
Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso
application/json
Body

🟠400Dados Inválidos
🔴500Erro Interno
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-dev.messagefy.io/api/v1/admin/apikey' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Suporte Key",
    "description": "Key da conta de suporte",
    "accountId": "account-id"
}'
Response Response Example
200 - Sucesso
{
    "id": "id",
    "name": "Suporte Keys",
    "description": "Key da conta de suporte",
    "apiKey": "acc_019be510-f312-7a1f-8e53-db741d5a5698",
    "resourcePlan": {
        "resourcePlanId": "plan-id",
        "name": "TESTE",
        "description": "Plano padrão com 20 requisições por 10 SEGUNDOS",
        "limit": 20,
        "seconds": 10
    },
    "account": {
        "accountId": "account-id",
        "name": "Suporte",
        "description": null,
        "status": {
            "accountStatusId": 1,
            "name": "Created / Inativo",
            "icon": null,
            "description": "Está cadastrado mas não disponível para utilização",
            "canManageChildObjects": false,
            "canSendAndReceiveMessage": false
        }
    },
    "organization": {
        "organizationId": "org-id",
        "name": "org-name",
        "description": "org-descrição",
        "status": {
            "organizationStatusId": 1,
            "name": "Created / Inativo",
            "icon": null,
            "description": "Está cadastrado mas não disponível para utilização",
            "canManageChildObjects": false,
            "canSendAndReceiveMessage": false
        }
    },
    "type": "Account"
}
Modificado em 2026-01-22 21:53:15
Página anterior
Introdução
Próxima página
Listar ApiKeys
Built with