Requests Info

Marsol API includes an endpoint for retrieving detailed information about specific requests made to the platform. This allows you to track and analyze the status and outcomes of your message requests, including details about recipients, message parts, and timestamps. This information is crucial for monitoring the performance and delivery of your communications.

get
Authorizations
x-auth-tokenstringRequired
Path parameters
requestIdstringRequired
Responses
200Success
application/json
get
/public/requests/{requestId}
GET /public/requests/{requestId} HTTP/1.1
Host: api.marsol.ly
x-auth-token: YOUR_API_KEY
Accept: */*
200Success
{
  "requestId": "text",
  "message": "text",
  "recipients": [
    {
      "phoneNumber": "text",
      "status": "text",
      "senderDevice": "text"
    }
  ],
  "parts": 1,
  "timestamp": "2025-12-06T02:55:42.084Z",
  "token": "text"
}

Endpoint: /public/requests/{requestId}

Method: GET

This endpoint is used to obtain information about a particular message request identified by requestId. It provides details such as the message content, recipients, and the status of each recipient.

Request Parameters

  • requestId (string, path parameter): The unique identifier of the message request you want to retrieve.

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

Security

This endpoint requires authentication. Include the x-auth-token in the request headers to authenticate your request.

Response

The response will include the following fields:

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

  • message (string): The content of the message that was sent.

  • recipients (array): A list of recipient objects, each containing:

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

    • status (string): The status of the message for this recipient.

    • senderDevice (string): The device from which the message was sent.

  • parts (integer): The number of message parts.

  • timestamp (string, date-time): The timestamp when the request was made.

  • token (string): A token associated with the request.

{
  "requestId": "string",
  "message": "string",
  "recipients": [
    {
      "phoneNumber": "string",
      "status": "string",
      "senderDevice": "string"
    }
  ],
  "parts": 0,
  "timestamp": "2024-08-08T12:13:21.879Z",
  "token": "string"
}
PreviousSendNextStatistics

Last updated