logo

Conexión HTTP

Last update: 3 years ago by yered.rios

El servicio web proporcionado atiende una solicitud POST del protocolo HTTP, el cuál recibe cadenas JSON y devuelve un resultado en el mismo formato.

A continuación, se muestra la información necesaria para realizar la conexión del servicio.


DOMINIOhttps://api.broadcastermobile.com
URLhttp://[dominio]/brdcstr-endpoint-web/services/messaging/
METHODPOST
HEADERSContent-Type: application/json
Authorization: [token]

Body

{
"apiKey": [numeric][required],
"carrier": [string][optional],
"country": [string][required],
"dial": [numeric][optional],
"message": [String][required],
"msisdns": [String[]][required],
"tag": [String][required],
"mask": [String][optional],
"msgClass": [numeric][optional],
"schedule":[String][optional][format: ISO-8601],
"dlr":[Boolean][optional],
"optionals":[String][optional]
}

ParámetrosDescripciónObligatorio
dominioEs la ruta en dónde se encontrará alojado el servicio, esta información será proporcionada por Concepto Móvil.Si
AuthorizationEs un “token” privado que será proporcionado por Concepto Móvil y será utilizado como llave para poder realizer la conexión.Si
apiKeyIdentificador del cliente proporcionado por Concepto Móvil. Es único para cada cliente.Si
carrierNombre del operador al que pertenece el MSISDN al que se le enviará el mensaje. Las posibles opciones a enviar son:
  • TELCEL
  • ATT
  • MOVISTAR

Estas deben ser ingresadas tal como se indica en la lista. Si se negoció Perfilamiento, no es necesario realizar el envío de este parámetro, de este modo la plataforma perfilará los números.
No
countryIdentificador del país (ISO2) dos caracteres en mayúsculas.Si
dialNúmero de marcación que se utilizará para enviar el mensaje.Si
messageTexto a enviar (160 Caracteres). Si se envía un texto de más de 160 caracteres la plataforma concatenará estos mensajes en múltiplos de 153 caracteres. Debe utilizar caracteres soportados por la codificación GSM7 cualquier carácter que no corresponda a esta codificación puede ocasionar que el mensaje no se muestre de forma adecuada.Si
msisdnsNúmero con 10 dígitos más lada, al que se le enviará el mensaje, debe ser ingresado ente corchetes.Si
tagTexto que sirve para identificar la petición. Abierta para que se envié la cadena deseada por el usuario, se sugiere enviar el nombre de la campaña. Obligatorio
maskTexto de la máscara con la que se desea que llegue el mensaje. Para cuando se requiera enmascaramiento, se debe tener acordado previamente la posibilidad de usar esta funcionalidad.No
scheduleFecha y hora en la que se enviará el mensaje, debe incluir la zona horaria. Si no se incluye este atributo se programará el envío de forma inmediata.No
msgClassValor que indica si será mensaje normal o mensaje flash Normal 0 y Flash 1). Si no se incluye este atributo se tomará como si fuera cero.No
dlrValor que indica si es requerida la notificación DeliveryReceipt para entregarse hacia una url proporcionada por el cliente. Si s especifica como verdadero, se requiere el dato “registeredDelivery”.No
optionalsValor en el cual se asignan variables especificas según se requiera en formato json {“propiedad”:”valor”}
  • registeredDelivery: Obligatorio si se especifica el dato “dlr”. Valores permitidos:
    • 1: Indica cuando el operador ha enviado el MT al dispositivo.
    • 5: Indica cuando el dispositivo ha recibido el MT.
    • 11: Indica cuando se ha enviado el MT al operador.
No

Ejemplo

{
"apiKey": 22,
"carrier": "Telcel",
"country": "mx",
"dial": 12345,
"message": "Mensaje prueba",
"msisdns": [525512345678],
"tag": "Tag prueba",
"mask": "MASCARA",
"schedule": "2018-07-01T10:15:30+01:00",
"dlr":"true",
"optionals":"{"registeredDelivery":11}"
}
SMS — Anterior
Envíos masivos
Siguiente
Respuesta