API Documentation
Notifier by WhatsAble API Documentation
API
๐ Notifier by WhatsAble API Documentation
Welcome to the Notifier by WhatsAble API Documentation! This guide provides comprehensive details on how to use the Notifier API to send WhatsApp messages programmatically. Below, youโll find information on the API endpoint, authentication, request and response structures, error handling, and supported attachment types.
๐ API Overview
The Notifier API allows you to send WhatsApp messages, including text and attachments, to customers. Itโs designed to be simple and easy to integrate into your applications or workflows.
๐ API Endpoint
- POST:
https://api.insightssystem.com/api:-GWQv5aM/send
๐ Authentication
To use the API, you need to include an Authorization Token in the request headers. The token must be prefixed with Bearer.
Headers
Content-Type
:application/json
Authorization
:Bearer YOUR_TOKEN_HERE
๐ค Request Payload
The request body should be a JSON object with the following fields:
Field | Type | Description |
---|---|---|
phone | String | The recipientโs phone number in international format (e.g., +1234567890 ). |
text | String | The message content you want to send. |
attachment | String | (Optional) A public URL to an attachment (e.g., image, PDF, video). |
filename | String | (Optional) The name of the attachment file. |
Example Request Body
๐ฅ Response Structure
The API responds with a JSON object. Below are examples of success and error responses.
Success Response
Error Response
๐ ๏ธ Error Handling
The API provides detailed error messages to help you troubleshoot issues. Common errors include:
- Invalid Phone Number: Ensure the phone number is in E.164 format.
- Message Limit Reached: Youโve exceeded the allowed number of messages for a specific phone number.
- Attachment Issues: Ensure the attachment URL is public and accessible.
- Authentication Failure: Verify that the
Authorization
token is correct. - Insufficient Credits: Your account balance is insufficient to send the message.
- Subscription Expired: Your subscription has ended, and you need to renew it.
- Rate Limit Exceeded: Youโve exceeded the allowed number of messages per minute or hour.
- Unique Number Limit Reached: Youโve reached the limit of unique phone numbers you can message.
- File Size or Type Error: The attachment does not meet WhatsAppโs size or type requirements.
- No WhatsApp Account: The recipient does not have an active WhatsApp account.
๐ Code Examples
1. cURL
2. JavaScript (Fetch API)
3. Python (Requests Library)
4. Go
5. Java (HttpURLConnection)
๐ Attachment Support
The Notifier API supports sending attachments with WhatsApp messages. Below are the supported file types and their size limits:
Supported Media Types
Media Type | File Extensions | MIME Types | Max Size |
---|---|---|---|
Images | .jpeg , .png | image/jpeg , image/png | 5 MB |
Videos | .mp4 , .3gp | video/mp4 , video/3gpp | 16 MB |
Documents | .pdf , .doc , .xls , .ppt , .txt | application/pdf , application/msword , application/vnd.ms-excel , application/vnd.ms-powerpoint , text/plain | 100 MB |
Audio | .mp3 , .aac , .m4a , .ogg | audio/mpeg , audio/aac , audio/mp4 , audio/ogg | 16 MB |
๐ Key Points to Remember
- Phone Number Format: Always use the E.164 format (e.g.,
+1234567890
). - Attachment URL: Ensure the attachment URL is public and accessible.
- Authorization Token: Include the
Bearer
token in theAuthorization
header. - Error Handling: Check the
message
field in the response for detailed error information. - Line Break: In the message for line break or for starting a new line,
\n
needs to be added before the new line. Example:
Input:
Hi there,\nThis is John from Acme Co.
Output: Hi there, This is John from Acme Co.
โ Need Help?
If you encounter any issues or need further assistance, feel free to reach out to our support team:
- Email Support: support@whatsable.app
- Documentation: Notifier API Documentation
๐ Start Sending WhatsApp Messages Today!
Disclaimer: This service is not affiliated with nor endorsed by WhatsApp Inc. The tool uses the WhatsApp API but is not affiliated with WhatsApp.