Zaply
HomeWebsite
HomeWebsite
  1. Connection
  • Overview
  • Send Messages
    • Send Message via WhatsApp Instance
      POST
    • Send Media Message via WhatsApp Instance
      POST
    • Send Location Message via WhatsApp Instance
      POST
    • Send Contact Message via WhatsApp Instance
      POST
  • Instance Settings
    • Set Settings
      POST
    • Get Settings
      GET
  • Connection
    • Get QR Code for WhatsApp Connection
      GET
  • Manage Instance
    • Create Instance
      POST
    • Get Instance
      GET
    • Delete Instance
      DELETE
  1. Connection

Get QR Code for WhatsApp Connection

GET
https://api.zaply.dev/v1/instance/{{INSTANCE_ID}}/setting/qr
This API retrieves the QR code required to link a WhatsApp account to a specific instance. The QR code is used to authenticate and establish a connection between your WhatsApp account and Zaply's messaging system. The API allows the QR code to be fetched either as a base64 string or as a direct image.
Request Parameters
Path Parameters
instance_id (string) - The unique identifier of the WhatsApp instance. Replace gej1iz4pta with your instance ID.
Query Parameters
base64 (boolean, optional) - Specifies the format of the QR code:
If set to true, returns the QR code as a base64 encoded string.
If omitted or set to false (default), returns the QR code image.

Headers#

Authorization (string, required) - Bearer token for authentication. Replace {{ZAPLY_AUTH_TOKEN}} with your API token.

Error Codes#

401 Unauthorized - Invalid or missing Authorization token.
404 Not Found - Instance ID does not exist.
500 Internal Server Error - Server encountered an unexpected condition.

Request

Query Params
base64
string 
required
Example:
false
Header Params
Authorization
string 
required
Example:
Bearer {{ZAPLY_AUTH_TOKEN}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.zaply.dev/v1/instance/{{instance_id}}/setting/qr?base64=false' \
--header 'Authorization: Bearer {{ZAPLY_AUTH_TOKEN}}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2024-10-15 07:01:15
Previous
Get Settings
Next
Create Instance
Built with