API SMS Short Code Homologado Rota OTP

API SMS Short Code Homologado Rota OTP

API SMS Short Code Homologado Rota OTP

A API SMS Short Code é uma ferramenta que permite que empresas enviem mensagens de texto (SMS) personalizadas para seus clientes. Ela funciona através da integração de um sistema de mensagens com a API SMS Short Code, que é uma interface de programação de aplicativos que permite que diferentes sistemas se comuniquem e compartilhem informações.

API SMS Short Code: tudo o que sua empresa precisa saber

As empresas podem usar a API SMS Short Code para enviar mensagens de texto personalizadas para seus clientes, oferecendo promoções, atualizações de status, confirmações de pedidos e outras informações relevantes. Essas mensagens de texto são enviadas para um número curto de cinco ou seis dígitos, o que torna mais fácil para os clientes reconhecerem a origem da mensagem.

Uma das principais vantagens da API SMS Short Code é que ela é uma forma rápida e eficiente de comunicação com os clientes. As mensagens de texto são entregues instantaneamente e têm uma taxa de abertura muito alta, o que significa que os clientes têm mais probabilidade de ler e responder a uma mensagem de texto do que a um e-mail ou uma mensagem de voz.

Além disso, a API SMS Short Code permite que as empresas personalizem suas mensagens de texto para cada cliente, o que ajuda a aumentar o engajamento e a fidelidade do cliente. Por exemplo, uma loja de roupas pode enviar uma mensagem de texto personalizada com uma promoção especial para um cliente que acabou de comprar um par de sapatos, incentivando-o a fazer outra compra.

Outra vantagem da API SMS Short Code é que ela pode ser integrada a outros sistemas e ferramentas em sua empresa, permitindo que você automatize e agilize seus processos. Por exemplo, você pode integrar a API com seu sistema de CRM para enviar automaticamente mensagens de texto personalizadas para seus clientes com base em seu histórico de compras.

Em termos de segurança, a API SMS Short Code é uma forma confiável de comunicação. As mensagens de texto são enviadas diretamente para os telefones celulares dos clientes e são entregues somente aos destinatários corretos.

No geral, a API SMS Short Code é uma ferramenta poderosa para as empresas se comunicarem com seus clientes de forma rápida, personalizada e eficiente. Ela pode ajudar a aumentar o engajamento e a fidelidade do cliente, melhorar a eficiência e a automação dos processos, além de ser uma forma segura e confiável de comunicação.

Como a API SMS Short Code pode melhorar a comunicação da sua empresa?

A API SMS Short Code pode melhorar a comunicação da sua empresa ao permitir que os usuários enviem e recebam mensagens curtas em tempo real. Ela permite que os clientes e funcionários da empresa se comuniquem de forma rápida e eficiente, o que pode ajudar a melhorar o serviço ao cliente, o gerenciamento de conteúdo e a eficiência operacional. Além disso, a API SMS Short Code pode ser usada para envio de alertas de segurança e de promoções, aumentando a fidelidade dos clientes à empresa.

Por que sua empresa precisa de uma API SMS Short Code agora?

A API SMS Short Code é uma ótima ferramenta para aprimorar a comunicação da empresa, proporcionando um canal de comunicação direto, rápido e eficaz entre clientes e funcionários da empresa. Além disso, ela permite que os clientes recebam promoções e avisos em tempo real, o que contribui para a fidelização dos clientes. É uma ótima ferramenta para aprimorar a comunicação da sua empresa, aumentar a eficiência operacional e melhorar o serviço ao cliente.

Como implementar a API na sua empresa

Para implementar a na sua empresa, primeiro você precisa obter uma conta de serviço com um provedor de SMS. Em seguida, você precisa integrar a API na sua aplicação ou sistema, para que ela possa ser usada para enviar e receber mensagens SMS. Por último, você precisa criar mensagens personalizadas para serem enviadas para os clientes, para que eles possam receber alertas, promoções e informações sobre a empresa.

Benefícios da API SMS Short Code para sua empresa e seus cliente

A API é uma ótima ferramenta para aprimorar a comunicação da empresa, proporcionando um canal de comunicação direto, rápido e eficaz entre clientes e funcionários da empresa. Ela oferece diversos benefícios para sua empresa e seus clientes, como:

1. Envio de mensagens de alerta de segurança e promoções;

  • A API SMS Short Code permite que você envie mensagens de alertas de segurança e promoções para seus clientes. Por exemplo, você pode enviar um alerta de segurança avisando que sua empresa está instalando novos sistemas de segurança ou oferecendo promoções especiais aos seus clientes. Esta ferramenta oferece uma comunicação direta, eficiente e rápida para melhorar o serviço ao cliente e a fidelização dos clientes.

2. Notificações em tempo real;

  • A API permite que você envie mensagens de alertas de segurança e promoções para seus clientes. Por exemplo, você pode enviar um alerta de segurança avisando que sua empresa está instalando novos sistemas de segurança ou oferecendo promoções especiais aos seus clientes. Esta ferramenta oferece uma comunicação direta, eficiente e rápida para melhorar o serviço ao cliente e a fidelização dos clientes.

3. Gerenciamento de conteúdo eficaz;

  • A API também permite que os clientes recebam notificações em tempo real. Por exemplo, você pode enviar um aviso de que um determinado serviço está indisponível ou um lembrete de que uma cobrança está prestes a vencer. Esta ferramenta facilita a comunicação entre sua empresa e seus clientes, aumentando a eficiência operacional e melhorando o serviço ao cliente.

4. Melhor serviço ao cliente;

  • A API também permite que você gerencie seu conteúdo de maneira eficaz. Por exemplo, você pode enviar mensagens personalizadas para os clientes, como mensagens de boas-vindas ou de aniversário. Esta ferramenta permite que você crie conteúdo relevante para os seus clientes, ajudando-o a aumentar a fidelização dos clientes.

5. Fidelização dos clientes;

  • A API SMS também permite que você melhore o serviço ao cliente. Por exemplo, você pode enviar mensagens de confirmação de pedidos ou notificações de entrega. Esta ferramenta ajuda a simplificar o processo de comunicação com os clientes, permitindo-lhe melhorar a experiência dos clientes e oferecer um serviço ao cliente de qualidade.

6. Mensagens personalizadas;

  • A API também permite que você fidelize os seus clientes. Por exemplo, você pode enviar mensagens de incentivo para clientes ativos ou mensagens de reativação para clientes inativos. Esta ferramenta permite que você crie uma relação de longo prazo com seus clientes, o que ajuda a aumentar a fidelização dos clientes.

7. Maior eficiência operacional;

  • A API também permite que você envie mensagens personalizadas para os clientes. Por exemplo, você pode enviar mensagens com descontos exclusivos para clientes atuais ou ofertas de boas-vindas para novos clientes. Esta ferramenta ajuda a criar uma comunicação mais personalizada com seus clientes, contribuindo para a satisfação dos clientes.

8. Maior alcance de mensagens;

  • A API também permite que você aumente a eficiência operacional. Por exemplo, você pode enviar mensagens de lembrete sobre reuniões ou notificações sobre mudanças de políticas. Esta ferramenta ajuda a simplificar o processo de comunicação interno, permitindo-lhe aumentar a eficiência operacional.

9. Aumento da produtividade;

  • A API SMS Short Code também permite que você alcance mais clientes. Por exemplo, você pode enviar mensagens de marketing ou ofertas especiais para clientes em potencial. Esta ferramenta ajuda a aumentar o alcance de suas mensagens, contribuindo para o aumento da produtividade.

10. Redução de custos

  • A API SMS Short Code também permite que você reduza os custos. Por exemplo, você pode enviar mensagens promocionais para aumentar as vendas ou mensagens informativas para reduzir o uso de papel. Esta ferramenta ajuda a reduzir os custos, permitindo-lhe alcançar um maior retorno sobre o investimento.

Comparação entre a API e outros métodos de envio de SMS

A API SMS Short Code é uma ferramenta que permite que as empresas envie mensagens SMS curtas em tempo real. Ela oferece muitas vantagens em relação a outros métodos de envio de SMS, como o envio de mensagens de alerta de segurança e promoções, notificações em tempo real, mensagens personalizadas, melhor serviço ao cliente, fidelização dos clientes, maior eficiência operacional, maior alcance de mensagens, aumento da produtividade e redução de custos.

Em comparação com outros métodos de envio de SMS, a API SMS Short Code oferece mais flexibilidade e vantagens para as empresas, tornando-a uma ótima ferramenta para aprimorar a comunicação da empresa.

Como escolher o provedor de API SMS certo para a sua empresa

Escolher o provedor de API SMS certo para a sua empresa é uma decisão importante. Primeiro, você deve verificar as taxas de envio e recebimento da API SMS do provedor e as funcionalidades oferecidas. Além disso, você deve verificar se o provedor possui uma boa reputação e se oferece suporte técnico. Você também deve verificar se o provedor oferece ferramentas para ajudar com a criação de conteúdo, gerenciamento de mensagens e análise de dados. Ao verificar todas essas coisas, você pode escolher o provedor de API SMS certo para a sua empresa.

Vantagens e benefícios:

  • Envio de SMS rápido e eficiente: a API SMS Short Code permite que sua empresa envie mensagens de texto para seus clientes instantaneamente.

  • Aumento do engajamento do cliente: os clientes têm mais probabilidade de responder a uma mensagem de texto do que a um e-mail ou uma mensagem de voz.

  • Personalização: a API SMS Short Code permite que sua empresa personalize as mensagens de texto para cada cliente, aumentando a probabilidade de que eles se sintam valorizados.

  • Melhoria da eficiência: a API SMS Short Code pode ser integrada a outras ferramentas e sistemas existentes em sua empresa, permitindo que você automatize e agilize seus processos.

  • Melhoria da segurança: a API SMS Short Code é uma forma segura e confiável de comunicação, garantindo que suas mensagens de texto sejam entregues aos destinatários corretos.

Por que usar uma API na sua empresa?

  • Automatização: o uso de APIs pode permitir que sua empresa automatize processos e tarefas, economizando tempo e recursos.

  • Melhoria da eficiência: as APIs permitem que diferentes sistemas e ferramentas se comuniquem e compartilhem informações, melhorando a eficiência e a produtividade.

  • Maior flexibilidade: as APIs podem ser personalizadas para atender às necessidades específicas da sua empresa, permitindo que você crie soluções personalizadas.

  • Integração: as APIs podem ser integradas a outras ferramentas e sistemas em sua empresa, tornando mais fácil compartilhar informações e colaborar com outras equipes.

Como a SpeedMarket pode ajudar na integração com a sua empresa?

A SpeedMarket é uma das primeiras empresas no mercado especializadas em integração com empresas. Somos pioneiros em oferecer a melhor rota de SMS, com a mais alta qualidade de serviço e baixa taxa de erro. Nossa API vem equipada com as melhores funcionalidades, desempenho e segurança, garantindo a melhor experiência possível para os usuários. Além disso, nossos serviços de atendimento ao cliente são de primeira linha, oferecendo suporte 24 horas por dia, 7 dias por semana. Com a SpeedMarket, você pode ter certeza de que está trabalhando com a melhor empresa do mercado.

Se você é um desenvolvedor de software ou profissional da área oferecemos também um Gateway para envio de mensagens de SMS e aplicativos de mensagens via protocolos HTTP, SMPP, SMTP, FTP e MySQL. Assim, podem ser usados com facilidade em qualquer linguagem de programação, incluindo Java, Delphi, ASP, ASP.Net, PERL, PHP.

A utilização do nosso Gateway é muito simples. Basicamente, seu programa precisará dar um GET ou POST na URL do nosso gateway. Então, passa-se por parâmetro a identificação da sua conta no sistema, o número do celular de destino, e a mensagem a ser enviada.

Assim como nossa plataforma online, o Gateway também funciona com todas as operadoras. Não há mensalidade nem taxa de inscrição. Você compra créditos e usa quando desejar e ainda conta com relatórios detalhados das mensagens enviadas.

Conheça um pouco da nossa API

Autenticação:

INTRODUCTION

Bem vindo!. Está página é exclusivamente dedicada à desenvolvedores de software e profissionais da área. Aqui você encontra todas informações necessárias para integrar seu sistema com nosso gateway, para enviar mensagens e receber status de entrega e respostas dos usuários de forma automática.


Nesta página você encontra documentação para as seguintes formas:

  • API REST
    • Seu sistema deve realizar uma chamada para a URL http://54.233.99.254/webservice-rest/, enviando os parâmetros por meio de GET ou POST. O retorno para cada chamada será um JSON cujo formato é detalhado ao longo desta documentação.

Autenticação

É recomendado que todas as requisições a API HTTP utilize para autenticação cabeçalhos Basic Authorization em vez de parâmetros query string. Neste campo deve ser informado seu usuário e senha cadastrados em nosso site. Caso haja erro na autenticação, o respectivo código de erro será retornado.

Authorization: Basic dXN1YXJpbzpzZW5oYQ=

O valor após a palavra Basic é uma chave Base64 de seu usuário e senha. Para obter o valor, utilize o comando base64 do linux:

$ echo -n conta:senha | base64 
dXN1YXJpbzpzZW5oYQ=

O site base64Encode também faz essa codificação gratuitamente.

Headers

Chamadas realizadas exclusivamente para API HTTP Envio em Lote devem incluir, além do cabeçalho de autenticação, os seguintes headers:

Content-Type:application/json
Accept:application/json

Restantes API HTTP, além do cabeçalho de autenticação devem incluir os seguintes headers:

Content-Type:application/x-www-form-urlencoded

Parâmetro campaign_id

Ao enviar uma requisição, recomendamos que você utilize este parâmetro. Ele serve como um identificador de sua mensagem em nossa plataforma e pode ser utilizado para consulta de status. Este parâmetro também possui a funcionalidade de proteção contra envios duplicados (habilite esta função com nosso suporte).

Parâmetro type

Ao enviar uma requisição, é necessário que você utilize este parâmetro. Ele serve para identificar o tipo do serviço da mensagem.

Veja abaixo a tabela contendo os valores aceitos para este parâmetro:

typeTipo do Serviço
0SMS
1SMS Interativo(Modo Flash)
2SMS Interativo
3Torpedo de Voz (Apenas Texto)
4Torpedo de Voz (Áudio)
5Whatsapp (Apenas Texto)
6Whatsapp (Imagem)
7Whatsapp (Áudio)
8Whatsapp (Vídeo)

Status de Chamada

As chamadas à API irão retornar dois parâmetros de status, um numérico denominado responseCode e o outro alfanumérico denominado responseDescription, os dois correspondem a mesma informação.

A seguir, veja a lista de status suportados pela nossa API:

API de Envio
API de Consulta
Todas API
responseCoderesponseDescriptionsuccess
000Success queuedtrue
001Batch processedtrue
002Scheduledtrue
010User or password is invalidfalse
020Empty or invalid typefalse
030Empty message contentfalse
040Scheduling date invalid or incorrectfalse
050Empty or invalid numberfalse
060International sending not allowedfalse
070Message rejected by serverfalse
080Insufficient or expired balancefalse
090Blocked account – Please contact supportfalse
100This service is currently under maintenancefalse
110There was an error processing, please try again, or contact usfalse
120Message array cannot exceed 5000false
130Message array is emptyfalse
140Incorrect time zonefalse
150File extension not allowedfalse
160Unknown method or unknown parameterfalse
170Invalid search attributesfalse
200Successful searchtrue

Status de Envio

Status obtidos através da API de Consulta ou Callback podem possuir três níveis, conforme a seguir:

Status de preparação da mensagem para envio, este status e não é retornado por Callback:

StatusDescription
-1Message Queued
3Preparing message to send
6Paused Message

Status de entrega na operadora, este é o primeiro status que retornamos por Callback:

StatusDescription
-9Blocked – No Coverage
-8Blocked – Content not allowed
-7Number has no WhatsApp (Only for WhatsApp)
-6Message successfully canceled
-5Blocked – Black listed
-4Blocked – landline Number
-3Blocked – Invalid Number
0Message received to operator
7Message expired by operator
8Message Rejected by operator

Status de entrega no aparelho, este é o segundo status que retornamos por Callback e só existe para os casos em que o primeiro status acima foi de sucesso, ou seja, a mensagem foi entregue na operadora com sucesso. Para SMS, as operadoras Oi e Sercomtel não possuem este segundo nível de status, para estas operadoras, o máximo de informação que existe, é o primeiro status, ou seja, se a operadora aceitou a mensagem ou não.:

StatusDescription
-2Operator network error
1Message received by mobile
9Message not received by mobile

REFERENCE

Envio Individual


Este método é indicado para clientes que realizão requisições contendo apenas um destinatário. Ele utiliza protocolos HTTP e HTTPS, aceita os métodos GET e POST com parâmetros query string.

– URL para envio individual

http://54.233.99.254/webservice-rest/send-single

– Instruções para chamada

A requisição precisa conter parâmetros Query String com as informações conforme campos abaixo:

* Campo obrigatório

CampoDetalhesTipo
user*Nome do usuário cadastrado em nosso site, obrigatório caso não utilize cabeçalho de autenticação.string
password*Senha de acesso do usuário, obrigatório caso não utilize cabeçalho de autenticação.string
type*Tipo do serviço, consulte o menu “Parâmetro type”.number
country_codeDDI do país de destino. (Padrão: 55)number
number*Número do telefone do destinatário sem DDI (55).number
content*(SMS):Texto da mensagem a ser enviada.string
(WHATSAPP Texto):Texto da mensagem a ser enviada.string
(WHATSAPP Imagem):URL da imagem hospedada em seu servidor. Aceito arquivo .jpg com até 1MB e máximo 1024 pixels.string
(WHATSAPP Vídeo):URL do vídeo hospedado em seu servidor. Aceito arquivo .mp4 com até 2MB.string
caption(SMS):Parâmetro não utilizado.string
(WHATSAPP):Texto com até 490 caracteres para legenda de imagem ou vídeo.string
campaign_idIdentificador da mensagem no sistema do cliente.string
scheduleData e hora em que a mensagem deve ser enviada no formato ISO 8691 (2020-11-01 15:00:00).string
timezoneFuso horário em formato UTC (-03:00).string

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Envio Individual

Em resposta à chamada, a API retornará um arquivo JSON com as informações necessárias para rastreio, será gerado um id e status do processo:

    {
            "success" : true,
            "responseCode" : "000",
            "responseDescription" : "Success queued",
            "credit" : "0"
            "balance" : "99984"
            "id" : "813831"
    }

Outro exemplo de retorno síncrono da chamada:

    {
            "success" : false,
            "responseCode" : "080",
            "responseDescription" : "Insufficient or expired balance",
            "credit" : "0"
            "balance" : "0"
    }
CampoDetalhesTipo
successEste campo indica se a requisição obteve sucesso ou não.boolean
responseCodeEste campo indica o código do status da requisição.string
responseDescriptionEste campo indica a descrição do status da requisição.string
creditEste campo indica quantos créditos foram debitados em sua conta.string
balanceEste campo indica o saldo atual de créditos em sua conta.string
idCaso a mensagem seja aceita, é retornado um código id único para rastreio.string

Para receber retornos assíncronos, consulte o menu “Callbacks da API”.

Envio em Lote

Permite o envio de mensagens em lote ou individuais passando os parâmetros por POST em um objeto JSON

– URL para envio em Lote

http://54.233.99.254/webservice-rest/send-multiple

– Instruções para chamada

O corpo da requisição precisa conter o objeto JSON com as informações conforme campos abaixo:

* Campo obrigatório

CampoDetalhesTipo
type*Tipo do serviço, consulte o menu “Parâmetro type”.number
country_codeDDI do país de destino. (Padrão: 55)number
number*Número do telefone do destinatário sem DDI (55).number
content*(SMS):Texto da mensagem a ser enviada.string
(WHATSAPP Texto):Texto da mensagem a ser enviada.string
(WHATSAPP Imagem):URL da imagem hospedada em seu servidor. Aceito arquivo .jpg com até 1MB e máximo 1024 pixels.string
(WHATSAPP Vídeo):URL do vídeo hospedado em seu servidor. Aceito arquivo .mp4 com até 2MB.string
caption(SMS):Parâmetro não utilizado.string
(WHATSAPP):Texto com até 490 caracteres para legenda de imagem ou vídeo.string
campaign_idIdentificador da mensagem no sistema do cliente.string
scheduleData e hora em que a mensagem deve ser enviada no formato ISO 8691 (2020-11-01 15:00:00).string
timezoneFuso horário em formato UTC (-03:00).string

Importante: Não é permitido o envio de mais de 5000 mensagens por requisição.

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Envio em Lote

Veja a seguir o exemplo da chamada acima:


    {
  "defaultValues":{
                   "type": 2,
                   "schedule": "2025-08-22 14:55:00",
                   "timezone": "-03:00"
              },
     "messages":[
                 {
                   "country_code": 55,
                   "number": 14999999999,
                   "content": "Mensagem de teste",
                   "campaign_id": "001"
                 },
                 {
                   "country_code": 55,
                   "number": 14999999999,
                   "content": "Mensagem de teste",
                   "campaign_id": "002"
                  }
              ]
    }              

Em resposta à chamada, a API retornará informações do processo conforme abaixo:


{
    "success": true,
    "responseCode": "001",
    "responseDescription": "Batch processed",
    "credit": "2",
    "balance": "87018",
    "totalProcessed": "2",
    "totalSuccess": "2",
    "messages": [
        {
            "success": true,
            "responseCode": "000",
            "responseDescription": "Success queued",
            "credit": "1"
        },
        {
            "success": true,
            "responseCode": "000",
            "responseDescription": "Success queued",
            "credit": "1"
        }
    ]
}

Outro exemplo de retorno síncrono da chamada:


{
    "success": true,
    "responseCode": "001",
    "responseDescription": "Batch processed",
    "credit": "1",
    "balance": "87018",
    "totalProcessed": "2",
    "totalSuccess": "1",
    "messages": [
        {
            "success": true,
            "responseCode": "000",
            "responseDescription": "Success queued",
            "credit": "1"
        },
        {
            "success": true,
            "responseCode": "050",
            "responseDescription": "Empty or invalid number",
            "credit": "0"
        }
    ]
}

Para receber retornos assíncronos, consulte o menu “Callbacks da API”.

Consulta de Status por Identificador

Para consultar o status das mensagens enviadas é necessário fazer uma requisição GET OU POST na URL abaixo passando como parâmetro o id ou o campaign_id obtido na resposta do envio

GET http://54.233.99.254/webservice-rest/mt_id

Importante: a consulta fica disponível por até 32 dias após seu envio.

Abaixo exemplo de requisições realizando a consulta por id e por campaign_id, é possivel também realizar a consulta em lote, para isso basta separar os identificadores com vírgulas

Consulta id:

GET http://54.233.99.254/webservice-rest/mt_id?user={user}&password={password}&id=1,2

Consulta campaign_id:

GET http://54.233.99.254/webservice-rest/mt_id?user={user}&password={password}&campaign_id=abc1,abc2

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Consulta de Status por Identificador

Consulta de Status por Período

Está requisição de busca irá retornar cada mensagem enviada num determinado período de tempo. Você precisa definir os parâmetros start_date e end_date para especificar um período de tempo, deverá ser utilizado o formato ISO-8601.

GET http://54.233.99.254/webservice-rest/mt_date

Importante: a consulta fica disponível por até 32 dias após seu envio.

Abaixo exemplo de requisição de consulta por período de tempo e tipo de serviço, através do parâmetro type.

GET http://54.233.99.254/webservice-rest/mt_date?user={user}&password={password}&start_date=2016-09-12T00:00:00&end_date=2016-09-15T23:59:59&type=2

Abaixo exemplo de requisição de consulta por período de tempo, tipo de serviço e status, através do parâmetro type e status.

GET http://54.233.99.254/webservice-rest/mt_date?user={user}&password={password}&start_date=2016-09-12T00:00:00&end_date=2016-09-15T23:59:59&type=2&status=0,1

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Consulta de Status por Período

Consulta por Novas Mensagens Recebidas

Retorna a lista de novas mensagens recebidas. Uma vez cosultada, a mensagem não irá mais ser retornada na chamada deste serviço.

GET http://54.233.99.254/webservice-rest/mo_new

Importante: a consulta fica disponível por até 32 dias após o recebimento.

Abaixo exemplo de requisição com definição do tipo de serviço, através do parâmetro type.

GET http://54.233.99.254/webservice-rest/mo_new?user={user}&password={password}&type=2

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Consulta por Novas Mensagens Recebidas

Consulta de Mensagens Recebidas por Período

Está requisição de busca irá retornar cada MO recebido num determinado período de tempo. Você precisa definir os parâmetros start_date e end_date para especificar um período de tempo, deverá ser utilizado o formato ISO-8601.

GET http://54.233.99.254/webservice-rest/mo

Importante: a consulta fica disponível por até 32 dias após o recebimento.

Abaixo exemplo de requisição de consulta por período de tempo e tipo de serviço, através do parâmetro type.

GET http://54.233.99.254/webservice-rest/mo?user={user}&password={password}&start_date=2016-09-12T00:00:00&end_date=2016-09-15T23:59:59&type=2

Abaixo exemplo de requisição de consulta por período de tempo e identificador da mensagem no sistema do cliente, através do parâmetro campaign_id.

GET http://54.233.99.254/webservice-rest/mo?user={user}&password={password}&start_date=2016-09-12T00:00:00&end_date=2016-09-15T23:59:59&campaign_id=abc123

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Consulta de Mensagens Recebidas por Período

Consulta de Saldo

Está requisição de busca irá retornar o saldo atual de todos os serviços, incluindo a data da última ativação de créditos e o vencimento.

GET http://54.233.99.254/webservice-rest/balance

Abaixo exemplo de requisição de consulta de saldo realizando a autenticação por parâmetros query string.

GET http://54.233.99.254/webservice-rest/balance?user={user}&password={password}

Em resposta à chamada, a API retornará informações conforme abaixo:


        {
            "success": true,
            "responseCode": "200",
            "responseDescription": "Successful search",
            "balance_1": "10",
            "balance_2": "10",
            "balance_3": "10",
            "balance_4": "10",
            "activation": "2017-12-01 17:58:23",
            "expiration": "2018-12-01 23:59:59"
        }
CampoDetalhesTipo
successEste campo indica se requisição obteve sucesso ou não.boolean
responseCodeEste campo indica o código do status da requisição.string
responseDescriptionEste campo indica a descrição do status da requisição.string
balance_1Este campo indica o saldo atual do serviço SMS.string
balance_2Este campo indica o saldo atual do serviço SMS Interativo.string
balance_3Este campo indica o saldo atual do serviço Torpedo de Voz.string
balance_4Este campo indica o saldo atual do serviço Whatsapp.string
activationEste campo indica a data da última ativação de créditos.string
expirationEste campo indica a data de vencimento dos créditos.string

Clique abaixo e veja exemplos em várias linguagens de programação:

Testar Consulta de Saldo

Callbacks da API

Nossa API pode realizar callbacks diretamente para o seu sistema, enviando status de entrega das mensagens enviadas ou informações sobre mensagens recebidas de seus clientes/contatos.

Callback de Status de Entrega

Nossa plataforma envia ao sistema do cliente o status das mensagens enviadas, requisições via GET com parâmetros Query String.

Para receber o status, é necessário configurar uma URL de notificação na plataforma, solicite para nosso suporte esta configuração.

Veja abaixo um exemplo do que você receberá em seu sistema:

http://suaUrl.com/callback.php?campaign_id=abc123&id=150&status=0&date=2017-01-01+15:00:00&carrier=Vivo+-+Celular

Callback de Mensagem Recebida

Nossa plataforma envia ao sistema do cliente uma requisição para cada mensagem recebida de um celular, requisições via GET com parâmetros Query String. (esta funcionalidade é utilizada, por exemplo, para enquetes, SAC, pesquisas, confirmações de visita etc).

Para receber está requisição em seu sistema, é necessário configurar uma URL de notificação na plataforma, solicite para nosso suporte esta configuração.

Veja abaixo um exemplo do que você receberá em seu sistema:

http://suaUrl.com/callback.php?number=551499999999&content=Recebido&campaign_id=abc123&id=150&status=4&date=2017-01-02+15:00:00&carrier=Vivo+-+Celular

A SpeedMarket é a melhor empresa do mercado quando se trata de integração com empresas através da API SMS Short Code. Oferecemos a melhor rota de SMS, a melhor API e a melhor qualidade de serviço, com taxas de erro muito baixas. Além disso, nossos serviços de atendimento ao cliente são de primeira linha, garantindo que você tenha a melhor experiência possível. Venha fazer parte do nosso time, cadastre-se em nosso site para fazer um teste gratuito e descubra por que somos a melhor empresa do mercado.

API SMS Short Code
Plano de SMS para Empresas

Os comentários estão encerrados.

Converse agora com um Especialista