Read Bulk SMS List

Robeeta Cloud - Read Bulk SMS List API Documentation

Fetches a detailed list of bulk SMS records associated with a specific task, identified by the provided API key and task GUID. Optionally, you can filter the results by a specific mobile number to view relevant records. This functionality allows you to monitor and analyze the messages sent as part of the bulk SMS task.

POST https://api.msg4.cloud.robeeta.com/Sms/ReadBulkSmsList

Authorization: API Key

Header: Content-Type: application/json

Request Body:

ApiKey: string - (required) API key for authorization.
TaskGuid: string - (required) Unique identifier for the task.
MobileNumber: string - (optional) Mobile number to filter SMS records.

Response Body:

Response: string - Outcome of the request.
StatusCode: integer - Numeric status code (200 indicates success).
BulkSmsList: array - List of SMS details for the task.

MsgDate: datetime - Message creation date.
MsgId: integer - Unique message identifier.
MsgValue: decimal - Value associated with the message.
MsgCount: integer - Number of SMS segments sent.
PEID: string - Principal Entity ID.
SenderId: string - Sender ID used for the SMS.
CampaignName: string - Campaign name.
MsgText: string - Message text content.
RouteName: string - SMS route name.
SpTemplateId: string - Template ID.
MobileNumber: string - Recipient's mobile number.
MsgStatus: string - Status of the message.
DeliveryStatus: string - Delivery status of the SMS.
DeliveryTime: datetime - Time the message was delivered.

Status Codes and Descriptions: The table below provides a list of possible status codes returned by the API along with their corresponding response descriptions.

StatusCode	Response
200	OK
1704	Invalid ApiKey
1708	Invalid Task Guid
500	Unknown Error

Sample Request:

curl -X POST \
https://api.msg4.cloud.robeeta.com/Sms/ReadBulkSmsList \
-H "Content-Type: application/json" \
-d '{
  "ApiKey": "string",
  "TaskGuid": "string",
  "MobileNumber": "string"
}'

Sample Response:

{
  "Response": "string",
  "StatusCode": 0,
  "BulkSmsList": [
    {
      "MsgDate": "datetime",
      "MsgId": 0,
      "MsgValue": 0,
      "MsgCount": 0,
      "PEID": "string",
      "SenderId": "string",
      "CampaignName": "string",
      "MsgText": "string",
      "RouteName": "string",
      "SpTemplateId": "string",
      "MobileNumber": "string",
      "MsgStatus": "string",
      "DeliveryStatus": "string",
      "DeliveryTime": "datetime"
    }
  ]
}

Robeeta Cloud Msg4 API Document

Read Bulk SMS List

Feedback