Documentación de la API de SMS

Versión — 1.0
info

Tenga en cuenta que necesitará la ayuda de nuestro equipo para iniciar sus campañas de SMS incluso después de la integración de la API. Por lo tanto, le solicito que póngase en contacto después de la integración.

Introducción

Message Now es una API de mensajería versátil diseñada para facilitar el envío de mensajes por SMS y RCS.

Ayuda y soporte

Para obtener asistencia sobre la implementación y cualquier comentario, póngase en contacto con nosotros en: support@messagecentral.com

Parámetro de API para Message Now

API Parameter
Type
Value
flowType
String
SMS/WHATSAPP/
RCS/SAUTH
type
String
OTP

Modos de envío de mensajes

Message Central ofrece dos modos principales para enviar mensajes a través de la API Message Now:

  1. Enviar un mensaje a un solo número

    • Para enviar un mensaje a un solo número, rellena los siguientes campos de la API:

    • Número de teléfono móvil: el número de teléfono móvil del destinatario.

    • Mensaje: el contenido de texto del mensaje que se va a enviar.

  2. Enviar un mensaje a varios números 


    Hay dos métodos para enviar mensajes a varios números:

a. Uso de la carga de archivos multiparte

  • Carga de archivos: utilice el parámetro API (archivo) para cargar un archivo de varias partes.

  • Mensaje: utilice el parámetro API (mensaje) para el texto que se va a enviar.

  • Formato de archivo: solo se admiten archivos.xlsx.

  • Personalización: este método admite mensajes personalizados por usuario, lo que permite un contenido de mensaje diferente para cada destinatario incluido en el archivo.

b. Uso del campo API para varios números

  • PhoneNumbers: utilice el parámetro de API (phoneNumbers) para especificar la lista de números de destinatarios. (formato: país <space>móvil: por ejemplo, 91 9816111111, 91 7715131105,...)

  • Mensaje: utilice el parámetro API (mensaje) para el texto que se va a enviar.

  • Formato de archivo: solo se admiten archivos.xlsx.

  • Personalización: este método admite mensajes personalizados por usuario, lo que permite un contenido de mensaje diferente para cada destinatario incluido en el archivo.

Diferencia entre la carga de archivos multiparte y el campo de números de teléfono:

  • Carga de archivos multiparte (.xlsx): permite enviar mensajes personalizados por usuario. Cada destinatario puede recibir un mensaje único, tal y como se especifica en el archivo.xlsx cargado.

  • Campo PhoneNumbers: envía el mismo texto a todos los destinatarios. El mensaje especificado en el campo de mensajes se entregará de manera uniforme a todos los que aparezcan en el campo Números de teléfono.

A continuación encontrará el formato de archivo de muestra en formato XLXS:

Country
Mobile
Var1
Var2
Var3
91
12345678901
Amit
$35
DISOUNT20
91
23456789012
Kunal
$60
DISOUNT20
91
12345678901
Prakash
$35
DISOUNT20

Donde 'var1', 'var2' y 'var3' son marcadores de posición para las variables.

Si una empresa desea enviar un mensaje personalizado mediante la carga de archivos, el campo del mensaje debe tener el siguiente formato:

Ejemplo de mensaje - «Hola # #var ##, tu saldo es # #var2 ## en la fecha # #var3 ##

Enviar SMS

Request Header
Type
Mandatory?
authToken
String
SMS/WHATSAPP/
RCS/SAUTH

Para enviar un SMS a un número de teléfono móvil, se requieren los siguientes parámetros de solicitud. Es necesario un token de autenticación, generado por la API de generación de tokens, para enviar el SMS.

https://cpaas.messagecentral.com

Al usar la API de verificación por SMS de Verify Now para enviar códigos de verificación por SMS, la llamada inicial debe ser a la API de generación de tokens.

Esta API devuelve un token que debe incluirse en todas las llamadas posteriores. Se necesita un token de autenticación para validar al usuario y debe incluirse en la sección de encabezado de cada solicitud.

Field
Type
Mandatory?
Description
customerId
String
yes
Customer identifier (need to signup to get your  customer id)
country
String
no
Country code to send OTP to
email
String
no
Email
key
String
String
Base-64 encrypted password
scope
String
no
Use ‘NEW’ for first time

Ruta URL de solicitud:

Una respuesta correcta devolverá un código de estado 200.

/verification/v3/send

Parámetros de solicitud:

Una respuesta correcta devolverá un código de estado 200.

Field
Type
Mandatory?
Description
type
String
yes
Use “SMS” while sending SMS
file
xlxs
no
This needs to be sent as form data
countryCode
String
Yes (in case of single SMS & Verify Now)
CountryCode
otpLength
Integer
No
Base-64 encrypted password
mobileNumber
String
Yes (in case of single SMS)
Mobile number for single text
flowType
String
Yes
Send “SMS”
messageType
String
No (default is OTP)
The type of message to be sent (Allowed values are TRANSACTION, PROMOTIONAL, OTP)
senderId
String
Yes (in case of SMS)
ID of the sender
phoneNumbers
String
No
A list of phone numbers to send the SMS (format: country <space>mobile : 
91  9876111111)
message
String
No
The custom message to be sent
templateId
String
No
Template Id of your approved template
entityId
String
No
Entity Id of your brand

NOTA: El ID de plantilla y el ID de entidad son obligatorios si la plantilla no está registrada en Message Central. Además, tanto TemplateID como EntityID deben estar presentes o ambos deben 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'

NOTA: Para convertir un comando cURL en código con Postman, abre Postman, importa el comando cURL mediante el botón «Importar» y, a continuación, genera el código en tu idioma preferido haciendo clic en el botón «Código» situado a la derecha de la solicitud.

Respuesta JSON

Una respuesta correcta devolverá un código de estado 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 ejemplo

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());

Integración de devolución de llamadas por SMS con Message Central

Para recibir llamadas por SMS y mantenerlas en su propio sistema para recibir actualizaciones de estado de todos los mensajes enviados a través de nuestro servicio, siga estos pasos:

1. Información requerida:
a. ID de cliente
b. Nombre de la marca
c. ID de correo electrónico registrado
d. URL de devolución de llamada

2. Instrucciones de envío: Envíe la información anterior a operations@messagecentral.com con el asunto «Integración de devolución de llamadas por SMS con Message Central».

3. Especificaciones de la URL de devolución de llamada: Asegúrese de que la URL de devolución de llamada sea accesible y capaz de recibir solicitudes HTTP POST que contengan cargas útiles JSON con actualizaciones de estado de los mensajes SMS enviados. Al activarse, el punto final recibirá la siguiente carga útil de 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. Estado estándar: Estos son los siguientes estados que recibirá para todos los mensajes enviados.
a. ENTREGADO 

b. CADUCADO
c. UNDELIV
d. DESCONOCIDO
e. RECHAZADO

Para obtener más ayuda o aclaraciones, póngase en contacto con nuestro equipo de soporte en: -support@messagecentral.com

¿Estás listo para empezar?

Proteja sus cuentas de usuario y genere confianza con sus clientes mediante la verificación por SMS. Prueba Verify Now sin ninguna tarjeta de crédito.

Message Central Logo Blue
Close Icon
Equipo central de mensajes
¡Hola!
¿Cómo podemos ayudarlo hoy?
WhatsApp Icon
Iniciar el chat de Whatsapp
WhatsApp Chat
WhatsApp Icon