API de SMS
Noticias
SMS Local SMS API le permite probar el envío de mensajes SMS a cualquier destino a través de una API REST. Cada mensaje se identifica mediante un ID aleatorio único para que los usuarios siempre puedan verificar el estado de un mensaje mediante el punto final determinado. SMS Local SMS API utiliza verbos HTTP y una estructura de punto final RESTful con una clave de acceso (token) que se utiliza como autorización de API. Las cargas útiles de solicitud y respuesta se formatean como JSON utilizando codificación UTF-8 y valores codificados en URL.
Punto final de la API
Todas las URL a las que se hace referencia en SMS La documentación de la API de SMS de CPaaS local tiene la URL base:
https:// {seguro.smslocal.com} /api/service/servicio-empresarial/externo/sms
Métodos HTTP disponibles
La API local de SMS utiliza verbos HTTP para comprender si desea leer (GET) o crear (POST) un objeto.
PUBLICAR {protocolo}:// {seguro.smslocal.com} /api/service/servicio-empresarial/externo/sms {protocolo}:// {seguro.smslocal.com} /api/service/servicio-empresarial/externo/sms
Parámetros de autenticación
| Parámetro | Descripción |
|---|---|
| Token | Al llamar a nuestra API, envíe su clave de acceso con el tipo de autenticación establecido como Token (Ejemplo: Token: {accessKey}). Obligatorio. |
| Content-Type | Establecer en aplicación/json |
Ejemplo de autenticación:
rizo -X PUBLICAR https://test-cpaas.enabld.tech/api/service/enterprise-service/external/sms -H
"Token: 7K1aSEyjlE5FUf0"
"Token: 7K1aSEyjlE5FUf0"
El objeto del mensaje
| Atributos | Tipo | Descripción |
|---|---|---|
| msgstr | uuid | Una identificación aleatoria única que se crea en la plataforma del proveedor de servicios y se devuelve al crear el objeto. |
| De | Cordón | El remitente del mensaje. Puede ser un número de teléfono (incluido el código del país) o una cadena alfanumérica. En el caso de una cadena alfanumérica, la longitud máxima es de 11 caracteres. |
| a | int | Número de destinatario |
| contenido | cadena | El contenido del mensaje SMS |
| codificación de datos | int | Nota: el uso de Unicode limitará la cantidad máxima de caracteres a 70 en lugar de 160. Si el tamaño de caracteres del mensaje excede el límite, los mensajes se concatenarán, lo que dará como resultado mensajes facturados por separado. |
| Enviar | datetime | La fecha y hora de creación del mensaje en formato RFC3339 (Ym-dTH:i:sP) |
| dirección | cadena | Le indica si el mensaje se envió o se recibió. mt: móvil terminado (enviado al móvil) mo: móvil originado (recibido del móvil) |
| código de error | int | Código de error del mensaje |
Ejemplo de objeto de mensaje (SMS)
{"msgstr“:”jsauGFsyuadssaiu”,
"desde":"nuevo",
"a“:”373795846855”,
"dirección":"monte",
"contenido“:”Este es un mensaje de prueba”,
“codificación de datos”:”0″,
"Envíalo“:”2022-12-29T15:10:00+02:00”,
“código de error”: “200″}
"desde":"nuevo",
"a“:”373795846855”,
"dirección":"monte",
"contenido“:”Este es un mensaje de prueba”,
“codificación de datos”:”0″,
"Envíalo“:”2022-12-29T15:10:00+02:00”,
“código de error”: “200″}
Enviar SMS
La API de SMS programable local de SMS le permite enviar mensajes SMS de forma programática desde su aplicación web. Primero, debe crear un nuevo objeto de mensaje. SMS Local devuelve el objeto de mensaje creado con cada solicitud. Envíe su primer mensaje SMS con esta solicitud de ejemplo.
Solicitud de ejemplo
curl –ubicación –solicitud PUBLICAR https://test-cpaas.enabld.tech/api/service/enterprise-service/external/sms
-encabezamiento Content-Type: aplicación/json –encabezado
"Token: 7K1aSEyjlE5FUf0"
datos{“desde”:”nuevo”, “hasta”:”373795846855″,”contenido”:”Este es un mensaje de prueba“}
-encabezamiento Content-Type: aplicación/json –encabezado
"Token: 7K1aSEyjlE5FUf0"
datos{“desde”:”nuevo”, “hasta”:”373795846855″,”contenido”:”Este es un mensaje de prueba“}
Respuesta de ejemplo
"msgstr“: “d0skeudgeh2l”, “código de error“: “200”
Informe de estado del manejo
Los informes de estado son solicitudes HTTP GET o POST que se envían a su plataforma. Las solicitudes contienen información sobre el estado de un mensaje que ha enviado a través de nuestra API. Los informes de estado solo se proporcionan para los mensajes SMS que tienen una referencia definida al enviar el mensaje y una URL de informe de estado se establece como URL de informe al enviar el mensaje o se configura en su cuenta como punto final de devolución de llamada.
| Atributos | Tipo | Descripción |
|---|---|---|
| msgstr | cadena | El ID del mensaje asignado al mensaje por el sistema CPaaS cuando se envió originalmente. |
| beneficiario | int | El MSISDN del destinatario. |
| estado | int | nulo | Código de error que describe la falla (opcional, nulo si no está disponible). Puede contener un código de error específico de la red o un código de error de SMSC para el intento de entrega del mensaje. |
| Código de error de estado | cadena | El contenido del mensaje SMS |
| subfecha | datetime | La hora y fecha en que se envió el mensaje. En el caso de un mensaje que haya sido reemplazado, esta es la fecha en que se reemplazó el mensaje original. El formato es el siguiente: AAMMDDhhmm |
| fecha de entrega | datetime | La hora y la fecha en que el mensaje llegó a su estado final. El formato es el mismo que el de la fecha de envío. |
| codificación de datos | cadena | Codificación del mensaje. Valores posibles: GSM7, Unicode. |
| smspart | int | Indica que el SMS es parte de un mensaje largo. |
| identificador de sms | int | El número de pieza del SMS largo. |
Respuesta
La plataforma Enterprise debe responder con un encabezado HTTP 200 OK. Cuando la plataforma no recibe un encabezado 200 OK, intentará entregar el recibo nuevamente (según la política de STFW).
Solicitud de ejemplo
http://secure.smslocal.com/ report?msgid=gstafd4saftghsad& recipient=373798756364& status=Delivrd&statusDatetime=2017-09-01T10:00:05+00:00&datacoding=Gsm7
Respuesta de ejemplo
200 OK