SMS Log

Get SMS Log

Endpoint to retrieve a single SMS Log by ID

post/sms-log/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the SMS Log to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "status": true,
    "errorCode": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "toNumber": {
      "_type": "Phone",
      "value": "+1-555-123-4567"
    },
    "fromNumber": {
      "_type": "Phone",
      "value": "+1-555-123-4567"
    },
    "smsText": "Alert: High CPU usage detected on your server. Please investigate immediately.",
    "statusMessage": "Message delivered successfully",
    "status": "Delivered",
    "errorCode": "30007",
    "smsCostInUSDCents": 42,
    "incidentId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "alertId": "123e4567-e89b-12d3-a456-426614174000",
    "monitorId": "123e4567-e89b-12d3-a456-426614174000",
    "scheduledMaintenanceId": "123e4567-e89b-12d3-a456-426614174000",
    "statusPageId": "123e4567-e89b-12d3-a456-426614174000",
    "statusPageAnnouncementId": "123e4567-e89b-12d3-a456-426614174000",
    "onCallDutyPolicyId": "123e4567-e89b-12d3-a456-426614174000",
    "onCallDutyPolicyEscalationRuleId": "123e4567-e89b-12d3-a456-426614174000",
    "onCallDutyPolicyScheduleId": "123e4567-e89b-12d3-a456-426614174000",
    "userOnCallLogTimelineId": "123e4567-e89b-12d3-a456-426614174000",
    "teamId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.