User Tools

Site Tools


Sidebar

apiv4:ping

Table of Contents

Ping

The YouMail API offers a ping request to confirm its availability for further requests. You may send this request only to ascertain the initial availability of the API. It is not necessary (and also discouraged) to send this before each API request to fetch or update content.

Request

Send a ping request to the API by sending a HEAD or GET request to the following URL. Unless you require the timestamp returned in the GET, it is recommended that you use a HEAD request to omit the response content.

https://api.youmail.com/api/ping

Response

When the API is available, you will always receive a 200 OK. When using GET, you will receive response content similar to:

XML

<?xml version="1.0" encoding="utf-8"?>
<response>
  <statusCode>200</statusCode>
  <shortMessage>successful</shortMessage>
  <longMessage>successful</longMessage>
  <timestamp>2015-07-07T12:00:00-07:00</timestamp>
</response>

JSON

{"statusCode":"200","shortMessage":"successful","longMessage":"successful","timestamp":"2015-07-07T12:00:00-07:00"} 
apiv4/ping.txt · Last modified: 2016/05/19 15:50 (external edit)

Page Tools