---
title: "Get message status"
method: POST
path: "/message/status/{msg_id}/"
tags: ["Messages"]
---

# Get message status

`POST /message/status/{msg_id}/`

## Request

- Base URL: `https://wbiztool.com/api/v1`
- URL: `https://wbiztool.com/api/v1/message/status/{msg_id}/`
- Auth: none required

Current state of one message. Here `status` is the message's own status code (0 Created, 1 Sent, 2 Failed, 3 Cancelled, 4 Expired), not a success flag; an unknown ID also returns `0`, so check `message` first. A non-numeric ID returns an HTML 404 page, a non-POST request `{}`. Messages untouched for about 90 days are purged. The JSON body is served with `Content-Type: text/html`; parse it as JSON whatever the header says.

## Path parameters

- `msg_id` integer, required

## Request body

- Credentials: Your API credentials, sent in the request body (JSON or form fields) of every request that uses them. Both come from Settings → API keys in the dashboard. The API key decides which workspace the request acts on.
  - `client_id` integer, required: Your API Client ID from Settings → API keys.
  - `api_key` string, required: One of your API keys from the same page. Keep it secret.

## Response `200`

The message state, an unknown ID, or `Auth Error` (`{"message": "Auth Error", "status": 0}`; also for an invalid JSON body).

- union
  - MessageStatus
    - `status` 0 | 1 | 2 | 3 | 4, required: The message's own status: `0` Created (queued), `1` Sent, `2` Failed, `3` Cancelled, `4` Expired. Also `0` for an unknown ID; check `message`.
    - `status_text` 'Created' | 'Sent' | 'Failed' | 'Cancelled' | 'Expired' | 'pending', required: `pending` only with `Unknown message id`.
    - `message` string, required: Same as `status_text`, or `Unknown message id`.
    - `error` string, nullable, required: Why the message failed; empty or null otherwise.
  - ApiError: A failed request. `status` is `0` and `message` says why. (`Account Disabled` has no `status` field.)
    - `status` 0
    - `message` string, required

## Other responses

- `400`: Invalid API key.
- `403`: `client_id` is not a whole number.

---

[API](https://skmtc.dev/wbiztool/apis/wbiztool-api.md) · [All operations](https://skmtc.dev/wbiztool/apis/wbiztool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wbiztool/apis/wbiztool-api/revisions/bc7380bb5684?raw)