Permite el envío de SMS a nuestros clientes registrados

URL del recurso

https://restapi.marketext.com/sms/{api_id}

Autenticación

Nuestra API Rest utiliza un esquema de autenticación basado en esta especificación OAuth 2.

Authorization: Token

Todas las solicitudes de envío deberán incluir el encabezado Authorization con el siguiente formato:

Authorization: Token ASDFGHJKLZXCVBNMQWERTYUIOP1234567890==
Importante: Al usar este método de autorización, es obligatorio incluir el parámetro user.

Parámetros

ParámetroDescripciónRequeridoValor Predeterminado
user ID del usuario de la cuenta que realiza los envíos Obligatorio
destination Número de destino, si su cuenta es internacional deberá anteponer el prefijo del país al que desea enviar el SMS Obligatorio
text Mensaje a enviar, si la longitud es mayor a 160 caracteres, se partirá en múltiples SMS de 160 caracteres cada una Obligatorio
senderid Remitente personalizado puede contener entre 4 y 11 caracteres A-Za-z0-9 Disponibilidad depende del operador / No disponible para ningún operador en Colombia Opcional
smstype Tipo de envío: instant Inmediato / scheduled Programado Opcional instant
date_delivery Si el SMS es programado, debe definir la fecha de envío en formato AAAA-MM-DD Opcional
time_delivery Si el SMS es programado, debe definir la hora de envío en formato 24 horas HH:MM Opcional
format Solicita el formato de respuesta ya sea JSON/XML/CSV/URLencoded Opcional

Ejemplo

POST http://restapi.marketext.com/sms/democompany?destination=3001234567&text=Hello World!

Solicitud

  
  $headers = array('Authorization: Token ec120228fa6fd17e2545703b4cd3eba2gGYlFChF2R2k0ecCS2HluJpjRuonl8LsdBhO9Ne96j8=');

  $data=array('destination'=>'3001234567', 'text'=>'Prueba REST Api Marketext - Autorizacion con Token' );

  $client = new RESTClient();
  $client->setHeaders($headers);
  $client->setData($data);
  $client->setUrl("http://restapi.marketext.com/sms/democompany");
  $client->setMethod("POST");
  $client->execute();
  $response = $client->getLastResponse();
  $client->resetClient();  

Formato Respuesta

Utilice el encabezado
Accept
para especificar el formato de salida deseado, si no es posible para usted definir el encabezado
Accept
, puede utilizar el parámetro
format
.

Tenga en cuenta que el parametro
format
tiene prioridad sobre el encabezado
Accept
.
Formatos disponibles:
Respuesta esperadaParámetro a enviar
JSONapplication/json
XMLapplication/xml
CSVtext/csv
Form URL Encodedapplication/x-www-form-url-encoded
 
  
JSON
{ "Number" => "573001234567", "MsgID" => "a2f5adbf76124fdcfc31f5acd6e9463f" }
XML
<?xml version="1.0"?> <respuesta><Number>573001234567</Number><MsgID>a2f5adbf76124fdcfc31f5acd6e9463f</MsgID></respuesta>
CSV
573001234567,a2f5adbf76124fdcfc31f5acd6e9463f
URLEncoded
Number=573001234567&MsgID=a2f5adbf76124fdcfc31f5acd6e9463f

Códigos de error

La siguiente es una lista de códigos de respuesta del recurso y la frase estándar asociadas a ese código, más la explicación de los errores específicos que puedan generarse.

Las frases estándares están destinadas a dar una descripción intutiva del estatus, y la explicación específica permitirá encontrar el error más fácilmente.

El código de respuesta es enviado en el encabezado, y la explicación en el cuerpo de la respuesta.

CódigoDescripción
400 Solicitud incorrecta. La solicitud contiene datos no válidos o faltantes.
destination no definido.
text no definido.
date_delivery o time_delivery no definido
date_delivery no válido
time_delivery no válido
destination no válido
401 No autorizado. Error de autenticación o no se proporciono la información de autenticación.
api_id no definido.
404 No encontrado. El URI no coincide con ninguno de los recursos disponibles, o, si solicita un recurso con un identificador, el recurso no existe.
No encontrado. El recurso no existe.
405 Método no permitido. El método de la petición HTTP que esta intentando utilizar no esta permitido. Verifique la documentación para ver los metodos permitidos.

Formato Respuesta de Error

  
  
JSON
{ "error": "No autorizado. Error de autenticación o no se proporcionó la información de autenticación" }
XML
<?xml version="1.0"?> <respuesta> <error>No autorizado. Error de autenticación o no se proporcionó la información de autenticación</error> </respuesta>
CSV
No autorizado. Error de autenticación o no se proporcionó la información de autenticación
URLEncoded
error=No encontrado. El URI no coincide con ninguno de los recursos disponibles, o, si solicita un recurso con un identificador, el recurso no existe -> No encontrado. El código buscado no existe

Información del recurso

Transferencia limitada No
Formato de la respuesta JSON/XML/CSV/URLencoded
Autenticación

Bearer Token Authentication

Basada en esta especificación OAuth 2