mywhin
Selfhost a whin instance, a Whatsapp API REST client. Send or receive notifications with your very own number.
19 subscribers
9.7/10 popularity
1442 ms avg latency
32% success rate
56 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
mywhin endpoints
| Method | Endpoint | Description |
|---|---|---|
| Instance Management | ||
| GET |
enroll /qrpng |
This endpoint returns a QR after 10 seconds; it must be scanned from the whatsapp app installed on a phone. |
| GET |
status /status |
Returns the status of your tenant. Possible values are: active, sleep, pending enrollment. |
| GET |
sleep /sleep |
Switch the status to sleep state. |
| GET |
resume /resume |
switch the instance from sleep to active state. |
| GET |
console /token |
Get an access token for mywhin console. Enter the token at: https://console.whin.app/login |
| GET |
token MCP /mcptoken |
Returns a token to expose the mcp interface of the mywhin instance. |
| GET |
unenroll /kill |
A request to this endpoint will wipe your instance, it will transition to pending enrollment state. You'll need to enroll using a new QR to continue using the service. |
| Messaging | ||
| POST |
send message /wspout |
Sends a whatsapp message to a whatsapp contact; the payload must contain the right body schema. Check the body examples provided. |
| POST |
send message to group /send2grp |
The requests to this endpoint will be messages sent to a whatsapp group. Make sure you are using the right body schema, see the examples provided. |
| POST |
send poll /createpoll |
Sends a poll with options to a whatsapp group. The poll answers will be sent to the webhook listener you defined. |
| POST |
set webhook url /seturl |
use this endpoint to specify the valid URL to which you want the system to deliver the whatsapp messages you receive. |
| GET |
which is my webhook /geturl |
The response will be the url defined as webhook destination where the whatsapp messages will be delivered. |
| GET |
reset my webhook /delurl |
Deletes the destination url that you have defined to deliver incoming whatsapp messages. |
| Group Management | ||
| POST |
create group /groups/create |
Creates a new group, and adds the initial participants to it. |
| POST |
set group picture /groups/setpic |
This endpoint will allow setting the profile picture of a group |
| POST |
set group name /groups/setname |
changes the name of a group. |
| POST |
set group subject /groups/settopic |
changes the subject of a group |
| POST |
get group invite link /groups/getlink |
gets an invitation link |
| POST |
get group participants /groups/getinfo |
gets the metadata of a group including: participants, subject, time of creation... |
| POST |
list all groups /groups/mygroups |
get a list of all groups you are a participant, and their group-id (a.k.a. gid). Watch this [video](https://www.youtube.com/watch?v=HDM_l33691M) showing how to do it. |
| POST |
add group members /groups/addmembers |
adds a new member to a group; make sure you are Admin of the group, before using this endpoint. |
| POST |
remove group members /groups/removemembers |
removes members from a group; make sure you're Admin of the group before using this endpoint. |
| POST |
promote group members /groups/promotemembers |
promotes members to Admin of a group. Make sure you are an Admin of the group before using this endpoint. |
| POST |
demote group members /groups/demotemembers |
Demote members of a group. Make sure you are Admin of the group, before using this endpoint. |
| POST |
leave group /groups/leave |
Leaves a group. |
| Whatsapp Channels | ||
| POST |
send newsletter /sendnews |
this endpoint will post a new message on the channel selected. Check the different body schemas examples that you can use to format the messages sent. |
| POST |
create new channel /channelcreate |
Creates a new whatsapp channel |
| GET |
list all channels and metadata /chlist |
This endpoint will return all the metadata of the whatsapp channels that you own, and the webhooks associated to each. |
| Private URLs | ||
| GET |
private listener url /webhk |
The response is an url that you have to use as a destination at the origin service. The content sent to it the url you get, will be routed as a message to any whatsapp number or… |
| POST |
post receiver /hk/{origin}/{destination} |
This endpoint shall be triggered by origin services, DO NOT USE IT on the playground. |
| GET |
Set Telegram destination /tg2wsp/{channel-id} |
Set telegram channel webhook |
| POST |
Telegram channels listener /tg2wsp/{channel-id} |
Deliver telegram channel post to whatsapp channel |
| Other endpoints | ||
| POST |
create group /grpnew |
creates a new group. This [video](https://www.youtube.com/watch?v=HDM_l33691M) shows a how-to. |
| POST |
send message /wspout |
Sends a whatsapp message to a whatsapp contact; the payload must contain the right schema. |
| GET |
private listener url /webhk |
The response is an url that you have to use as a webhook destination at the origin service. The content sent to it will be routed as a message to any whatsapp number or to a… |
| GET |
create /create |
This endpoint will create a dedicated instance that will be linked to your rapidapi username. |
| POST |
send message to group /send2grp |
The requests to this endpoint will be messages sent to a whatsapp group. |
| GET |
get receiver /hk/{origin}/{slotid}/{destination} |
This endpoint shall be triggered by origin services, it's **NOT** to be used on the playground. |
| GET |
enroll /qrpng |
This endpoint returns a QR **after 15 seconds**; it must be scanned from the whatsapp app installed on a phone. |
| POST |
set webhook url /seturl |
use this endpoint to specify the valid URL to which you want the system to deliver the whatsapp messages you receive. This [video](https://www.youtube.com/watch?v=HDM_l33691M)… |
| GET |
list groups /grpall |
get a list of all groups you are a participant, and their group-id (a.k.a. gid). Watch this [video](https://www.youtube.com/watch?v=HDM_l33691M) showing how to do it. |
| GET |
status /status |
Returns the status of your tenant. Possible values are: ``active``, ``sleep``, ``pending enrollment``. |
| POST |
post receiver /hk/{origin}/{slotid}/{destination} |
This endpoint shall be triggered by origin services, it's **NOT** to be used on the playground. |
| POST |
set group description /grpchdesc |
changes description of a group. |
| GET |
sleep /sleep |
Switch the status to `sleep` state. |
| GET |
which is my webhook /geturl |
the response will be the url defined as webhook destination where the whatsapp messages will be delivered. Watch a how to [video](https://www.youtube.com/watch?v=8WyG_becZXM). |
| GET |
resume /resume |
switch the tenant from `sleep` to `active` state. |
| POST |
set group subject /grpchname |
changes the subject of a group |
| GET |
unenroll /kill |
A request to this endpoint will wipe your instance, it will transition to `pending enrollment` state. You'll need to enroll using a new QR to continue using the service. |
| GET |
get group invite link /grplink |
gets an invitation link |
+ 6 more endpoints on the provider's documentation.
mywhin pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | $19.99 / month | 5 / minute |
|
| PRO | $29.99 / month | 1 / second |
|
