---
title: "Get iMessage sender status"
method: GET
path: "/v1/messaging/imessage/senders/{senderId}"
tags: ["iMessage"]
---

# Get iMessage sender status

`GET /v1/messaging/imessage/senders/{senderId}`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/imessage/senders/{senderId}`
- Auth: HTTP bearer

Lifecycle status of an ordered or registered sender (poll while an order activates), plus the provider's live platform health for it.

**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Path parameters

- `senderId` string, required

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `health` object, nullable: Provider platform health for this sender; null when the provider cannot report it.
      - `imessage` 'active' | 'degradation' | 'outage'
      - `whatsapp` 'active' | 'degradation' | 'outage'
    - `sender` object: A provisioned iMessage sender order and its lifecycle. Activation is asynchronous: poll GET /v1/imessage/senders/{senderId} or subscribe to account.connected.
      - `id` string
      - `kind` 'phone' | 'email'
      - `handle` string, nullable: The sender handle once activation assigns it
      - `region` 'US' | 'GB' | 'null', nullable
      - `status` 'ordering' | 'awaiting_payment' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed': `awaiting_payment`: the first-month charge is still being confirmed by the card; the number is ordered automatically once it is paid (usually under 5 minutes), or the order fails with `failureReason` when the card declines or nothing confirms within 30 minutes.
      - `provider` string
      - `accountId` string, nullable: The messaging account created at activation
      - `createdAt` string, date-time
      - `optInLink` string, nullable: imessage:// deep link that opens Messages on this sender with a prefilled text. Share it so contacts message you first (Apple only lets a sender reach contacts who wrote to it first); null until the handle is assigned.
      - `profileId` string
      - `priceCents` integer: Monthly price billed while the sender is active
      - `displayName` string, nullable
      - `failureReason` string, nullable
    - `success` boolean
    - `imessageLink` string, nullable: Provider-hosted opt-in page for this sender (opens Messages on any Apple device); null until the sender is active or when the provider cannot report it.
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)
