1. Inicio
  2. REST API Marketext
  3. sms/{api_id}/{user_id}/{message_id}
 

sms/{api_id}/{user_id}/{message_id}

Versión API v1.0

 

Permite obtener el estado de un SMS

URL del recurso

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

Parámetros

ParámetroDescripciónRequeridoValor Predeterminado
format Solicita el formato de respuesta ya sea JSON/XML/CSV/URLencoded Opcional

Ejemplo

GET http://restapi.marketext.com/sms/democompany/demouser/7385274faf4f435718dd4ffdf9d05dee

Solicitud 

  
	$client = new RESTClient();
	$client->setUrl("http://restapi.marketext.com/sms/democompany/demouser/7385274faf4f435718dd4ffdf9d05dee");
	$client->setMethod("GET");
	$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

  {
	"status": "8"
  }


XML

  <?xml version="1.0"?>
     <respuesta><status>8</status></respuesta>


CSV

  8


URLEncoded

  status=8

  Explicación de los códigos de respuesta
  

  
CódigoExplicación

  
0Enviado a la plataforma

  
1Entregado al destinatario

  
2Error al contactar el móvil

  
3Número de móvil no válido

  
4SMS Programado, en espera de ser enviado

  
5Número de móvil bloqueado para entregas

  
6Saldo insuficiente para envío de SMS

  
7Destino no incluido en cobertura

  
8Entregado al operador

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
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
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 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"
    }

  
XML

    <?xml version="1.0"?>
    <respuesta><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</error></respuesta>

  
CSV

    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

  
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
Autenticación None