Root API migration
QaziHost WhatsApp API accepts the QaziHost root API paths, access_token and instance_id. Create an access token in Dashboard → API keys, copy your instance ID, and replace the API hostname in your integration with this site's address (the examples below already use it).
Routes marked "live verified" were exercised end to end against a linked WhatsApp number on 2026-09-13. Routes marked "mocked" pass automated tests that run the real request handling, validation, tenant isolation and SQLite persistence against a recorded mock of the WhatsApp transport; routes marked "untested" are implemented but have no automated test. Webhook payload parity is pending; existing incoming events use the QaziHost format described in the main documentation.
curl -X POST "https://your-platform-domain.com/send" \
-H "Content-Type: application/json" \
-d '{"number":"923001234567","type":"text","message":"Hello","instance_id":"YOUR_INSTANCE_ID","access_token":"YOUR_ACCESS_TOKEN"}'JSON and URL-encoded forms are accepted. GET parameters go in the query string. Existing account-scoped API keys also work as access_token for their own instance. User-wide access tokens can create and manage all of your instances. Local SQLite storage is initialized automatically.
Current limits: media downloads are capped at 16 MiB; local/private network media URLs are rejected. Live location, business-profile editing, catalog sends, community events, call links and channel admin invitation/acceptance are not implemented. Channel lists and LID mappings depend on data received or fetched by this instance. Media retrieval by WhatsApp message ID and some optional parameters still need implementation. Labels are stored locally; label synchronization is pending.
| Path | Method | Status |
|---|---|---|
| /create_instance | POST | Implemented · mocked tests pass · live verification pending |
| /list_instances | GET | Live verified |
| /instance_status | GET | Live verified |
| /instance_info | GET | Live verified |
| /logout | POST | Implemented · mocked tests pass · live verification pending |
| /reconnect | POST | Implemented · untested · live verification pending |
| /delete_instance | POST | Implemented · mocked tests pass · live verification pending |
| /set_webhook | POST | Implemented · mocked tests pass · live verification pending |
| /get_webhook | GET | Live verified |
| /check_number | POST | Live verified |
| /get_qrcode | GET | Implemented · untested · live verification pending |
| /get_paircode | GET | Implemented · untested · live verification pending |
| /relogin_qrcode | POST | Implemented · untested · live verification pending |
| /relogin_paircode | POST | Implemented · untested · live verification pending |
| /send | POST | Live verified |
| /get_messages | GET | Live verified |
| /get_messages_by_chat | GET | Live verified |
| /get_message | GET | Live verified |
| /forward_message | POST | Live verified |
| /mark_message_read | PUT | Live verified |
| /delete_message | DELETE | Implemented · mocked tests pass · live verification pending |
| /react_to_message | PUT | Live verified |
| /remove_message_reaction | DELETE | Live verified |
| /star_message | PUT | Live verified |
| /pin_message | POST | Live verified |
| /unpin_message | DELETE | Live verified |
| /get_chats | GET | Live verified |
| /get_chat | GET | Live verified |
| /delete_chat | DELETE | Implemented · mocked tests pass · live verification pending |
| /archive_chat | POST | Live verified |
| /update_chat_settings | POST | Live verified |
| /get_contacts | GET | Live verified |
| /get_contact | GET | Implemented · mocked tests pass · live verification pending |
| /check_phones | POST | Implemented · mocked tests pass · live verification pending |
| /check_exist | POST, GET | Live verified |
| /add_contact | PUT | Implemented · mocked tests pass · live verification pending |
| /edit_contact | POST | Implemented · mocked tests pass · live verification pending |
| /delete_contact | DELETE | Implemented · mocked tests pass · live verification pending |
| /send_contact | POST | Live verified |
| /get_lids_by_ids | GET | Live verified |
| /get_lid_by_id | GET | Implemented · mocked tests pass · live verification pending |
| /get_id_by_lid | GET | Implemented · mocked tests pass · live verification pending |
| /get_profile | GET | Live verified |
| /get_contact_about | GET | Live verified |
| /send_online_presence | PUT | Live verified |
| /send_chat_presence | PUT | Live verified |
| /get_presence | GET | Implemented · mocked tests pass · live verification pending |
| /subscribe_presence | POST | Live verified |
| /get_stories | GET | Live verified |
| /get_story | GET | Implemented · mocked tests pass · live verification pending |
| /publish_story | POST | Implemented · mocked tests pass · live verification pending |
| /post_text_story | POST | Implemented · mocked tests pass · live verification pending |
| /post_media_story | POST | Implemented · untested · live verification pending |
| /post_audio_story | POST | Implemented · untested · live verification pending |
| /copy_story | PUT | Implemented · mocked tests pass · live verification pending |
| /get_view_statuses | GET | Implemented · mocked tests pass · live verification pending |
| /upload_media | POST | Implemented · mocked tests pass · live verification pending |
| /get_media_files | GET | Live verified |
| /get_media | GET | Implemented · mocked tests pass · live verification pending |
| /delete_media | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_business_profile | GET | Live verified |
| /edit_business_profile | POST | Not implemented (501) |
| /get_products | GET | Implemented · mocked tests pass · live verification pending |
| /create_product | POST | Implemented · untested · live verification pending |
| /get_products_by_contact | GET | Implemented · mocked tests pass · live verification pending |
| /get_product | GET | Implemented · mocked tests pass · live verification pending |
| /send_product | POST | Implemented · untested · live verification pending |
| /update_product | POST | Implemented · mocked tests pass · live verification pending |
| /delete_product | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_order_items | GET | Implemented · mocked tests pass · live verification pending |
| /send_catalog | POST | Not implemented (501) |
| /get_collections | GET | Implemented · mocked tests pass · live verification pending |
| /get_collection | GET | Implemented · mocked tests pass · live verification pending |
| /get_collection_products | GET | Implemented · mocked tests pass · live verification pending |
| /get_labels | GET | Live verified |
| /create_label | POST | Implemented · mocked tests pass · live verification pending |
| /get_label_objects | GET | Implemented · mocked tests pass · live verification pending |
| /add_label_association | POST | Implemented · mocked tests pass · live verification pending |
| /delete_label_association | DELETE | Implemented · mocked tests pass · live verification pending |
| /rename_label | POST | Implemented · mocked tests pass · live verification pending |
| /delete_label | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_blacklist | GET | Live verified |
| /add_to_blacklist | PUT | Implemented · mocked tests pass · live verification pending |
| /remove_from_blacklist | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_communities | GET | Live verified |
| /create_community | POST | Implemented · mocked tests pass · live verification pending |
| /get_community | GET | Implemented · mocked tests pass · live verification pending |
| /deactivate_community | DELETE | Implemented · mocked tests pass · live verification pending |
| /revoke_community_invite | DELETE | Implemented · mocked tests pass · live verification pending |
| /join_community_group | POST | Implemented · mocked tests pass · live verification pending |
| /change_community_settings | POST | Implemented · mocked tests pass · live verification pending |
| /add_community_participants | POST | Implemented · mocked tests pass · live verification pending |
| /remove_community_participants | DELETE | Implemented · mocked tests pass · live verification pending |
| /promote_community_admin | POST | Implemented · mocked tests pass · live verification pending |
| /demote_community_admin | DELETE | Implemented · mocked tests pass · live verification pending |
| /create_community_event | POST | Not implemented (501) |
| /reject_call | DELETE | Implemented · mocked tests pass · live verification pending |
| /create_group_video_call_link | POST | Not implemented (501) |
| /get_groups | GET | Live verified |
| /create_group | POST | Implemented · mocked tests pass · live verification pending |
| /accept_group_invite | PUT | Implemented · mocked tests pass · live verification pending |
| /get_group | GET | Implemented · mocked tests pass · live verification pending |
| /update_group_info | PUT | Implemented · mocked tests pass · live verification pending |
| /leave_group | DELETE | Implemented · mocked tests pass · live verification pending |
| /update_group_setting | POST | Implemented · mocked tests pass · live verification pending |
| /get_group_invite | GET | Implemented · mocked tests pass · live verification pending |
| /revoke_group_invite | DELETE | Implemented · mocked tests pass · live verification pending |
| /add_group_participant | POST | Implemented · mocked tests pass · live verification pending |
| /remove_group_participant | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_group_icon | GET | Implemented · mocked tests pass · live verification pending |
| /set_group_icon | PUT | Implemented · untested · live verification pending |
| /delete_group_icon | DELETE | Implemented · mocked tests pass · live verification pending |
| /demote_group_admin | DELETE | Implemented · mocked tests pass · live verification pending |
| /promote_group_admin | POST | Implemented · mocked tests pass · live verification pending |
| /send_group_invite | POST | Implemented · mocked tests pass · live verification pending |
| /get_group_info_by_invite | GET | Implemented · mocked tests pass · live verification pending |
| /get_group_join_requests | GET | Implemented · mocked tests pass · live verification pending |
| /accept_group_join_request | POST | Implemented · mocked tests pass · live verification pending |
| /reject_group_join_requests | DELETE | Implemented · mocked tests pass · live verification pending |
| /get_channels | GET | Live verified |
| /create_channel | POST | Implemented · mocked tests pass · live verification pending |
| /find_channels | GET | Implemented · mocked tests pass · live verification pending |
| /get_recommended_channels | GET | Implemented · mocked tests pass · live verification pending |
| /get_channel | GET | Implemented · mocked tests pass · live verification pending |
| /delete_channel | DELETE | Implemented · mocked tests pass · live verification pending |
| /edit_channel | POST | Implemented · mocked tests pass · live verification pending |
| /subscribe_channel | POST | Implemented · mocked tests pass · live verification pending |
| /unsubscribe_channel | DELETE | Implemented · mocked tests pass · live verification pending |
| /subscribe_channel_by_invite | POST | Implemented · mocked tests pass · live verification pending |
| /unsubscribe_channel_by_invite | DELETE | Implemented · mocked tests pass · live verification pending |
| /subscribe_channel_updates | POST | Implemented · mocked tests pass · live verification pending |
| /get_channel_messages | GET | Implemented · mocked tests pass · live verification pending |
| /create_channel_admin_invite | POST | Not implemented (501) |
| /accept_channel_admin_request | PUT | Not implemented (501) |
| /demote_channel_admin | DELETE | Implemented · mocked tests pass · live verification pending |
| /send_channel_invite | POST | Implemented · mocked tests pass · live verification pending |
| /get_channel_info_by_invite | GET | Implemented · mocked tests pass · live verification pending |