Observe que você precisará da ajuda da nossa equipe para iniciar suas campanhas de SMS mesmo após a integração da API. Então, solicito que você entre em contato após a integração.
Introdução
O Message Now é uma API de mensagens versátil projetada para facilitar o envio de mensagens por SMS e RCS.
Ajuda e suporte
Para suporte de implementação e qualquer feedback, entre em contato conosco em: support@messagecentral.com
Parâmetro de API para Message Now
RCS/SAUTH
Modos de envio de mensagens
O Message Central oferece dois modos principais para enviar mensagens por meio da API Message Now:
Enviar uma mensagem para um único número
Para enviar uma mensagem para um único número, preencha os seguintes campos da API:
MobileNumber: O número do celular do destinatário.
Mensagem: O conteúdo do texto da mensagem a ser enviada.
Enviar uma mensagem para vários números
Há dois métodos para enviar mensagens para vários números:
a. Usando o upload de arquivos com várias partes
Upload de arquivo: use o parâmetro API (arquivo) para fazer upload de um arquivo com várias partes.
Mensagem: use o parâmetro da API (mensagem) para o texto a ser enviado.
Formato de arquivo: Somente arquivos.xlsx são suportados.
Personalização: Esse método oferece suporte a mensagens personalizadas por usuário, permitindo conteúdo de mensagem diferente para cada destinatário listado no arquivo.
b. Usando o campo API para vários números
PhoneNumbers: use o parâmetro da API (PhoneNumbers) para especificar a lista de números de destinatários. (formato: <space>celular do país: por exemplo - 91 9816111111, 91 7715131105,...)
Mensagem: use o parâmetro da API (mensagem) para o texto a ser enviado.
Formato de arquivo: Somente arquivos.xlsx são suportados.
Personalização: Esse método oferece suporte a mensagens personalizadas por usuário, permitindo conteúdo de mensagem diferente para cada destinatário listado no arquivo.
Diferença entre o upload de arquivos com várias partes e o campo de números de telefone:
Upload de arquivos com várias partes (.xlsx): permite mensagens personalizadas por usuário. Cada destinatário pode receber uma mensagem exclusiva conforme especificado no arquivo.xlsx carregado.
Campo de números de telefone: envia o mesmo texto para todos os destinatários. A mensagem especificada no campo de mensagem será entregue uniformemente a todos os listados no campo Números de telefone.
Encontre o formato de arquivo de amostra no formato XLXS abaixo:
Onde 'var1', 'var2' e 'var3' são espaços reservados para variáveis.
Se uma empresa quiser enviar uma mensagem personalizada usando o upload de arquivos, o campo da mensagem deverá ser formatado da seguinte forma:
Exemplo de mensagem - “Olá # #var ##, seu saldo é # #var2 ## na data # #var3 ##
Agarre a oportunidade
Se você é desenvolvedor ou agência de desenvolvimento web, faça uma parceria conosco para acelerar seus ganhos.
Torne-se um parceiro
Enviar SMS
RCS/SAUTH
Para enviar um SMS para um número de celular, os seguintes parâmetros de solicitação são necessários. Um token de autenticação, gerado pela API de geração de tokens, é necessário para enviar o SMS.
https://cpaas.messagecentral.comAo usar a API de verificação de SMS do Verify Now para enviar códigos de verificação por SMS, a chamada inicial deve ser para a API de geração de token.
Essa API retorna um token que deve ser incluído em todas as chamadas subsequentes. É necessário um token de autenticação para validar o usuário e deve ser incluído na seção de cabeçalho de cada solicitação.
Caminho do URL da solicitação:
Uma resposta bem-sucedida retornará um código de status 200.
/verification/v3/sendParâmetros da solicitação:
Uma resposta bem-sucedida retornará um código de status 200.
OBSERVAÇÃO: O ID do modelo e o ID da entidade são obrigatórios se o modelo não estiver registrado na Central de Mensagens. Além disso, templateID e entityID devem estar presentes ou ambos devem estar ausentes.
cURL
1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowT ype=SMS&mobileNumber=9999999999&senderId=UTOMOB&type=SMS&message=%3CYour%20 Message%20Template%3E&messageType=PROMOTIONAL' \--header 'authToken: eyJhbGciOiJIUzUxMiJ9.thisisatesttoken.IgGu7Sb4lovBSql5LIXZU3jlwPG4giAMZ2kTI Mg_EAaKVsVcCdpW_TYzyzdTd94GdEJMt5WntEGcEX4w0hITng'
OBSERVAÇÃO: Para converter um comando cURL em código usando o Postman, abra o Postman, importe o comando cURL por meio do botão “Importar” e gere o código no idioma de sua preferência clicando no botão “Código” no lado direito da solicitação.
Resposta JSON
Uma resposta bem-sucedida retornará um código de status 200.
1{
2 "responseCode": 200,
3 "message": "SUCCESS",
4 "data": {
5 "verificationId": "1234",
6 "mobileNumber": "9999999999",
7 "responseCode": "200",
8 "errorMessage": null,
9 "timeout": "30.0",
10 "smsCLI": null,
11 "transactionId": "1c9c56ec-5cd3-48b5-9e32-a15499fb77a2"
12 }
13}Códigos de exemplo
curl --location 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowType=SMS&mobileNumber=9999999999&senderId=UTOMOB&type=SMS&message=%3CYour%20Message%20Template%3E&messageType=PROMOTIONAL' \
--header 'authToken: eyJhbGciOiJIUzUxMiJ9.thisisatesttoken.IgGu7Sb4lovBSql5LIXZU3jlwPG4giAMZ2kTIMg_EAaKVsVcCdpW_TYzyzdTd94GdEJMt5WntEGcEX4w0hITng' \
--form 'file=@"/C:/Users/Kunal Suryawanshi/Downloads/Sample_MessageNow.xlsx"'OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com")
.method("GET", body)
.addHeader("accept", "*/*")
.build();
Response response = client.newCall(request).execute();var request = require('request');
var options = {
'method': 'GET',
'url': 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com',
'headers': {
'accept': '*/*'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'accept' => '*/*'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}import requests
url = "https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com"
payload = {}
headers = {
'accept': '*/*'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
require "uri"
require "net/http"
url = URI("https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "*/*"
response = https.request(request)
puts response.read_body
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com");
request.Headers.Add("accept", "*/*");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());Integração de retorno de chamada SMS com o Message Central
Para receber retornos de chamada por SMS e mantê-los em seu próprio sistema para receber atualizações de status de todas as mensagens enviadas por meio de nosso serviço, siga estas etapas:
1. Informações necessárias:
a. ID do cliente
b. Nome da marca
c. ID de e-mail registrado
d. URL de retorno de chamada
2. Instruções de envio: Envie as informações acima para operations@messagecentral.com com o assunto “Integração de retorno de chamada SMS com a Central de Mensagens.
3. Especificações do URL de retorno de chamada: Certifique-se de que seu URL de retorno de chamada esteja acessível e seja capaz de receber solicitações HTTP POST contendo cargas JSON com atualizações de status das mensagens SMS enviadas. Ao ser acionado, o endpoint receberá a seguinte carga JSON.
1{
2"apiKey": null,
3"clientId": null,
4"messageId": "a2e87214-d18c-4a2e-b7f4-802c4465a9b9",
5"status": "DELIVRD",
6"errorCode": 0,
7"countryCode": null,
8"mobile": "919999999999",
9"submitDate": "2023-11-02 13:59:18",
10"doneDate": "2023-11-02 13:59:22"
11}
4. Status padrão: Esses são os seguintes status que você receberá para todas as mensagens enviadas.
a. ENTREGUE
b. EXPIRADO
c. UNDELIV
d. DESCONHECIDO
e. REJEITADO
Para obter mais assistência ou esclarecimentos, entre em contato com nossa equipe de suporte em: -support@messagecentral.com
Como faço para autenticar solicitações na API do SMS?
As solicitações da API SMS são autenticadas usando Credenciais da API, normalmente uma chave ou token de API passado no cabeçalho ou nos parâmetros da solicitação. A autenticação garante que somente aplicativos autorizados possam enviar mensagens SMS e acessar relatórios de entrega. As credenciais são geradas no painel e devem ser mantidas em segurança.
Qual formato de solicitação a API SMS usa?
A maioria APIs de SMS use um Formato de solicitação baseado em REST por HTTPS. As solicitações geralmente são enviadas como chamadas HTTP POST com parâmetros formatados em formato JSON ou codificado por URL. Isso faz com que esses APIs de SMS em massa fácil de integrar com aplicativos móveis e da web.
Quais parâmetros são necessários para enviar um SMS usando a API?
Para enviar um SMS usando uma API ou Gateway de SMS, os parâmetros necessários normalmente incluem o número de telefone do destinatário, conteúdo da mensagem, ID do remetente, e credenciais de autenticação. Algumas APIs também exigem um tipo de mensagem, como SMS transacional ou SMS promocional.
Como faço para enviar uma OTP usando a API SMS?
Você pode enviar uma OTP usando a API SMS passando o número do destinatário, o conteúdo da mensagem OTP e o tipo de mensagem como parâmetros em uma solicitação de API. A API gera um ID de mensagem, permitindo que os aplicativos rastreiem a entrega e verifiquem a OTP durante autenticação de usuário.
Como faço para enviar SMS em massa usando a API de SMS?
SMS em massa pode ser enviado usando uma API de SMS enviando vários números de destinatários em uma única solicitação ou fazendo o upload de uma carga útil em lote. A API processa as mensagens de forma assíncrona e fornece relatórios de entrega para cada destinatário.
Como faço para verificar o status de entrega de SMS usando a API?
O status de entrega do SMS pode ser verificado usando o ID da mensagem retornado pela API. Os aplicativos podem consultar um endpoint de relatório de entrega ou receber atualizações de entrega por meio de retornos de chamada ou webhooks configurados durante a integração da API.
A API SMS oferece suporte a webhooks ou retornos de chamada?
Sim A maioria das APIs de SMS suporta webhooks ou retornos de chamada que notificam seu aplicativo quando uma mensagem é entregue, falha ou expira. Os retornos de chamada permitem o rastreamento da entrega em tempo real sem consultar a API repetidamente.
Quais status de entrega a API de SMS retorna?
Uma API de SMS normalmente retorna status de entrega, como na fila, enviado, entregue, falharam, ou expirado. Esses status ajudam os aplicativos a monitorar o progresso da mensagem e a agir quando ocorrem problemas de entrega.
Quais códigos de erro a API SMS retorna?
As APIs de SMS retornam padronizadas códigos de erro para problemas como falha de autenticação, números inválidos, saldo insuficiente ou rotas bloqueadas. Cada código de erro é acompanhado por uma descrição para ajudar os desenvolvedores a depurar e lidar com falhas de forma programática.
A taxa da API SMS é limitada?
Sim As APIs de SMS geralmente impõem limites de taxa para evitar abusos e garantir a estabilidade do sistema. Os limites de taxa definem quantas solicitações um aplicativo pode fazer em uma determinada janela de tempo e podem variar com base no tipo de conta ou no nível de uso.
.png){kind=small}
