Introduction Last updated: 3 days ago
Ngumzo's WhatsApp API
Ngumzo's WhatsApp API provides businesses and developers with a seamless solution to connect with their customers through fast and reliable messaging. Designed for scalability and ease of integration, Ngumzo empowers you to send messages, engage customers, and automate communications—all at an affordable cost.
Why Choose Ngumzo WhatsApp API?
- Rapid Message Delivery: Ensure your messages reach customers instantly.
- Affordable Pricing: Tailored to fit the budget of businesses and developers.
- Simple Integration: Easily integrate the API into your applications or systems.
- User-Friendly Setup: Get started quickly with an intuitive onboarding process.
Getting Started with Ngumzo WhatsApp API
Follow these simple steps to begin using Ngumzo's WhatsApp API:
- Create an Account: Sign up on Ngumzo's platform Here to get started.
- Obtain API Credentials: After registering, retrieve your API Key under user profile.
- Integrate the API: Follow the integration guide to seamlessly add Ngumzo's WhatsApp API to your preferred application or system.
Key Features
- Instant Delivery: Messages are sent and delivered promptly to recipients.
- Competitive Pricing: Affordable rates make your messaging cost-effective.
- Scalable Solution: Easily handle both small and large message volumes.
- Reliable Support: Access comprehensive documentation and support whenever needed.
Ngumzo makes it easy for businesses to harness the power of WhatsApp for their communication needs, offering a platform that's reliable, scalable, and budget-friendly.
Sending Text Message
This Ngumzo API Endpoint allows you to send plain text messages directly to a WhatsApp number.
Endpoint:
POST : https://ngumzo.com/v1/send-message
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your Api Key |
Body Request( JSON )
-
sender (string):
The sender's phone number. -
recipient (string):
The recipient's phone number -
message (string):
The text message to send
Sample Body Request (JSON):
Sample API Call Code
Sample Curl Code
Sending Media Message
This Ngumzo API Endpoint allows you to send Media messages directly to a WhatsApp number.
Endpoint:
POST : https://ngumzo.com/v1/send-message
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your Api Key |
Body Request( JSON )
-
sender (string):
The sender's phone number. -
recipient (string):
The recipient's phone number -
message (string):
The text message to send -
media_type(string):
The Media Type e.g image,document(for any document format e.g pdf,word,excell e.t.c),video,audio -
caption (string):
The media caption -
url (string):
The media url
Sample Body Request (JSON):
Sample API Call Code
Sample Curl Code
Check Whatsapp Number
This Ngumzo API Endpoint allows you to check if a number is registered in whatsapp.
Endpoint:
POST : https://ngumzo.com/v1/check-number
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your Api Key |
Body Request( JSON )
-
sender (string):
Number associated with the api key. -
recipient (string):
The number to check if its registered in whatsapp
Sample Body Request (JSON):
Sample API Call Code
Sample Curl Code
Get List of whatsapp Groups
This Ngumzo API endpoint lets you retrieve a list of all WhatsApp groups you are part of, along with their details
Endpoint:
POST : https://ngumzo.com/v1/fetch-groups
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your Api Key |
Body Request( JSON )
-
sender (string):
Phone number associated with Ngumzo Instance.
Sample Body Request (JSON):
Sample API Call Code
Sample Curl Code
Sample Response
Sending Message To Whatsapp Group
With Ngumzo Whatsapp Api, you can send messages direct to whatsapp groups.To message a group, you need to get the whatsapp group unique id which is the group identifier,using the get group list api endpoint.
Once you get the group id,use the send message endpoints by just replacing the number(sendig to) with the group id.
Messages Callback
Webhooks are a powerful tool that lets our server notify your application when a new message arrives on your device. With this feature, you can automate processes like creating a chatbot or building other custom workflows tailored to your needs.
When a message is received, our server will send a `POST` request to your configured webhook URL.
Sample resposne
How to set up a Callback
You can set your callback endpoint at the point of registering your instance.If not set you can edit your instance and add the callback url.
Checking Credits Balance
This is the endpoint for checking yor credits balance
Endpoint:
POST : https://ngumzo.com/v1/check-balance
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| api-key | Your Api Key |
Body Request( JSON )
-
sender (string):
Phone number associated with Ngumzo Instance.