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.
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.
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.
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.
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.
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;
2. Notificações em tempo real;
3. Gerenciamento de conteúdo eficaz;
4. Melhor serviço ao cliente;
5. Fidelização dos clientes;
6. Mensagens personalizadas;
7. Maior eficiência operacional;
8. Maior alcance de mensagens;
9. Aumento da produtividade;
10. Redução de custos
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.
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.
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.
Autenticação:
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:
É 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.
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
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).
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:
type | Tipo do Serviço |
---|---|
0 | SMS |
1 | SMS Interativo(Modo Flash) |
2 | SMS Interativo |
3 | Torpedo de Voz (Apenas Texto) |
4 | Torpedo de Voz (Áudio) |
5 | Whatsapp (Apenas Texto) |
6 | Whatsapp (Imagem) |
7 | Whatsapp (Áudio) |
8 | Whatsapp (Vídeo) |
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 |
responseCode | responseDescription | success |
---|---|---|
000 | Success queued | true |
001 | Batch processed | true |
002 | Scheduled | true |
010 | User or password is invalid | false |
020 | Empty or invalid type | false |
030 | Empty message content | false |
040 | Scheduling date invalid or incorrect | false |
050 | Empty or invalid number | false |
060 | International sending not allowed | false |
070 | Message rejected by server | false |
080 | Insufficient or expired balance | false |
090 | Blocked account – Please contact support | false |
100 | This service is currently under maintenance | false |
110 | There was an error processing, please try again, or contact us | false |
120 | Message array cannot exceed 5000 | false |
130 | Message array is empty | false |
140 | Incorrect time zone | false |
150 | File extension not allowed | false |
160 | Unknown method or unknown parameter | false |
170 | Invalid search attributes | false |
200 | Successful search | true |
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:
Status | Description |
---|---|
-1 | Message Queued |
3 | Preparing message to send |
6 | Paused Message |
Status de entrega na operadora, este é o primeiro status que retornamos por Callback:
Status | Description |
---|---|
-9 | Blocked – No Coverage |
-8 | Blocked – Content not allowed |
-7 | Number has no WhatsApp (Only for WhatsApp) |
-6 | Message successfully canceled |
-5 | Blocked – Black listed |
-4 | Blocked – landline Number |
-3 | Blocked – Invalid Number |
0 | Message received to operator |
7 | Message expired by operator |
8 | Message 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.:
Status | Description |
---|---|
-2 | Operator network error |
1 | Message received by mobile |
9 | Message not received by mobile |
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.
http://54.233.99.254/webservice-rest/send-single
A requisição precisa conter parâmetros Query String com as informações conforme campos abaixo:
* Campo obrigatório
Campo | Detalhes | Tipo |
---|---|---|
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_code | DDI 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_id | Identificador da mensagem no sistema do cliente. | string |
schedule | Data e hora em que a mensagem deve ser enviada no formato ISO 8691 (2020-11-01 15:00:00). | string |
timezone | Fuso horário em formato UTC (-03:00). | string |
Clique abaixo e veja exemplos em várias linguagens de programação:
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"
}
Campo | Detalhes | Tipo |
---|---|---|
success | Este campo indica se a requisição obteve sucesso ou não. | boolean |
responseCode | Este campo indica o código do status da requisição. | string |
responseDescription | Este campo indica a descrição do status da requisição. | string |
credit | Este campo indica quantos créditos foram debitados em sua conta. | string |
balance | Este campo indica o saldo atual de créditos em sua conta. | string |
id | Caso a mensagem seja aceita, é retornado um código id único para rastreio. | string |
Para receber retornos assíncronos, consulte o menu “Callbacks da API”.
Permite o envio de mensagens em lote ou individuais passando os parâmetros por POST em um objeto JSON
http://54.233.99.254/webservice-rest/send-multiple
O corpo da requisição precisa conter o objeto JSON com as informações conforme campos abaixo:
* Campo obrigatório
Campo | Detalhes | Tipo |
---|---|---|
type * | Tipo do serviço, consulte o menu “Parâmetro type”. | number |
country_code | DDI 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_id | Identificador da mensagem no sistema do cliente. | string |
schedule | Data e hora em que a mensagem deve ser enviada no formato ISO 8691 (2020-11-01 15:00:00). | string |
timezone | Fuso 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:
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”.
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:
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
.
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
.
Clique abaixo e veja exemplos em várias linguagens de programação:
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:
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
.
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
.
Clique abaixo e veja exemplos em várias linguagens de programação:
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"
}
Campo | Detalhes | Tipo |
---|---|---|
success | Este campo indica se requisição obteve sucesso ou não. | boolean |
responseCode | Este campo indica o código do status da requisição. | string |
responseDescription | Este campo indica a descrição do status da requisição. | string |
balance_1 | Este campo indica o saldo atual do serviço SMS. | string |
balance_2 | Este campo indica o saldo atual do serviço SMS Interativo. | string |
balance_3 | Este campo indica o saldo atual do serviço Torpedo de Voz. | string |
balance_4 | Este campo indica o saldo atual do serviço Whatsapp. | string |
activation | Este campo indica a data da última ativação de créditos. | string |
expiration | Este campo indica a data de vencimento dos créditos. | string |
Clique abaixo e veja exemplos em várias linguagens de programação:
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:
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:
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.
Nos chame no Whatsapp!