Send Status/Stories Text/Url
Instructions:
Swap the existing content between [ ] for whatever matches your scenario or need.
Method | Endpoint |
---|---|
POST | [baseUrl]/message/sendStatus/[instance] |
Send a text or url (clickable) Status/Stories to one, some or all contacts in your list.
Data to be sent in the Requestβ
{
"statusMessage": {
"type": "text",
"content": "Hi, how are you today? ππ\n\nSee more in\n\nhttps://evolution-api.com/",
"backgroundColor": "#008000",
"font": 1,
"allContacts": false,
"statusJidList": ["[remoteJid]@s.whatsapp.net"]
}
}
Data returned from the Requestβ
{
"key": {
"remoteJid": "status@broadcast",
"fromMe": true,
"id": "BAE59F76997142F0"
},
"message": {
"extendedTextMessage": {
"text": "Hi, how are you today? ππ\n\nSee more in\n\nhttps://evolution-api.com/",
"matchedText": "https://evolution-api.com/",
"canonicalUrl": "https://evolution-api.com/opensource-whatsapp-api/",
"title": "OpenSource WhatsApp API β Evolution API",
"backgroundArgb": 4278222848,
"font": "SERIF",
"previewType": "NONE",
"thumbnailDirectPath": "/o1/v/t62.7118-24/f1/m230/up-oil-image-bae65e3e-9813-4686-99a5-53ab5e2336c7?ccb=9-4&oh=01_AdRENApzu4pB-Y6VDbbGWfD6w91B1rmxgveUJH_cCmt0Hg&oe=64DCEF1B",
"thumbnailSha256": "QcKPDG2Bk+d3fPceiuS1cnGuBNgv/8hHM4UgcwYMtKk=",
"thumbnailEncSha256": "UpEq8UfeJuT2/0A2nS7vEEIUZzIi+SmOydvvWQthzAs=",
"mediaKey": "KXuIeKYSqsHVD8uxEoHnQPjXuADqTVCtfuI35zbmVxc=",
"mediaKeyTimestamp": "1689621677",
"thumbnailHeight": 0,
"thumbnailWidth": 0
}
},
"messageTimestamp": "1689621677",
"status": "PENDING",
"participant": "[sender]@s.whatsapp.net"
}
Explanation of Parametersβ
Parameter | Type | Description |
---|---|---|
statusMessage.type | Required | Inform text, to send text messages or clickable url's. |
statusMessage.content | Required | Inform the text of the message you want to send, being able to use the same resources you would use in the app or on the web, which are: - Emojis - Bold, enter *yourtext* - Italics, between _yourtext_ - Scratched, come in ~yourtext~ - Monospace between ```yourtext``` To break a line, enter "\n" in the message. Check the example in the payload for better understanding. |
statusMessage.backgroundColor | Required | Enter the color you want for the status/stories background, using the Hex Color Code. Examples: #FFFFFF = White #0000FF = Blue #008000 = Green #FFFF00 = Yellow #FF0000 = Red #800080 = Purple #808080 = Gray #FFC0CB = Pink |
statusMessage.font | Required | Choose the font type to be used. Accept the options below: 1 = SERIF 2 = NORICAN_REGULAR 3 = BRYNDAN_WRITE 4 = BEBASNEUE_REGULAR 5 = OSWALD_HEAVY |
statusMessage.allContacts | Required | To send to ALL contacts, type "true". Accepted values ββare "true" or "false". If "false" is informed, the "statusJidList" becomes required. |
statusMessage.statusJidList | Optional | Enter the remoteJid of one or more contacts you want to send status/stories. remoteJid = Number in DDI + DDD + Number format, with or without the @s.whatsapp.net ending. Ex: 5511911111111 or 5511911111111@s.whatsapp.net If you want to send it to more than one contact, just separate them with commas, as shown in the example below: 551191111111, 5511922222222, 5511933333333 |
Note:
Every message sent by the Evolution API initially has the status PENDING.
This indicates that the sending was successful and the message is waiting for the following statuses, which will be sent to the MESSAGES_UPDATE Webhook.
Warning:
It is extremely necessary that the payload obey the rules for creating a JSON file, considering the correct arrangement of items, formatting, square brackets, braces and commas, etc.
Before consuming the endpoint, if you have questions about the JSON formatting, go to https://jsonlint.com/ and validate.