Message Controller

Post WhatsApp status (stories)

post/message/sendStatus/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/message/sendStatus/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Request body

type'text' | 'image' | 'audio' required

status type

contentstring required

status type

captionstring required

Optional for image or video

backgroundColorstring required

Exemple #008000

fontnumber required

1 = SERIF 2 = NORICAN_REGULAR 3 = BRYNDAN_WRITE 4 = BEBASNEUE_REGULAR 5 = OSWALD_HEAVY

allContactsboolean required

true to send to all contacts or false to send to statusJidList below

statusJidListstring[] required

Numbers to send status

Response

Created

messageTimestampstring

The timestamp of the message, represented as a string.

statusstring

The status of the message, such as sent, received, or pending.

participantstring

The participant in the chat to whom the message was sent.

Example response

{
  "key": {
    "remoteJid": "status@broadcast",
    "fromMe": true,
    "id": "BAE5FAB9E65A3DA8"
  },
  "message": {
    "extendedTextMessage": {
      "text": "example",
      "backgroundArgb": 4294910617,
      "font": "FB_SCRIPT"
    }
  },
  "messageTimestamp": "1717691767",
  "status": "PENDING",
  "participant": "553198296801:17@s.whatsapp.net"
}

Changes

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • warning

      removed the request property

    • breaking

      added the new required request property

    • breaking

      removed the success response with the status

    • info

      api operation id sendStatus was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Message Controller added

    • info

      api tag Send Message removed

    • info

      added the success response with the status