Skip to content

    Arabic or English · ↑↓ to move · Enter to open · Esc to close

    العربية
    On this page

    Messages

    Send a file (multipart)

    POST/v2/messages
    • Scope:messages:send
    • Idempotency-Key:required
    • number key ok— Also accepts the legacy per-number x-api-key, for its own number.
    • sends messages

    Same fields as JSON plus a file part. Bytes are sniffed; the name is never trusted.

    Parameters

    Headers

    NameTypeConstraintsDescription
    Idempotency-KeyrequiredTypestringConstraints≤ 191 charsDescriptionYour unique id for this operation (≤ 191 visible ASCII). A retry with the same key and body returns the first answer with Idempotent-Replayed: true — it never runs twice. Kept 24 h.
    X-Request-IdoptionalTypestringConstraints—DescriptionOptional: your own request id, echoed back (otherwise we generate req_…). Quote it to support.

    multipart/form-data fields

    NameTypeConstraintsDescription
    numberIdoptionalTypestringConstraints—DescriptionNumber to act on (id from GET /v2/numbers). A key restricted to some numbers can use only those.
    tooptionalTypestringConstraints—DescriptionRecipient: international digits without + or leading zeros (e.g. 201001234567, 966501234567).
    typeoptionalTypestringConstraints—DescriptionMessage type: text, image, video, audio, voice, document, sticker, location, contact, poll, event, buttons, list, cta_url. Each type has its own fields — see the table below.
    captionoptionalTypestringConstraints—DescriptionCaption under an image, video or document (≤ 1024).
    fileoptionalTypefileConstraints—DescriptionThe file bytes (multipart). The real type is sniffed from the bytes; the file name is never trusted.

    Request

    curl -X POST "https://mursilat.com/api/v2/messages" \
      -H "Authorization: Bearer $WASLA_API_KEY" \
      -H "Idempotency-Key: order-1042-confirm" \
      -F numberId="cm1abcd2345efgh6789ijkl" \
      -F to="201001234567" \
      -F type="document" \
      -F caption="فاتورتك" \
      -F file=@invoice-1042.pdf

    Response

    200Example

    200 — application/json
    {
      "id": "3EB0A1B2C3D4E5F60718",
      "numberId": "cm1abcd2345efgh6789ijkl",
      "status": "sent",
      "type": "document",
      "reference": "order-1042",
      "scheduledAt": null,
      "interactionId": null,
      "format": null,
      "fallbackIncluded": null,
      "estimatedDelayMs": null
    }

    Response schema

    Fields of the example answer. Expand objects and arrays.

    • responseobject10 fields
      • idstring "3EB0A1B2C3D4E5F60718"
      • numberIdstring "cm1abcd2345efgh6789ijkl"
      • statusstring "sent"
      • typestring "document"
      • referencestring "order-1042"
      • scheduledAtnull null
      • interactionIdnull null
      • formatnull null
      • fallbackIncludednull null
      • estimatedDelayMsnull null

    Errors

    Besides the authentication, rate-limit and validation errors every endpoint can return:

    Errors →

    Number Shield & behaviour

    Queued: when the number is busy or a short gap is due, the answer is still 200 with status: "queued" and estimatedDelayMs; the message leaves on its own and message.status follows.

    Paced / capped: messages to new contacts are spaced and capped by the warm-up stage — 429 SAFETY_PACING, SAFETY_HOURLY_CAP_REACHED or SAFETY_DAILY_CAP_REACHED with details.retryAt.

    Refused: opted-out recipients (422 SAFETY_SUPPRESSED), blocked content such as shorteners or links from young numbers (422 SAFETY_CONTENT_BLOCKED), a paused number (423 SAFETY_NUMBER_PAUSED; replies to people who wrote in the last 24 h still go out). Don’t retry these unchanged.

    Try it

    Send this request from your browser to the Mursilat API.

    documented example

    Preview — this copy of the docs isn’t on mursilat.com, so the console shows the documented example instead of calling the API.

    Real requests use your real number and plan: they can send WhatsApp messages, spend quota and delete data. (sends messages)

    Kept only in this tab’s memory: never saved, never put in the URL, sent only to mursilat.com. Reloading the page forgets it.

    multipart/form-data → curl

    Send this request for real?

    This will send a real WhatsApp message (or campaign / code) from your number and use your plan quota.

    POST /v2/messages