Skip to main content

Check

The "Check" endpoint is used to perform a status check on an API service request. This endpoint requires bearer authentication, which means the client must provide a valid authentication token in the request headers to access this endpoint.

Request​

To use the "Check" endpoint, the client needs to make a POST request to Check.
The request body should include the following required parameter:

  • trackid: The unique identifier for the API request that needs to be checked.

Response​

When the "Check" endpoint is called with a valid trackid, 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.
  • data: An object containing details about the API request being checked, including the code, message, and trackid.
  • 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 using the "Check" endpoint, clients can retrieve the status and details of a previous API request, which is useful for monitoring the progress and success of their service integrations with the MPSMS platform.