{ "openapi": "3.1.0", "info": { "version": "v1.0", "title": "Hypersender WhatsApp API Docs", "description": "\nThe Hypersender WhatsApp API is a powerful api to send and recieve messages using your own whatsapp number.\nWithout the high costs of Meta's Whatsapp business API.\n\nIn this Docs you'll learn how to use and integrate Hypersnder Whatsapp API into your existing system/service or application using simple API endpoints.\n\n**What you can Do?**\n\n- Send Text and basic Url messages.\n- Send Media through Link or uploaded file.\n- Send Audio through Link or uploaded file.\n- Send Contact Card\n- Send Location\n- Send Poll votes\n\n**You can also**\n\n- React to a message\n- Forward messages to other chats\n- Acknowledge messages (mark as read)\n- Star and unstar messages\n\n\n
\n\n**Quick Demo**\n\n **Learn how to use Hypersender whatsapp API to send a message using Postman:**\n [Demo Link](https://app.hypersender.com/send-whatsapp-message-in-postman) **to easily interact with our API.**\n\n
\n\n**postman collection**\n\nYou can download our [Postman Collection](https://docs.hypersender.com/whatsapp-postman-collection.json) to easily interact with our API.\n\n## Servers (Endpoints)\n\n- Production (activated): [https://app.hypersender.com/api/whatsapp/v1](https://app.hypersender.com/api/whatsapp/v1)\n" }, "servers": [ { "url": "https://app.hypersender.com/api/whatsapp/v1", "description": "Production" } ], "paths": { "/{instance}/send-text-safe": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "text": "Hi there!", "reply_to": "string", "link_preview": false, "link_preview_high_quality": false } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "extendedTextMessage": { "type": "object", "properties": { "text": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0CD3810439716606547" }, "message": { "extendedTextMessage": { "text": "Hi there!" } }, "messageTimestamp": 1741359489, "status": "PENDING" } }, "Example 2": { "value": { "key": { "remoteJid": "111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0CD3810439716606547" }, "message": { "extendedTextMessage": { "text": "https://hypersender.com/", "matchedText": "https://hypersender.com/", "description": "Hypersender is a powerful API for sending Whatsapp and SMS messages. It is designed to be simple and easy to use, with a focus on security and reliability.", "title": "Hypersender: Whatsapp and SMS APIs", "previewType": "NONE", "thumbnailDirectPath": "/o1/v/t24/f2/m234/AQMWy7W9aoxZqxxRETDx1dXJz6jhTwuZvTV2e1Ep-lbVfAn2vblroFuisfPajGw-hsD2vrHbe4Tn2DuHrqdaytfg8QChweXGPnVMrtrbMg?ccb=9-4&oh=01_Q5Aa2gH8kJkHg-6ZdB18wKj5CqnLiEJ5qlItVfaPNNPIosO6fA&oe=68F1F7ED&_nc_sid=e6ed6c", "thumbnailSha256": "J22VHFlcIdrEtvvznaB6KFCsUenk1Zb+P6yQvdpKW0I=", "thumbnailEncSha256": "1zjk1SGXR7Afyn2WgnKa88EmxmSIbGK68hiACkQ4xL4=", "mediaKey": "Vt7QDa+t+Wt2fZUbqqUJ4IX9238kgkm1W+N6VVvlzMg=", "mediaKeyTimestamp": 1758103675 } }, "messageTimestamp": 1758103675, "status": "PENDING" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-text": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "text": "Hi there!", "reply_to": "string", "link_preview": false, "link_preview_high_quality": false } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "extendedTextMessage": { "type": "object", "properties": { "text": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0CD3810439716606547" }, "message": { "extendedTextMessage": { "text": "Hi there!" } }, "messageTimestamp": 1741359489, "status": "PENDING" } }, "Example 2": { "value": { "key": { "remoteJid": "111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0CD3810439716606547" }, "message": { "extendedTextMessage": { "text": "https://hypersender.com/", "matchedText": "https://hypersender.com/", "description": "Hypersender is a powerful API for sending Whatsapp and SMS messages. It is designed to be simple and easy to use, with a focus on security and reliability.", "title": "Hypersender: Whatsapp and SMS APIs", "previewType": "NONE", "thumbnailDirectPath": "/o1/v/t24/f2/m234/AQMWy7W9aoxZqxxRETDx1dXJz6jhTwuZvTV2e1Ep-lbVfAn2vblroFuisfPajGw-hsD2vrHbe4Tn2DuHrqdaytfg8QChweXGPnVMrtrbMg?ccb=9-4&oh=01_Q5Aa2gH8kJkHg-6ZdB18wKj5CqnLiEJ5qlItVfaPNNPIosO6fA&oe=68F1F7ED&_nc_sid=e6ed6c", "thumbnailSha256": "J22VHFlcIdrEtvvznaB6KFCsUenk1Zb+P6yQvdpKW0I=", "thumbnailEncSha256": "1zjk1SGXR7Afyn2WgnKa88EmxmSIbGK68hiACkQ4xL4=", "mediaKey": "Vt7QDa+t+Wt2fZUbqqUJ4IX9238kgkm1W+N6VVvlzMg=", "mediaKeyTimestamp": 1758103675 } }, "messageTimestamp": 1758103675, "status": "PENDING" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-link-custom-preview": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendLinkCustomPreview" }, "examples": { "Example 1": { "value": { "chatId": "1111111111@c.us", "text": "Check this out! https://hypersender.com/", "reply_to": "string", "high_quality": true, "preview_title": "Hypersender is awesome", "preview_description": "Check this out, this is a custom link preview!", "preview_url": "https://hypersender.com/", "preview_image_url": "https://m.media-amazon.com/images/M/MV5BMjRhYjdkOGMtZDY5Zi00OWEwLTlkOWEtYz.jpg" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "extendedTextMessage": { "type": "object", "properties": { "text": { "type": "string" }, "matchedText": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "previewType": { "type": "string" }, "jpegThumbnail": { "type": "string" }, "thumbnailDirectPath": { "type": "string" }, "thumbnailSha256": { "type": "string" }, "thumbnailEncSha256": { "type": "string" }, "mediaKey": { "type": "string" }, "mediaKeyTimestamp": { "type": "string" }, "thumbnailHeight": { "type": "number" }, "thumbnailWidth": { "type": "number" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "text": "https://hypersender.com\n\n Hypersender is Amazing!", "matchedText": "https://hypersender.com", "canonicalUrl": "https://hypersender.com", "description": "Hypersender is a powerful API for sending Whatsapp and SMS messages. It is designed to be simple and easy to use, with a focus on security and reliability.", "title": "Hypersender", "previewType": "NONE" } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB091A456D98511123FEA" }, "message": { "extendedTextMessage": { "text": "Check this out! https://hypersender.com/", "matchedText": "https://hypersender.com/", "description": "Check this out, this is a custom link preview!", "title": "Hypersender is awesome", "previewType": "NONE", "jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wAARCAARACADASIAAhEBAxEB/8QAGgAAAgIDAAAAAAAAAAAAAAAAAAUDBAECBv/EACwQAAECBQIEBAcAAAAAAAAAAAECAwAEBREhBjESEzVBYYGDsTI0UXJ0srP/xAAWAQEBAQAAAAAAAAAAAAAAAAABAAL/xAAXEQEBAQEAAAAAAAAAAAAAAAAAARIC/9oADAMBAAIRAxEAPwBi2HEqaUEXTY54hEEjVF1MOrTLqa5V0pJVnfe0Y1CX6fLS77E206gLIIbTw2NsE2ORviI9OzQmWVNKfQ282LhAbCisdzDehI3VU3kVBEutlTbjgt8YORkeREQ1GvKp86gusp5YBTw8YVfxt4WitW5GWS4h+cfcUt10qBKSjt9ADsIpT7NOm5d0tVdgu9kKSc22AO/naDRzDjUHRXPuT7wr0v8ANzH459xBBGSdDqFK9b+cclpjrvpPfoYIIoa//9k=", "thumbnailDirectPath": "/o1/v/t24/f2/m232/AQMNFP0XcTmGZckNL1WI6_-o4AAzaPTlTtqRat-YC7SlRrlpV8e_0fmUj7xBK5kS_9m4B-3wgG8wJ-aitI6TQqAXSTHEUhH5u4m1QCxRmw?ccb=9-4&oh=01_Q5Aa2gFW4du4I6OfD9Y_djyP1KIukQnFQRfu8YEfQJ6ydbY8JQ&oe=68F20A99&_nc_sid=e6ed6c", "thumbnailSha256": "KccP5I7AxrmcoUeD868qd0ISDFf6TYUTtw6dJS/Sdjk=", "thumbnailEncSha256": "Vveij+Avc8amAa2u6AtPSZG/07FzjJfDtMJqmYt/g4A=", "mediaKey": "Tp1eSebY/WJr+mZmzWmbRAj4WXyEmGsvSKZySAw9Kj8=", "mediaKeyTimestamp": 1758105918, "thumbnailHeight": 649, "thumbnailWidth": 1200 } }, "messageTimestamp": "1758105918,", "status": "PENDING" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-file": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "**Require to use `multipart/form-data`**", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendFileRequest" }, "examples": { "Example 1": { "value": { "chatId": "11111111111@c.us", "url": "https://hypersender.com/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Flogo.52c242e8.png&w=640&q=75", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } }, "Example 2": { "value": { "chatId": "11111111111@c.us", "file": "hypersender.jpeg", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "documentMessage": { "type": "object", "properties": { "url": { "type": "string" }, "mimetype": { "type": "string" }, "fileSha256": { "type": "string" }, "fileLength": { "type": "string" }, "mediaKey": { "type": "string" }, "fileName": { "type": "string" }, "fileEncSha256": { "type": "string" }, "directPath": { "type": "string" }, "mediaKeyTimestamp": { "type": "string" }, "caption": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "url": "https://mmg.whatsapp.net/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000&mms3=true", "mimetype": "image/png", "caption": "string", "fileSha256": "j/kM8e8A7qm5wi14X7dU5h0VUpbgAdxuAkuAZXqbv3Q=", "fileLength": "188795", "mediaKey": "r+N7EFTOq0IJGdGwKCZRS4/FMZYa4f0rLf3ASREmKSE=", "fileEncSha256": "475YUJVkMeFChIuWFaWlLbfKHo3OK8+HGgndhNFZHiQ=", "directPath": "/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000", "mediaKeyTimestamp": "1720448410" } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB089F063C03E43EECE9D" }, "message": { "documentMessage": { "url": "https://mmg.whatsapp.net/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0&mms3=true", "mimetype": "image/jpeg", "fileSha256": "ubfaNZ4rY7T7/ghhWnBh1cVf1d00JSHENKunZuHs+yc=", "fileLength": 7200, "mediaKey": "ARUCxn91XDCjmCvFecREY4Fpg9RSOYa8O5D7TxGWGkE=", "fileName": "hypersender.jpeg", "fileEncSha256": "ER9FB+GEzrKmooWDbNpqenokG1mAtvbIU+Ceo7JeNwQ=", "directPath": "/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0", "mediaKeyTimestamp": 1741390160, "caption": "dolore nulla nisi Duis" } }, "messageTimestamp": 1741390160, "status": "PENDING" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-image": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "**Require to use `multipart/form-data`**", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendImageRequest" }, "examples": { "Example 1": { "value": { "chatId": "11111111111@c.us", "url": "https://hypersender.com/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Flogo.52c242e8.png&w=640&q=75", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } }, "Example 2": { "value": { "chatId": "11111111111@c.us", "file": "hypersender.jpeg", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "imageMessage": { "type": "object", "properties": { "url": { "type": "string" }, "mimetype": { "type": "string" }, "fileSha256": { "type": "string" }, "fileLength": { "type": "string" }, "height": { "type": "number" }, "width": { "type": "number" }, "mediaKey": { "type": "string" }, "fileName": { "type": "string" }, "fileEncSha256": { "type": "string" }, "directPath": { "type": "string" }, "mediaKeyTimestamp": { "type": "string" }, "caption": { "type": "string" }, "jpegThumbnail": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "url": "https://mmg.whatsapp.net/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000&mms3=true", "mimetype": "image/png", "caption": "string", "fileSha256": "j/kM8e8A7qm5wi14X7dU5h0VUpbgAdxuAkuAZXqbv3Q=", "fileLength": "188795", "mediaKey": "r+N7EFTOq0IJGdGwKCZRS4/FMZYa4f0rLf3ASREmKSE=", "fileEncSha256": "475YUJVkMeFChIuWFaWlLbfKHo3OK8+HGgndhNFZHiQ=", "directPath": "/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000", "mediaKeyTimestamp": "1720448410" } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB089F063C03E43EECE9D" }, "message": { "imageMessage": { "url": "https://mmg.whatsapp.net/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0&mms3=true", "mimetype": "image/jpeg", "fileSha256": "ubfaNZ4rY7T7/ghhWnBh1cVf1d00JSHENKunZuHs+yc=", "fileLength": 7200, "height": 200, "width": 200, "mediaKey": "ARUCxn91XDCjmCvFecREY4Fpg9RSOYa8O5D7TxGWGkE=", "fileName": "hypersender.jpeg", "fileEncSha256": "ER9FB+GEzrKmooWDbNpqenokG1mAtvbIU+Ceo7JeNwQ=", "directPath": "/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0", "mediaKeyTimestamp": 1741390160, "caption": "dolore nulla nisi Duis", "jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wAARCAAgACADASIAAhEBAxEB/8QAGAABAQADAAAAAAAAAAAAAAAABQIDBAb/xAAqEAACAQQBAgUDBQAAAAAAAAABAgMABAURIRMxEiJRYXEUkbEVMkGhwf/EABcBAQEBAQAAAAAAAAAAAAAAAAACAQT/xAAdEQACAQUBAQAAAAAAAAAAAAAAAQIREiEiMwNB/9oADAMBAAIRAxEAPwDrctlBZDpRaaYjfPZRRSWGSyA6srEKeR1G19hVY2MZDMSTS+ZVJfR+dCmbm++nvoIG8AjkBLMx1rVDi67TePgHJZZHGjqox8I7mNtgfIpbE5QXo6UoCzKN8dmHrWW2vfqb6eBfA0caghlO97oS9T9NzAaLhQQ4Hse4/NDOVJQeDZw0b2+YuISvAUgn23xSF7Ym6yFvI6K8KKwcN/VXfWsrhpbNxFORonX7h6e1DrkslY+S4jLa/mRf9FCnb5KySwK2dibXIXEiIqQuoCBT96Gv3GRzKpF5l2EBHoO5/NVJf5HIjpRRkK3BEYPPyaUxOLFkOrKQ0zDXHZR6UJ60hBan/9k=" } }, "messageTimestamp": 1741390160, "status": "PENDING" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-video": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "**Require to use `multipart/form-data`**", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVideoRequest" }, "examples": { "Example 1": { "value": { "chatId": "11111111111@c.us", "url": "https://hypersender.com/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Flogo.52c242e8.png&w=640&q=75", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } }, "Example 2": { "value": { "chatId": "11111111111@c.us", "file": "hypersender.jpeg", "fileName": "hypersender_logo", "mimetype": "image", "caption": "string", "reply_to": "string" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "imageMessage": { "type": "object", "properties": { "url": { "type": "string" }, "mimetype": { "type": "string" }, "fileSha256": { "type": "string" }, "fileLength": { "type": "string" }, "height": { "type": "number" }, "width": { "type": "number" }, "mediaKey": { "type": "string" }, "fileName": { "type": "string" }, "fileEncSha256": { "type": "string" }, "directPath": { "type": "string" }, "mediaKeyTimestamp": { "type": "string" }, "caption": { "type": "string" }, "jpegThumbnail": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "url": "https://mmg.whatsapp.net/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000&mms3=true", "mimetype": "image/png", "caption": "string", "fileSha256": "j/kM8e8A7qm5wi14X7dU5h0VUpbgAdxuAkuAZXqbv3Q=", "fileLength": "188795", "mediaKey": "r+N7EFTOq0IJGdGwKCZRS4/FMZYa4f0rLf3ASREmKSE=", "fileEncSha256": "475YUJVkMeFChIuWFaWlLbfKHo3OK8+HGgndhNFZHiQ=", "directPath": "/o1/v/t62.7118-24/f1/m238/up-oil-image-4c847830-2a69-4ebd-ac45-f62c9a771a44?ccb=9-4&oh=01_Q5AaICe6iWwOjPuliG4zVq6gNXeUnijoMR_91jKzhLqNUlIB&oe=66B351C8&_nc_sid=000000", "mediaKeyTimestamp": "1720448410" } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB089F063C03E43EECE9D" }, "message": { "imageMessage": { "url": "https://mmg.whatsapp.net/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0&mms3=true", "mimetype": "image/jpeg", "fileSha256": "ubfaNZ4rY7T7/ghhWnBh1cVf1d00JSHENKunZuHs+yc=", "fileLength": 7200, "height": 200, "width": 200, "mediaKey": "ARUCxn91XDCjmCvFecREY4Fpg9RSOYa8O5D7TxGWGkE=", "fileName": "hypersender.jpeg", "fileEncSha256": "ER9FB+GEzrKmooWDbNpqenokG1mAtvbIU+Ceo7JeNwQ=", "directPath": "/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0", "mediaKeyTimestamp": 1741390160, "caption": "dolore nulla nisi Duis", "jpegThumbnail": "/9j/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wAARCAAgACADASIAAhEBAxEB/8QAGAABAQADAAAAAAAAAAAAAAAABQIDBAb/xAAqEAACAQQBAgUDBQAAAAAAAAABAgMABAURIRMxEiJRYXEUkbEVMkGhwf/EABcBAQEBAQAAAAAAAAAAAAAAAAACAQT/xAAdEQACAQUBAQAAAAAAAAAAAAAAAQIREiEiMwNB/9oADAMBAAIRAxEAPwDrctlBZDpRaaYjfPZRRSWGSyA6srEKeR1G19hVY2MZDMSTS+ZVJfR+dCmbm++nvoIG8AjkBLMx1rVDi67TePgHJZZHGjqox8I7mNtgfIpbE5QXo6UoCzKN8dmHrWW2vfqb6eBfA0caghlO97oS9T9NzAaLhQQ4Hse4/NDOVJQeDZw0b2+YuISvAUgn23xSF7Ym6yFvI6K8KKwcN/VXfWsrhpbNxFORonX7h6e1DrkslY+S4jLa/mRf9FCnb5KySwK2dibXIXEiIqQuoCBT96Gv3GRzKpF5l2EBHoO5/NVJf5HIjpRRkK3BEYPPyaUxOLFkOrKQ0zDXHZR6UJ60hBan/9k=" } }, "messageTimestamp": 1741390160, "status": "PENDING" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-voice": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "**Require to use `multipart/form-data`**", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVoiceRequest" }, "examples": { "Example 1": { "value": { "chatId": "1111111111111@c.us", "url": "http://commondatastorage.googleapis.com/codeskulptor-assets/week7-brrring.m4a", "caption": "hypersender", "reply_to": "string" } }, "Example 2": { "value": { "chatId": "1111111111111@c.us", "file": "audio.opus", "caption": "hypersender", "reply_to": "string" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "audioMessage": { "type": "object", "properties": { "url": { "type": "string" }, "mimetype": { "type": "string" }, "fileSha256": { "type": "string" }, "fileLength": { "type": "string" }, "seconds": { "type": "number" }, "ptt": { "type": "boolean" }, "mediaKey": { "type": "string" }, "fileEncSha256": { "type": "string" }, "directPath": { "type": "string" }, "mediaKeyTimestamp": { "type": "string" }, "waveform": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "url": "https://mmg.whatsapp.net/v/t62.7114-24/40934750_1123141612096506_5059779010427990564_n.enc?ccb=11-4&oh=01_Q5AaINJ58zcO7DTlO7DrMAaXKZ3pCWbLWSaQVUM0L3P8JGPa&oe=66B366E1&_nc_sid=5e03e0&mms3=true", "mimetype": "audio/ogg; codecs=opus", "fileSha256": "Y28LhNra+eEfRNKwIefqY+UU2Uf0ia4l8PrdScvlXcA=", "fileLength": "139027", "seconds": 5, "ptt": true, "mediaKey": "Chqmzo6fWYc++4A2SgwlzgNZ/3KNKjm3ceaVPSZyNVY=", "fileEncSha256": "DCsffr+JWSnJz+F1cf+uGxY/N0eXmqZxVwKvc2otd40=", "directPath": "/v/t62.7114-24/40934750_1123141612096506_5059779010427990564_n.enc?ccb=11-4&oh=01_Q5AaINJ58zcO7DTlO7DrMAaXKZ3pCWbLWSaQVUM0L3P8JGPa&oe=66B366E1&_nc_sid=5e03e0", "mediaKeyTimestamp": "1720449163" } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB089F063C03E43EECE9D" }, "message": { "audioMessage": { "url": "https://mmg.whatsapp.net/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0&mms3=true", "mimetype": "audio/ogg", "fileSha256": "ubfaNZ4rY7T7/ghhWnBh1cVf1d00JSHENKunZuHs+yc=", "fileLength": 18886, "seconds": 10, "ptt": true, "mediaKey": "ARUCxn91XDCjmCvFecREY4Fpg9RSOYa8O5D7TxGWGkE=", "fileEncSha256": "ER9FB+GEzrKmooWDbNpqenokG1mAtvbIU+Ceo7JeNwQ=", "directPath": "/v/t62.7119-24/31809967_2958746007616712_3774955636954933761_n.enc?ccb=11-4&oh=01_Q5AaIPHnpFjuJwCULeqyHMcDO55BAj3YxolxEVLGXVvVkaKM&oe=67F2DD3D&_nc_sid=5e03e0", "mediaKeyTimestamp": 1741390160, "waveform": "AAIIAQ0nKCcdX2NTSkUqHQ4KAgICBAUGAwEAAAAAAAAAAAQFARAmMlFQVT4PHkggAgEHGVldZFpGMBYKAwQEBg==" } }, "messageTimestamp": 1741390160, "status": "PENDING" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ], "operationId": "send-link-audio" } }, "/{instance}/forward-message": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardMessageRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "messageId": "false_111111111111@c.us_3EB08F6AD2A432386EFA0E" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "timestamp": { "type": "number" }, "from": { "type": "string" }, "fromMe": { "type": "boolean" }, "body": { "type": "string" }, "hasMedia": { "type": "boolean" }, "media": { "type": "object" }, "ack": { "type": "number" }, "ackName": { "type": "string" }, "replyTo": { "type": "string" }, "_data": { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "extendedTextMessage": { "type": "object", "properties": { "text": { "type": "string" }, "contextInfo": { "type": "object", "properties": { "forwardingScore": { "type": "number" }, "isForwarded": { "type": "boolean" } } } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } }, "examples": { "Example 1": { "value": { "id": "true_111111111111@c.us_3EB0579E140521570D238F,", "timestamp": "1741395597,", "from": "111111111111@c.us,", "fromMe": "true,", "body": "Hi there!,", "hasMedia": "false,", "media": "null,", "ack": "0,", "ackName": "PENDING,", "replyTo": "null,", "_data": { "key": { "remoteJid": "111111111111@s.whatsapp.net,", "fromMe": "true,", "id": "3EB0579E140521570D238F" }, "message": { "extendedTextMessage": { "text": "Hi there!,", "contextInfo": { "forwardingScore": "1,", "isForwarded": true } } }, "messageTimestamp": "1741395597,", "status": "PENDING" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-seen": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSeenRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "messageId": "false_111111111111@c.us_3EB08F6AD2A432386EFA0E", "participant": "111111111111@c.us" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object" } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/read-chat": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } }, { "name": "messages", "in": "query", "description": "How much messages to read (latest first)", "required": false, "schema": { "type": "string", "example": "30" }, "examples": { "default": { "value": "30" } } }, { "name": "days", "in": "query", "description": "How much days to read (latest first)", "required": false, "schema": { "type": "string", "example": "7" }, "examples": { "default": { "value": "7" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadChatRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Example 1": { "value": { "ids": ["false_11111111111@c.us_AAAAAAAAAAAAAAAAAAAA", "true_99999999999@c.us_AAAAAAAAAAAAAAAAAAAA"] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/start-typing": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTypingRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "result": { "type": "boolean" } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/stop-typing": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopTypingRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "result": { "type": "boolean" } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-poll": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPollRequest" }, "examples": { "Example 1": { "value": { "chatId": "1111111111111@c.us", "reply_to": "string", "poll": { "name": "How are you?", "options": ["Awesome!", "Good!", "Not bad!"], "multipleAnswers": true } } }, "Example 2": { "value": { "chatId": "1111111111111@c.us", "reply_to": "string", "poll": { "name": "How are you?", "options": ["Awesome!", "Good!", "Not bad!"], "multipleAnswers": false } } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "timestamp": { "type": "number" }, "from": { "type": "string" }, "fromMe": { "type": "boolean" }, "body": { "type": "string" }, "hasMedia": { "type": "boolean" }, "media": { "type": "object" }, "ack": { "type": "number" }, "ackName": { "type": "string" }, "replyTo": { "type": "string" }, "_data": { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "messageContextInfo": { "type": "object", "properties": { "messageSecret": { "type": "string" } } }, "pollCreationMessageV3": { "type": "object", "properties": { "name": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "optionName": { "type": "string" } } } }, "selectableOptionsCount": { "type": "number" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } } } ] }, "examples": { "Example 1": { "value": { "id": "true_11111111111@c.us_3EB0A4F993D38D3BBD04F3", "timestamp": 1741448369, "from": "11111111111@c.us", "fromMe": true, "body": null, "hasMedia": false, "media": null, "ack": 0, "ackName": "PENDING", "replyTo": null, "_data": { "key": { "remoteJid": "11111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0A4F993D38D3BBD04F3" }, "message": { "messageContextInfo": { "messageSecret": "VrTaj/wh+/lyIUdBi8TV4JCpbNK1Dd54SNZHH8vR2x0=" }, "pollCreationMessageV3": { "name": "Sample Poll", "options": [ { "optionName": "Option 1" }, { "optionName": "Option 2" }, { "optionName": "Option 3" } ], "selectableOptionsCount": 1 } }, "messageTimestamp": 1741448369, "status": "PENDING" } } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-contact-card": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendContactCardRequest" }, "examples": { "Example 1": { "value": { "chatId": "1111111111111@c.us", "contacts": [ { "vcard": "BEGIN:VCARD\\nVERSION:3.0\\nFN:Jane Doe\\nORG:Company Name;\\nTEL;type=CELL;type=VOICE;waid=911111111111:+11111111111111\\nEND:VCARD", "organization": "Hypersender", "whatsappId": 911111111111 } ] } }, "Example 2": { "value": { "chatId": "1111111111111@c.us", "contacts": [ { "vcard": null, "fullName": "John Doe", "organization": "Hypersender", "phoneNumber": 111111111111, "whatsappId": 911111111111 } ] } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/send-location": { "post": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendLocationRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "latitude": 38.8937255, "longitude": -77.0969763, "title": "Our office", "reply_to": "string" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "locationMessage": { "type": "object", "properties": { "degreesLatitude": { "type": "number" }, "degreesLongitude": { "type": "number" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "111111111@s.whatsapp.net,", "fromMe": "true,", "id": "3EB0CD3810439716606547" }, "message": { "locationMessage": { "degreesLatitude": 38.8937255, "degreesLongitude": -77.0969763 } }, "messageTimestamp": 1741359489, "status": "PENDING" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/react-to-message": { "put": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "deprecated": false, "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReactToMessageRequest" }, "examples": { "Example 1": { "value": { "messageId": "false_111111111111@c.us_3EB08F6AD2A432386EFA0E", "reaction": "👍" } }, "Example 2": { "value": { "messageId": "false_111111111111@c.us_3EB08F6AD2A432386EFA0E", "reaction": "" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "reactionMessage": { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "text": { "type": "string" }, "senderTimestampMs": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } } ] }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": true, "id": "3EB089F063C03E43EECE9D" }, "message": { "reactionMessage": { "key": { "remoteJid": "1111111111@s.whatsapp.net", "fromMe": false, "id": "3EB08F6AD2A432386EFA0E" }, "text": "👍", "senderTimestampMs": 1741410470848 } }, "messageTimestamp": 1741390160, "status": "PENDING" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/star-message": { "put": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StarMessageRequest" }, "examples": { "Example 1": { "value": { "chatId": "111111111111@c.us", "messageId": "true_111111111111@c.us_3EB08F6AD2A432386EFA0E", "star": true } }, "Example 2": { "value": { "chatId": "111111111111@c.us", "messageId": "true_111111111111@c.us_3EB08F6AD2A432386EFA0E", "star": false } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "type": "object" } ], "x-examples": { "Example 1": { "content": { "text": "Hi", "contextInfo": [] } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } }, "/{instance}/delete-message": { "delete": { "x-hidden": true, "tags": ["Send Messages"], "parameters": [ { "name": "Accept", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "Content-Type", "in": "header", "description": "application/json", "schema": { "type": "string", "example": "application/json" }, "examples": { "default": { "value": "application/json" } } }, { "name": "instance", "in": "path", "description": "Instance UUID copied from hypersender dashboard", "required": true, "schema": { "type": "string", "example": "{{ instance_id }}" }, "examples": { "default": { "value": "{{ instance_id }}" } } }, { "name": "chatId", "in": "query", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "required": true, "schema": { "type": "string", "example": "111111111111@c.us" }, "examples": { "default": { "value": "111111111111@c.us" } } }, { "name": "messageId", "in": "query", "description": "ID of the message to delete", "required": true, "schema": { "type": "string" }, "examples": { "default": { "value": "true_111111111111@c.us_3EB05B8C1E4" } } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "message": { "type": "object", "properties": { "protocolMessage": { "type": "object", "properties": { "key": { "type": "object", "properties": { "remoteJid": { "type": "string" }, "fromMe": { "type": "boolean" }, "id": { "type": "string" } } }, "type": { "type": "string" } } } } }, "messageTimestamp": { "type": "string" }, "status": { "type": "string" } } }, "examples": { "Example 1": { "value": { "key": { "remoteJid": "111111111111@s.whatsapp.net", "fromMe": true, "id": "3EB0E474C76F33528463B1" }, "message": { "protocolMessage": { "key": { "remoteJid": "111111111111@s.whatsapp.net", "fromMe": true, "id": "3EB05B8C1E491431AEAA9A" }, "type": "REVOKE" } }, "messageTimestamp": "1749413855", "status": "PENDING" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" }, "examples": { "Multiple fields Error": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 } }, "Single Field error ": { "value": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerError" }, "examples": { "default": { "value": { "message": "Server Error" } }, "Example 1": { "value": { "message": "Server Error" } } } } } } }, "security": [ { "Authorization": [] } ] } } }, "components": { "parameters": { "instance": { "name": "instance", "in": "path", "description": "Hypersender instance UUID", "required": true, "schema": { "type": "string" }, "example": "{{ instance_id }}" } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer" } }, "schemas": { "SendMessageRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "text": { "type": "string", "description": "Text Message\r\n" }, "reply_to": { "type": "string", "description": "Reply to message id\r\n" }, "link_preview": { "type": "boolean", "description": "Link Preview\r\n" }, "link_preview_high_quality": { "type": "boolean", "description": "Link Preview High Quality\r\n" } }, "required": ["chatId", "text"] }, "SendLinkCustomPreview": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "text": { "type": "string", "description": "text should contain the url to send" }, "reply_to": { "type": "string", "description": "reply to message id" }, "high_quality": { "type": "boolean", "description": "high quality for the image" }, "preview_title": { "type": "string", "description": "title of the link preview" }, "preview_description": { "type": "string", "description": "description of the link preview" }, "preview_url": { "type": "string", "description": "must be a valid URL" }, "preview_image_url": { "type": "string", "description": "URL of the image to be used in the link preview - (only if preview_image_file is not provided)" }, "preview_image_file": { "type": "string", "description": "file of the image to be used in the link preview - (only if preview_image_url is not provided)" } }, "required": ["chatId", "text", "preview_title", "preview_description", "preview_url", "preview_image_url", "preview_image_file"] }, "SendFileRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "url": { "type": "string", "description": "url to send (required without file)" }, "file": { "type": "string", "description": "file to send (required without url)" }, "filename": { "type": "string", "description": "filename for the file" }, "mimetype": { "type": "string", "description": "mimetype for the file" }, "caption": { "type": "string", "description": "caption for the file" }, "reply_to": { "type": "string", "description": "reply to message id" } }, "required": ["chatId"] }, "SendImageRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "url": { "type": "string", "description": "url to send (required without file)" }, "file": { "type": "string", "description": "file to send (required without url)" }, "filename": { "type": "string", "description": "filename for the file" }, "mimetype": { "type": "string", "description": "mimetype for the file" }, "caption": { "type": "string", "description": "caption for the file" }, "reply_to": { "type": "string", "description": "reply to message id" } }, "required": ["chatId"] }, "SendVideoRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "url": { "type": "string", "description": "url to send (required without file)" }, "file": { "type": "string", "description": "file to send (required without url)" }, "filename": { "type": "string", "description": "filename for the file" }, "mimetype": { "type": "string", "description": "mimetype for the file" }, "caption": { "type": "string", "description": "caption for the file" }, "reply_to": { "type": "string", "description": "reply to message id" } }, "required": ["chatId"] }, "SendVoiceRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - see chatId docs", "example": "111111111111@c.us" }, "url": { "type": "string", "description": "url to send (required without file)" }, "file": { "type": "string", "description": "file to send (required without url)" }, "caption": { "type": "string", "description": "caption for the file" }, "reply_to": { "type": "string", "description": "reply to message id" } }, "required": ["chatId"] }, "ForwardMessageRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number", "example": "111111111111@c.us" }, "messageId": { "type": "string", "description": "Message ID to forward" } }, "required": ["chatId", "messageId"] }, "SendSeenRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" }, "messageId": { "type": "string" }, "participant": { "type": "string", "description": "Participant JID for group messages" } }, "required": ["chatId", "messageId"] }, "ReadChatRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" } }, "required": ["chatId"] }, "ReactToMessageRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" }, "messageId": { "type": "string", "description": "Message ID" }, "reaction": { "type": "string", "description": "Reaction to add" } }, "required": ["chatId"] }, "StartTypingRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" } }, "required": ["chatId"] }, "StopTypingRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" } }, "required": ["chatId"] }, "SendPollRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "1111111111111@c.us" }, "reply_to": { "type": "string" }, "poll": { "type": "object", "properties": { "name": { "type": "string" }, "options": { "type": "array", "items": { "type": "string" } }, "multipleAnswers": { "type": "boolean" } } } }, "required": ["chatId", "poll"] }, "SendContactCardRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "1111111111111@c.us" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "vcard": { "type": "string" }, "fullName": { "type": "string" }, "organization": { "type": "string" }, "phoneNumber": { "type": "string" }, "whatsappId": { "type": "string" } } } } }, "required": ["chatId", "contacts"] }, "SendLocationRequest": { "type": "object", "properties": { "chatId": { "type": "string", "example": "111111111111@c.us" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "title": { "type": "string" }, "reply_to": { "type": "string" } }, "required": ["chatId", "latitude", "longitude"] }, "SendLinkPreview": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "url": { "type": "string", "description": "url to send\r\n" }, "title": { "type": "string", "description": "title for the message (Optional)\r\n" } }, "required": ["chatId", "url"] }, "StarMessageRequest": { "type": "object", "properties": { "chatId": { "type": "string", "description": "Contact number - **learn what is [`chatId`](https://docs.hypersender.com/docs/whatsapp/what-is-chatid)**", "example": "111111111111@c.us" }, "messageId": { "type": "string" }, "star": { "type": "boolean", "description": "star or unstar a message" } }, "required": ["messageId", "star"] }, "NotFoundError": { "type": "object", "title": "NotFoundError", "example": { "message": "Resource not found." }, "properties": { "message": { "type": "string" } }, "x-examples": { "Example 1": { "message": "Resource not found." } }, "x-stoplight": { "id": "ar3vz55asbxme" } }, "ValidationError": { "type": "object", "title": "ValidationError", "properties": { "message": { "type": "string" }, "errors": { "type": "object", "description": "Invalid or missing feilds will be shown here" }, "statusCode": { "type": "number" } }, "example": { "message": "The given data was invalid.", "errors": {}, "statusCode": 422 }, "required": ["errors", "statusCode"], "x-examples": { "Multiple fields Error": { "message": "The given data was invalid.", "errors": { "messages": ["The number you want to send the message to is not on whatsapp."], "jid": "20121323124131@s.whatsapp.net", "exists": false }, "statusCode": 422 }, "Single Field error ": { "message": "The given data was invalid.", "errors": { "messages": ["textMessage.text should not be empty"] }, "statusCode": 422 } }, "x-stoplight": { "id": "90x3wfxw7gqcb" } }, "ServerError": { "type": "object", "title": "ServerError", "properties": { "message": { "type": "string" } }, "example": { "message": "Internal Server Error" }, "x-stoplight": { "id": "2fhq2gihsfreh" } } } }, "security": [ { "Authorization": [] } ], "x-internal": false }