Graph API Version

    Whats App Business Phone Number Message Qrdls

    Represents a collection of QR codes or short links on a WhatsApp Business Phone Number. See QR Codes.

    Reading

    Get a list of QR codes or short links on a WhatsApp Business Phone Number.

    Example

    Graph API Explorer
    GET /v21.0/{whats-app-business-phone-number-id}/message_qrdls HTTP/1.1
Host: graph.facebook.com
    /* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{whats-app-business-phone-number-id}/message_qrdls',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
    /* make the API call */
FB.api(
    "/{whats-app-business-phone-number-id}/message_qrdls",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
    /* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{whats-app-business-phone-number-id}/message_qrdls",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
    /* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{whats-app-business-phone-number-id}/message_qrdls"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
    If you want to learn how to use the Graph API, read our Using Graph API guide.

    Parameters

    ParameterDescription
    code
    string

    QR code or short link ID.

    Fields

    Reading from this edge will return a JSON formatted result:

    {
    "data": [],
    "paging": {}
}

    data

    A list of WhatsAppBusinessMessageQRDL nodes.

    paging

    For more details about pagination, see the Graph API guide.

    Error Codes

    ErrorDescription
    100Invalid parameter

    Creating

    You can make a POST request to message_qrdls edge from the following paths:
    When posting to this edge, a WhatsAppBusinessMessageQRDL will be created.

    You can also use this endpoint to update an existing QR code or short link by including the code parameter in your request.

    Parameters

    ParameterDescription
    code
    string

    ID of the QR code or short link to update. Omit if creating a QR code or short link.

    generate_qr_image
    enum {PNG, SVG}

    Indicates QR code or short link image format.

    prefilled_message
    string

    Text that will appear in a new WhatsApp message when the customer triggers the QR code or short link.

    Required

    Return Type

    Struct {
    code: string,
    prefilled_message: string,
    deep_link_url: uri,
    qr_image_url: uri,
    }

    Error Codes

    ErrorDescription
    300Edit failure
    100Invalid parameter
    200Permissions error

    Updating

    See Creating to update an existing QR code or short link.


    You can't perform this operation on this endpoint.

    Deleting

    You can dissociate a WhatsAppBusinessMessageQRDL from a WhatsAppBusinessPhoneNumber by making a DELETE request to /{whats_app_business_phone_number_id}/message_qrdls.

    Parameters

    ParameterDescription
    code
    string

    ID of the QR code or short link.

    Required

    Return Type

    Struct {
    success: bool,
    }

    Error Codes

    ErrorDescription
    100Invalid parameter