All URIs are relative to /api
| Method | HTTP request | Description |
|---|---|---|
| change_webhook_url | PUT /instances/{instance_key}/webhook | Change Webhook url. |
| create_instance | POST /instances/create | Creates a new instance key. |
| delete_instance | DELETE /instances/{instance_key}/delete | Delete Instance. |
| get_contacts | GET /instances/{instance_key}/contacts | Get contacts. |
| get_instance | GET /instances/{instance_key}/ | Get Instance. |
| get_qr_code | GET /instances/{instance_key}/qrcode | Get QrCode. |
| list_instances | GET /instances/list | Get all instances. |
| logout_instance | DELETE /instances/{instance_key}/logout | Logout Instance. |
crate::models::ApiResponse change_webhook_url(instance_key, data) Change Webhook url.
Changes the webhook url of an instance.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] | |
| data | WebhookPayload | Message data | [required] |
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse create_instance(data) Creates a new instance key.
This endpoint is used to create a new WhatsApp Web instance.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| data | CreateInstancePayload | Instance data | [required] |
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse delete_instance(instance_key) Delete Instance.
Deletes the instance with the provided key.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] |
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse get_contacts(instance_key) Get contacts.
Fetches the list of contacts in the instance.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] |
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse get_instance(instance_key) Get Instance.
Returns the instance data of single instance with connection status.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] |
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse get_qr_code(instance_key) Get QrCode.
Returns the qrcode in the base64 format.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] |
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse list_instances() Get all instances.
Fetches the list of all Instances with login status.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::ApiResponse logout_instance(instance_key) Logout Instance.
Logouts of the instance with the provided key.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| instance_key | String | Instance key | [required] |
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]