API DE MENSAGENS

Envie & receba SMS com a API de Mensagens

Uma API de envio de mensagens é uma interface programática que permite que sua empresa envie, receba e gerencie mensagens usando solicitações HTTP padronizadas. Com a API de Mensagens do Sinch Engage, você pode enviar mensagens de texto e do WhatsApp, solicitar relatórios de entrega, verificar o status por ID da mensagem e recuperar respostas.

Image for Envie & receba SMS com a API de Mensagens

FLUXOS DE TRABALHO PRINCIPAIS

O que você pode fazer com a API de Mensagens

Use a API de Mensagens para enviar mensagens de texto e do WhatsApp, rastrear o status de processamento, recuperar respostas e confirmar as respostas depois de processá-las.

Imagem para O que você pode fazer com a API de Mensagens

Envio agendado

Envie uma mensagem de texto com um parâmetro scheduled. Use-o para envio de mensagens com base no tempo, como lembretes de consulta.

Relatórios de entrega

Solicite relatórios de entrega ao enviar uma mensagem. Um relatório de entrega é uma notificação quando o status da mensagem muda.

Verificações de status por ID da mensagem

Capture o ID da mensagem a partir da resposta de envio. Use-o para verificar o status da mensagem mais tarde.

Respostas e confirmação

Recupere as respostas enviadas de um celular chamando a função reply. Confirme as respostas processadas para que não sejam retornadas novamente.

COMO FUNCIONA

O que a API de Mensagens faz

Envie SMS e mensagens de WhatsApp transmitindo o conteúdo, o número de destino, opções de agendamento, preferências de relatório de entrega e metadados opcionais. A API retorna um ID de mensagem que você pode usar para verificar o status e recuperar respostas do celular.

INTEGRAÇÃO

Como a API de Mensagens se integra aos seus sistemas atuais

Integre a API de Mensagens com solicitações HTTP padrão ou um SDK para adaptá-la aos seus sistemas atuais. Adicione um callback_url para habilitar webhooks e inclua metadados para transmitir o contexto de mensagem personalizado.

Imagem para Como a API de Mensagens se integra aos seus sistemas atuais

RECURSOS

Recursos da API de Mensagens

A API de Mensagens oferece suporte a um fluxo de trabalho estruturado para envio de mensagens e gerenciamento de respostas para que você possa integrar o envio de mensagens em seus aplicativos.

  • Envie mensagens com conteúdo e destination_number

  • Agende mensagens com scheduled

  • Solicite relatórios de entrega com delivery_report

  • Verifique o status da mensagem pelo ID da mensagem

  • Recupere respostas de celulares

  • Confirme respostas e inclua até 10 pares de metadados

Imagem para Recursos da API de Mensagens

MELHORE SEU FLUXO DE TRABALHO

Comece a usar a API de Mensagens

Para começar, você precisará de uma conta Sinch Engage e do Ruby instalado. Em seguida, instale o SDK do Ruby para enviar mensagens, verificar atualizações de status e recuperar respostas.

Instale o SDK do Ruby para começar a criar com a API de Mensagens.

Crie um arquivo app.rb na pasta do seu projeto e abra-o em seu editor.

Envie uma mensagem com o conteúdo e o número de destino. Você também pode incluir configurações de metadados, agendamento e relatório de entrega.

Use o ID da mensagem na resposta para verificar o status da mensagem. Chame a função reply para recuperar respostas dos celulares dos destinatários.

Confirme as respostas processadas para que não apareçam novamente em verificações futuras. Adicione um callback_url em send_message para ativar webhooks.

Imagem para Comece a usar a API de Mensagens

POR QUE O SINCH ENGAGE?

Por que escolher um aplicativo com recursos de API?

O Sinch Engage combina um aplicativo fácil de usar com recursos de API para que sua equipe possa lançar e gerenciar o envio de mensagens sem fluxos de trabalho pesados para os desenvolvedores. Você obtém a usabilidade de que as equipes de negócios precisam e a flexibilidade de integração que as equipes técnicas esperam.

Perguntas frequentes

Perguntas frequentes sobre a API de Mensagens

Uma API de envio de mensagens é uma interface programática que permite que aplicativos enviem, recebam e gerenciem mensagens usando solicitações HTTP padronizadas. A API de Mensagens é uma maneira de implementar esse padrão.

No tutorial da API de Mensagens, o corpo de envio de mensagem inclui campos como content e destination_number. Ele também pode incluir metadados, scheduled e delivery_report.

Ao enviar uma mensagem, a API de Mensagens retorna um ID da mensagem no objeto de resposta. Use esse ID da mensagem para verificar o status da mensagem.

As respostas enviadas de um celular aparecem quando você chama a função reply no fluxo de trabalho do tutorial. Após processar as respostas, confirme-as para que não sejam retornadas novamente.

No tutorial da API de Mensagens, você pode ativar webhooks incluindo um parâmetro callback_url no corpo da mensagem de sua função send_message. O material de origem não especifica comportamentos adicionais de webhook.

Sim A API de Mensagens oferece suporte a até 10 pares de chave/valor de metadados em uma mensagem. Use metadados quando não quiser armazenar dados persistentes no aplicativo.

Você precisa de uma conta de desenvolvedor do MessageMedia e do Ruby instalado. O tutorial também faz referência à instalação do SDK do Ruby com gem install messagemedia_messages_sdk.

Os relatórios de entrega são uma notificação sobre uma alteração no status de uma mensagem enquanto ela é processada. No fluxo de trabalho do tutorial, você pode solicitar delivery_report no corpo da mensagem.

Sim O tutorial mostra um campo scheduled no corpo da mensagem. Ele também descreve lembretes de consulta com uma confirmação um dia antes e um lembrete uma hora antes.

Depois que uma ou mais mensagens de resposta forem processadas, confirme-as com o endpoint confirm replies. As respostas confirmadas não são retornadas em solicitações posteriores para verificar as respostas.