Skip to main content

Ping

The "Ping" endpoint is used to perform a connectivity and availability test to the MPSMS API service. This endpoint allows clients to check if the MPSMS API is reachable and responsive, which is crucial for ensuring the proper functioning of the client's application.

Request​

To use the "Ping" endpoint, the client needs to make a POST request to Ping

The request body requires name, which is the account name. mobile, email, and trackid are optional.

{
  "name": "Administration",
  "mobile": "233553554911",
  "email": "me@example.com",
  "trackid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Response​

When the "Ping" endpoint is called, the MPSMS API will respond with a JSON payload containing the following fields:

  • success: A boolean value indicating whether the request was successful or not.
  • code: An integer value representing the HTTP status code of the response.
  • message: A string message providing additional information about the response.
  • trackid: The unique identifier for the current request, which can be used for logging and troubleshooting purposes.
  • stamp: An integer timestamp representing the current time when the response was generated.

By examining the response from the "Ping" endpoint, clients can determine the overall health and availability of the MPSMS API, which is essential for ensuring the smooth operation of their applications that rely on the MPSMS services.