Get QR code SVG image URL · WhatsApp

infoOverview

About this API

This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.

MethodGET

Versionv3.0

Base URLhttps://partnersv1.pinbot.ai/v3

Content TypeNo request body

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameapi key

Example valueYOUR_WABA_API_KEY

routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

businessPhoneNumberIdstringRequiredResource identifier for businessPhoneNumberId.

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

codestringNot specifiedRequest value for code.

fieldsstringNot specifiedRequest value for fields.

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

smartphoneEmbedded Signup Sandbox

Test with simulated WABA credentials

Use the sample WABA ID and WABA number produced by the Embedded Signup simulation. Sending here never calls the real WhatsApp API.

9:41⌁

chevron_left

1S

1SPOC Demobusiness account

videocamcall

lockMessages are end-to-end encrypted. This preview is simulated.

Today

Ready to preview: Get QR code SVG image URL.9:41

add_circle

Messagedescription

photo_cameramic

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request GET 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url' \
  --header 'api key: <API_KEY>'

const response = await fetch('https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url', {
  method: 'GET',
  headers: {
    "api key": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url', {
  method: 'GET',
  headers: {
    "api key": "<API_KEY>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url'
headers = {
  "api key": "<API_KEY>"
}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url"))
    .header("api key", "<API_KEY>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => ["api key: <API_KEY>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api key", "<API_KEY>");
var response = await client.GetAsync("https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://partnersv1.pinbot.ai/v3/business/{businessPhoneNumberId}/message_qrdls?code=ZFWJIGIWOW2BN1&fields=code%2Cprefilled_message%2Cqr_image_url.format%28SVG%29%2Cdeep_link_url", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    request.Header.Set("api key", "<API_KEY>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{
"data": [
{
"code": "ZFWJIGIWOW2BN1",

"prefilled_message": "Abhijit...",
"qr_image_url": "http:
south-1.amazonaws.com/v3/images?url=https%3A%2F%2Fscontent-bom2-
1.xx.fbcdn.net%2Fm1%2Fv%2Ft6%2FAn9xvLG9mjuwD4G6_NS5UE2g4rdQ7e81yqUM
KbQufVN02pcBQlKB2Q75XVhpul88g89cdZwl1BctRnMPU7eV-
UpgNAzWqK5StZspkWFpAbPy8LgzhGCLafe7Xm66entnPI0w6zMmiw89%3Fccb%3D1
0-5%26oh%3D00_AYBtrU7w-AC01aD-rdYkjpiqDnbVTXDbWfryn-
NjioPYxQ%26oe%3D674FBC84%26_nc_sid%3D5a413f",
"deep_link_url": "https:
}
]
}

{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}

ruleHTTP Responses

Status Codes

200The request was successful.

400Bad request or invalid parameters.

401API key is missing or invalid.

403The request is not authorized for this resource.

404The requested resource was not found.

500The server encountered an error.