Read Task Info

Robeeta Cloud Read Task Info API Documentation

Retrieves comprehensive details about a specific task, including its status, associated metadata, and progress, using the provided API key and Task GUID. This functionality enables users to track the progress and status of their bulk SMS tasks effectively.

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

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.

Response Body:

Response: string - Outcome of the request.
StatusCode: integer - Numeric status code (200 indicates success).
TaskInfo: object - Detailed information about the task.

TaskName: string - Name of the task.
TaskDate: datetime - Date the task was created.
CompletedDate: datetime - Date the task was completed.
TaskResponse: string - Response associated with the task.
TaskStatus: string - Current status of the task.
TaskGuid: string - Unique identifier of the task.

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/ReadTaskInfo \
-H "Content-Type: application/json" \
-d '{
  "ApiKey": "string",
  "TaskGuid": "string"
}'

Sample Response:

{
  "Response": "OK",
  "StatusCode": 0,
  "TaskInfo": {
    "TaskName": "string",
    "TaskDate": "datetime",
    "CompletedDate": "datetime",
    "TaskResponse": "string",
    "TaskStatus": "string",
    "TaskGuid": "string"
  }
}

Robeeta Cloud Msg4 API Document

Read Task Info

Feedback