Status

This endpoint allows you to check the status of an OTP request (message) using its request Id.

get

Authorizations

x-auth-token

x-auth-tokenstringRequired

Path parameters

requestIdstringRequired

Responses

200Success

application/json

requestIdstringRead-onlyRequired

statusstringRead-onlyRequired

recipientstringRead-onlyRequired

failsnumberRead-onlyRequired

retriesnumberRead-onlyRequired

expiredbooleanRead-onlyRequired

get

/public/otp/status/{requestId}

HTTPcURLJavaScriptPython

GET /public/otp/status/{requestId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Accept: */*

200Success

{
  "requestId": "text",
  "status": "text",
  "recipient": "text",
  "fails": 1,
  "retries": 1,
  "expired": true
}

Endpoint: /public/otp/status/{requestId}

Method: GET

Retrieve the status of an OTP request.

Parameters:

• requestId (required, string): The unique identifier of the OTP request.

GET /public/otp/status/{requestId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: your_api_token_here
Content-Type: application/json

Response:

• requestId (string): The unique identifier of the OTP request.

• status (string): The status of the OTP request for the recipient.

• recipient (string): The phone number of the recipient.

• fails (number): The number of times an OTP request failed to be sent.

• retries (number): The number of times the OTP request was resent.

• expired (boolean): The OTP request expiration state.

{
  "requestId": "string",
  "status": "string",
  "recipient": "string",
  "fails": 0,
  "retries": 0,
  "expired": true
}