Frappe

O Frappe é um framework open source que serve de base a todo um ecossistema de aplicações empresariais, entre elas ERPNext, Frappe CRM, Frappe HR e muitas outras. Por meio do DocType integrado SMS Settings, o framework oferece uma integração genérica com qualquer gateway HTTP de SMS, disponível em todas as apps baseadas em Frappe. O seven pode ser conectado dessa forma sem módulo adicional.

Configurar o envio de SMS

Os passos a seguir configuram o gateway de SMS incluído no Frappe para entregar mensagens pela API HTTP do seven. A configuração é global e vale para todas as apps da instância Frappe (por ex. ERPNext, Frappe CRM).

  1. 1

    Abrir SMS Settings

    Na instância Frappe, pesquisar por SMS Settings na barra de busca global.

  2. 2

    Informar a URL do gateway

    No campo SMS Gateway URL, informar:

    https://gateway.seven.io/api/sms
    Informar apenas a parte antes do caractere ?. O Frappe acrescenta os parâmetros à URL automaticamente.
  3. 3

    Mapear os parâmetros

    • Message Parameter: text
    • Receiver Parameter: to
  4. 4

    Adicionar parâmetros estáticos

    Adicionar as seguintes linhas em Static Parameters:

    ParameterValueHeader
    X-Api-KeyA chave de API da área do cliente seven✅
    from(opcional) ID de remetente desejado, por ex. seven❌
    A caixa Header em cada linha decide se o parâmetro é enviado como cabeçalho HTTP (autenticação) ou como parâmetro de URL (metadados da mensagem). Opcionalmente, ative Use POST para que o Frappe chame o gateway via POST em vez de GET.
  5. 5

    Salvar e testar

    Salvar as configurações e enviar um SMS de teste para um número em formato internacional (por ex. 491771783130) pelo SMS Center no ERPNext.

Envio a partir das apps

Após a configuração, o envio de SMS pode ser usado da seguinte forma em cada app Frappe:

ERPNext

  • Envio manual pelo SMS Center
  • Envio em massa pelas visualizações de lista (por ex. contatos, clientes, fornecedores)
  • Notificações automatizadas via regras de Notification com canal SMS

Frappe CRM

O Frappe CRM não inclui um botão de SMS próprio na interface. O envio é configurado pelo DocType padrão Notification do Frappe:

  1. Criar uma Notification e definir como Document Type CRM Lead ou CRM Deal
  2. Definir o evento gatilho (por ex. New, Value Change, Days Before/After)
  3. Definir Channel como SMS
  4. No campo Receiver, apontar para o campo de número de telefone do lead/deal (por ex. mobile_no)
  5. O corpo da mensagem aceita variáveis Jinja como {{ doc.lead_name }}
Em caso de dúvidas, entre em contato: support@seven.io