API documentation

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.

code
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.

PathMethodStatus
/create_instancePOSTImplemented · mocked tests pass · live verification pending
/list_instancesGETLive verified
/instance_statusGETLive verified
/instance_infoGETLive verified
/logoutPOSTImplemented · mocked tests pass · live verification pending
/reconnectPOSTImplemented · untested · live verification pending
/delete_instancePOSTImplemented · mocked tests pass · live verification pending
/set_webhookPOSTImplemented · mocked tests pass · live verification pending
/get_webhookGETLive verified
/check_numberPOSTLive verified
/get_qrcodeGETImplemented · untested · live verification pending
/get_paircodeGETImplemented · untested · live verification pending
/relogin_qrcodePOSTImplemented · untested · live verification pending
/relogin_paircodePOSTImplemented · untested · live verification pending
/sendPOSTLive verified
/get_messagesGETLive verified
/get_messages_by_chatGETLive verified
/get_messageGETLive verified
/forward_messagePOSTLive verified
/mark_message_readPUTLive verified
/delete_messageDELETEImplemented · mocked tests pass · live verification pending
/react_to_messagePUTLive verified
/remove_message_reactionDELETELive verified
/star_messagePUTLive verified
/pin_messagePOSTLive verified
/unpin_messageDELETELive verified
/get_chatsGETLive verified
/get_chatGETLive verified
/delete_chatDELETEImplemented · mocked tests pass · live verification pending
/archive_chatPOSTLive verified
/update_chat_settingsPOSTLive verified
/get_contactsGETLive verified
/get_contactGETImplemented · mocked tests pass · live verification pending
/check_phonesPOSTImplemented · mocked tests pass · live verification pending
/check_existPOST, GETLive verified
/add_contactPUTImplemented · mocked tests pass · live verification pending
/edit_contactPOSTImplemented · mocked tests pass · live verification pending
/delete_contactDELETEImplemented · mocked tests pass · live verification pending
/send_contactPOSTLive verified
/get_lids_by_idsGETLive verified
/get_lid_by_idGETImplemented · mocked tests pass · live verification pending
/get_id_by_lidGETImplemented · mocked tests pass · live verification pending
/get_profileGETLive verified
/get_contact_aboutGETLive verified
/send_online_presencePUTLive verified
/send_chat_presencePUTLive verified
/get_presenceGETImplemented · mocked tests pass · live verification pending
/subscribe_presencePOSTLive verified
/get_storiesGETLive verified
/get_storyGETImplemented · mocked tests pass · live verification pending
/publish_storyPOSTImplemented · mocked tests pass · live verification pending
/post_text_storyPOSTImplemented · mocked tests pass · live verification pending
/post_media_storyPOSTImplemented · untested · live verification pending
/post_audio_storyPOSTImplemented · untested · live verification pending
/copy_storyPUTImplemented · mocked tests pass · live verification pending
/get_view_statusesGETImplemented · mocked tests pass · live verification pending
/upload_mediaPOSTImplemented · mocked tests pass · live verification pending
/get_media_filesGETLive verified
/get_mediaGETImplemented · mocked tests pass · live verification pending
/delete_mediaDELETEImplemented · mocked tests pass · live verification pending
/get_business_profileGETLive verified
/edit_business_profilePOSTNot implemented (501)
/get_productsGETImplemented · mocked tests pass · live verification pending
/create_productPOSTImplemented · untested · live verification pending
/get_products_by_contactGETImplemented · mocked tests pass · live verification pending
/get_productGETImplemented · mocked tests pass · live verification pending
/send_productPOSTImplemented · untested · live verification pending
/update_productPOSTImplemented · mocked tests pass · live verification pending
/delete_productDELETEImplemented · mocked tests pass · live verification pending
/get_order_itemsGETImplemented · mocked tests pass · live verification pending
/send_catalogPOSTNot implemented (501)
/get_collectionsGETImplemented · mocked tests pass · live verification pending
/get_collectionGETImplemented · mocked tests pass · live verification pending
/get_collection_productsGETImplemented · mocked tests pass · live verification pending
/get_labelsGETLive verified
/create_labelPOSTImplemented · mocked tests pass · live verification pending
/get_label_objectsGETImplemented · mocked tests pass · live verification pending
/add_label_associationPOSTImplemented · mocked tests pass · live verification pending
/delete_label_associationDELETEImplemented · mocked tests pass · live verification pending
/rename_labelPOSTImplemented · mocked tests pass · live verification pending
/delete_labelDELETEImplemented · mocked tests pass · live verification pending
/get_blacklistGETLive verified
/add_to_blacklistPUTImplemented · mocked tests pass · live verification pending
/remove_from_blacklistDELETEImplemented · mocked tests pass · live verification pending
/get_communitiesGETLive verified
/create_communityPOSTImplemented · mocked tests pass · live verification pending
/get_communityGETImplemented · mocked tests pass · live verification pending
/deactivate_communityDELETEImplemented · mocked tests pass · live verification pending
/revoke_community_inviteDELETEImplemented · mocked tests pass · live verification pending
/join_community_groupPOSTImplemented · mocked tests pass · live verification pending
/change_community_settingsPOSTImplemented · mocked tests pass · live verification pending
/add_community_participantsPOSTImplemented · mocked tests pass · live verification pending
/remove_community_participantsDELETEImplemented · mocked tests pass · live verification pending
/promote_community_adminPOSTImplemented · mocked tests pass · live verification pending
/demote_community_adminDELETEImplemented · mocked tests pass · live verification pending
/create_community_eventPOSTNot implemented (501)
/reject_callDELETEImplemented · mocked tests pass · live verification pending
/create_group_video_call_linkPOSTNot implemented (501)
/get_groupsGETLive verified
/create_groupPOSTImplemented · mocked tests pass · live verification pending
/accept_group_invitePUTImplemented · mocked tests pass · live verification pending
/get_groupGETImplemented · mocked tests pass · live verification pending
/update_group_infoPUTImplemented · mocked tests pass · live verification pending
/leave_groupDELETEImplemented · mocked tests pass · live verification pending
/update_group_settingPOSTImplemented · mocked tests pass · live verification pending
/get_group_inviteGETImplemented · mocked tests pass · live verification pending
/revoke_group_inviteDELETEImplemented · mocked tests pass · live verification pending
/add_group_participantPOSTImplemented · mocked tests pass · live verification pending
/remove_group_participantDELETEImplemented · mocked tests pass · live verification pending
/get_group_iconGETImplemented · mocked tests pass · live verification pending
/set_group_iconPUTImplemented · untested · live verification pending
/delete_group_iconDELETEImplemented · mocked tests pass · live verification pending
/demote_group_adminDELETEImplemented · mocked tests pass · live verification pending
/promote_group_adminPOSTImplemented · mocked tests pass · live verification pending
/send_group_invitePOSTImplemented · mocked tests pass · live verification pending
/get_group_info_by_inviteGETImplemented · mocked tests pass · live verification pending
/get_group_join_requestsGETImplemented · mocked tests pass · live verification pending
/accept_group_join_requestPOSTImplemented · mocked tests pass · live verification pending
/reject_group_join_requestsDELETEImplemented · mocked tests pass · live verification pending
/get_channelsGETLive verified
/create_channelPOSTImplemented · mocked tests pass · live verification pending
/find_channelsGETImplemented · mocked tests pass · live verification pending
/get_recommended_channelsGETImplemented · mocked tests pass · live verification pending
/get_channelGETImplemented · mocked tests pass · live verification pending
/delete_channelDELETEImplemented · mocked tests pass · live verification pending
/edit_channelPOSTImplemented · mocked tests pass · live verification pending
/subscribe_channelPOSTImplemented · mocked tests pass · live verification pending
/unsubscribe_channelDELETEImplemented · mocked tests pass · live verification pending
/subscribe_channel_by_invitePOSTImplemented · mocked tests pass · live verification pending
/unsubscribe_channel_by_inviteDELETEImplemented · mocked tests pass · live verification pending
/subscribe_channel_updatesPOSTImplemented · mocked tests pass · live verification pending
/get_channel_messagesGETImplemented · mocked tests pass · live verification pending
/create_channel_admin_invitePOSTNot implemented (501)
/accept_channel_admin_requestPUTNot implemented (501)
/demote_channel_adminDELETEImplemented · mocked tests pass · live verification pending
/send_channel_invitePOSTImplemented · mocked tests pass · live verification pending
/get_channel_info_by_inviteGETImplemented · mocked tests pass · live verification pending