Dualhook

https://dualhook.com/docs
Admin
Dualhook provides comprehensive documentation on integrating and managing WhatsApp Business...
Tokens:167,115
Snippets:1,871
Trust Score:5.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Platform API: Quickstart

Source: https://dualhook.com/docs

A concise 10-line code sample to initiate an onboarding session and guide a tenant to the Embedded Signup flow.

```javascript
const session = await dualhook.onboarding.createSession({
  tenantId: "tenant-123",
  redirectUrl: "https://saas.example.com/whatsapp/callback",
});

window.location.href = session.embeddedSignupUrl;
```

--------------------------------

### Verify TLS Setup

Source: https://dualhook.com/docs/calling-sip

Use this command to verify your TLS setup for SIP. It checks the certificate and hostname validation.

```bash
openssl s_client -quiet -verify_hostname meta-voip.example.com -connect meta-voip.example.com:5061
```

--------------------------------

### Current Calling Configuration Example

Source: https://dualhook.com/docs/calling-configuration

Example response showing the current calling configuration, including status, audio codecs, and SIP settings.

```json
{
  "calling": {
    "status": "ENABLED",
    "call_icon_visibility": "DEFAULT",
    "callback_permission_status": "ENABLED",
    "call_hours": { /* ... */ },
    "sip": { "status": "ENABLED", "servers": [{ "hostname": "[REDACTED]" }] },
    "audio": { "additional_codecs": ["PCMA", "PCMU"] }
  }
}
```

--------------------------------

### Event Webhook Headers and Example Payload

Source: https://dualhook.com/docs/platform-api-event-webhooks

This snippet shows the expected headers for an event webhook and an example JSON payload for an 'onboarding.completed' event.

```text
X-Dualhook-Signature: sha256=<hex>
X-Dualhook-Event: onboarding.completed
X-Dualhook-Event-Id: evt_...
Content-Type: application/json

{ "event": "onboarding.completed", "id": "evt_...", "createdAt": "...", "data": { ... } }

```

--------------------------------

### Example URL with fbclid

Source: https://dualhook.com/docs/marketing-conversion-tracking

This is an example of a CTA URL with the fbclid query parameter automatically appended by Meta.

```url
https://www.jaspersmarket.com/?fbclid=IwAR2F4-dbP0l7Mn1IawQQGCINEz7PYXQvwjNwB_qa2ofrHyiLjcbCRxTDMgk
```

--------------------------------

### Call Permission State Response Example

Source: https://dualhook.com/docs/calling-permissions

This JSON response shows the current permission status, expiration time for temporary permissions, and details on whether actions like sending a call permission request or starting a call can be performed. It also includes rate limit information for these actions.

```json
{
  "messaging_product": "whatsapp",
  "permission": {
    "status": "temporary",
    "expiration_time": 1745343479
  },
  "actions": [
    {
      "action_name": "send_call_permission_request",
      "can_perform_action": true,
      "limits": [
        { "time_period": "PT24H", "max_allowed": 1, "current_usage": 0 },
        { "time_period": "P7D",   "max_allowed": 2, "current_usage": 1 }
      ]
    },
    {
      "action_name": "start_call",
      "can_perform_action": false,
      "limits": [
        {
          "time_period": "PT24H",
          "max_allowed": 5,
          "current_usage": 5,
          "limit_expiration_time": 1745622600
        }
      ]
    }
  ]
}
```

--------------------------------

### Successful Send Response Example

Source: https://dualhook.com/docs/messaging-best-practices

This is an example of a successful response when sending a message. It includes details about the messaging product, the contact information, and the message ID.

```json
{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "12015550123",
      "wa_id": "12015550123"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTIwMTU1NTAxMjMVAgARGBI..."
    }
  ]
}
```

--------------------------------

### Check WhatsApp Installation on Android without SDK

Source: https://dualhook.com/docs/authentication-best-practices

Implement a custom method to check for WhatsApp installation on Android without using the OTP SDK. This method checks for both the consumer and business versions.

```java
public boolean isWhatsAppInstalled(Context context) {
    return isWhatsAppInstalled(context, "com.whatsapp")
        || isWhatsAppInstalled(context, "com.whatsapp.w4b");
}

private boolean isWhatsAppInstalled(Context context, String packageName) {
    Intent intent = new Intent();
    intent.setPackage(packageName);
    intent.setAction("com.whatsapp.otp.OTP_REQUESTED");
    return !context.getPackageManager().queryBroadcastReceivers(intent, 0).isEmpty();
}
```

--------------------------------

### Message Template Bid Spec Response Example

Source: https://dualhook.com/docs/marketing-max-price

This JSON object shows an example response when retrieving bid specification details for a message template. It includes the bid strategy and the bid amount.

```json
{
  "bid_spec": {
    "bid_strategy": "LOWEST_COST_WITH_BID_CAP",
    "bid_amount": 87000
  },
  "id": "1733678867511493"
}
```

--------------------------------

### Rate Limit Headers Example

Source: https://dualhook.com/docs/platform-api-rate-limits

These headers are included on every authenticated response to indicate current rate limit status.

```text
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 84
X-RateLimit-Reset: 1714400000

```

--------------------------------

### Create Onboarding Session

Source: https://dualhook.com/docs/platform-api

Initiates an onboarding session by sending tenant details, webhook configurations, and redirect URLs to the Dualhook API. Supports optional language selection for onboarding screens.

```bash
POST /api/v1/onboarding/sessions
Content-Type: application/json

{
  "tenantId": "your_tenant_id",
  "webhookOverrideUrl": "your_webhook_url",
  "webhookVerifyToken": "your_webhook_verify_token",
  "successRedirectUrl": "your_success_redirect_url",
  "failureRedirectUrl": "your_failure_redirect_url",
  "cancelRedirectUrl": "your_cancel_redirect_url",
  "language": "en" 
}
```

--------------------------------

### MM_LITE_TERMS_SIGNED Webhook Example

Source: https://dualhook.com/docs/marketing-messages-onboarding

This webhook signals that a customer's business has signed the MM API ToS. It is fired once per WABA and indicates it is safe to start sending marketing messages.

```json
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<SOLUTION_PROVIDER_BUSINESS_ID>",
      "time": "<WEBHOOK_TIMESTAMP>",
      "changes": [
        {
          "field": "account_update",
          "value": {
            "event": "MM_LITE_TERMS_SIGNED",
            "waba_info": {
              "owner_business_id": "<BUSINESS_PORTFOLIO_ID>",
              "waba_id": "102290129340398"
            }
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Call Terminate Webhook Example

Source: https://dualhook.com/docs/calling-business-initiated

This webhook is sent when a call ends, whether by user hang-up, an API action, or network failure. It includes details like start time, end time, and duration.

```json
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "field": "calls",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550001234",
              "phone_number_id": "123456789012345"
            },
            "calls": [
              {
                "id": "wacid.HBgLMTIxODU1NTI4MjgVAgARGCAyODRQIAFRoA",
                "to": "12015550123",
                "from": "15550001234",
                "event": "terminate",
                "direction": "BUSINESS_INITIATED",
                "timestamp": "1749197480",
                "status": "COMPLETED",
                "start_time": "1749196900",
                "end_time": "1749197480",
                "duration": 580,
                "biz_opaque_callback_data": "0fS5cePMok"
              }
            ],
            "errors": [
              { "code": 138019, "message": "Call setup failed" }
            ]
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Onboarding Session

Source: https://dualhook.com/docs/platform-api-quickstart

Use this snippet to create a new onboarding session. It includes setting tenant details, redirect URLs, and an optional webhook override. Ensure your DUALHOOK_API_KEY and MY_WEBHOOK_VERIFY_TOKEN environment variables are set.

```javascript
const r = await fetch("https://dualhook.com/api/v1/onboarding/sessions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.DUALHOOK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    tenantId: customer.id,
    tenantName: customer.name,
    language: customer.locale?.startsWith("es") ? "es" : "en",
    successRedirectUrl: `https://app.example.com/done?cust=${customer.id}`,
    failureRedirectUrl: `https://app.example.com/error?cust=${customer.id}`,
    cancelRedirectUrl: `https://app.example.com/cancel?cust=${customer.id}`,
    webhookOverrideUrl: "https://api.example.com/whatsapp",
    webhookVerifyToken: process.env.MY_WEBHOOK_VERIFY_TOKEN,
  }),
});
const { onboardingUrl } = await r.json();
return redirect(onboardingUrl);
```

--------------------------------

### Look up an onboarding session

Source: https://dualhook.com/docs/platform-api-onboarding-sessions

Use this endpoint to retrieve the status, redirect URLs, and connection ID of an onboarding session.

```bash
GET /api/v1/onboarding/sessions/:id
```

--------------------------------

### Security Webhook Payload Example

Source: https://dualhook.com/docs/webhook-security

This is an example of the payload structure for a security webhook event, specifically a PIN reset request.

```json
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WABA_ID>",
      "time": 1748811473,
      "changes": [
        {
          "field": "security",
          "value": {
            "display_phone_number": "15550783881",
            "event": "PIN_RESET_REQUEST",
            "requester": "61555822107539"
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Onboarding Session Request

Source: https://dualhook.com/docs/platform-api-onboarding-sessions

Use this POST request to create a new onboarding session. Ensure your Authorization header is set and consider using an Idempotency-Key for safe retries. All redirect URLs must be whitelisted.

```json
POST https://dualhook.com/api/v1/onboarding/sessions
Authorization: Bearer dh_live_xxx
Content-Type: application/json
Idempotency-Key: <optional, recommended>

{
  "tenantId": "cust_abc123",
  "tenantName": "Acme Clinic",
  "language": "es",
  "successRedirectUrl": "https://app.example.com/connected",
  "failureRedirectUrl": "https://app.example.com/error",
  "cancelRedirectUrl": "https://app.example.com/cancel",
  "webhookOverrideUrl": "https://api.example.com/wh",
  "webhookVerifyToken": "<your endpoint's hub.verify_token>",
  "metadata": { "internal_id": "..." }
}
```

--------------------------------

### Create Onboarding Session

Source: https://dualhook.com/docs/platform-api-onboarding-sessions

Creates a new onboarding session for a tenant. This generates a unique URL that the tenant will use to complete the WhatsApp Embedded Signup process. The session is valid for a configurable duration and posts lifecycle events to your webhook.

```APIDOC
## POST /api/v1/onboarding/sessions

### Description
Creates a new onboarding session for a tenant, generating a unique URL for the WhatsApp Embedded Signup process. The session has a default expiry of 1 hour, which can be configured.

### Method
POST

### Endpoint
https://dualhook.com/api/v1/onboarding/sessions

### Headers
- **Authorization**: Bearer dh_live_xxx
- **Content-Type**: application/json
- **Idempotency-Key**: <optional, recommended>

### Request Body
- **tenantId** (string) - Required - Your internal identifier for the tenant.
- **tenantName** (string) - Optional - The display name of the tenant.
- **language** (string) - Optional - The language for Dualhook-authored onboarding screens (e.g., "es"). Defaults to English ("en").
- **successRedirectUrl** (string) - Required - The URL to redirect to upon successful onboarding.
- **failureRedirectUrl** (string) - Required - The URL to redirect to upon failure during onboarding.
- **cancelRedirectUrl** (string) - Required - The URL to redirect to if the user cancels the onboarding.
- **webhookOverrideUrl** (string) - Optional - An alternative webhook URL for receiving lifecycle events for this session.
- **webhookVerifyToken** (string) - Optional - Your endpoint's hub.verify_token for webhook verification.
- **metadata** (object) - Optional - Free-form data that will be round-tripped on onboarding events.
- **skipWebhookPreflight** (boolean) - Optional - Set to true to skip the webhook verification preflight.

### Request Example
```json
{
  "tenantId": "cust_abc123",
  "tenantName": "Acme Clinic",
  "language": "es",
  "successRedirectUrl": "https://app.example.com/connected",
  "failureRedirectUrl": "https://app.example.com/error",
  "cancelRedirectUrl": "https://app.example.com/cancel",
  "webhookOverrideUrl": "https://api.example.com/wh",
  "webhookVerifyToken": "<your endpoint's hub.verify_token>",
  "metadata": { "internal_id": "..." }
}
```

### Response
#### Success Response (200)
- **sessionId** (string) - The unique identifier for the created session.
- **onboardingUrl** (string) - The URL the tenant needs to visit to start onboarding.
- **language** (string) - The language configured for the session.
- **expiresAt** (string) - The ISO 8601 timestamp when the onboarding URL will expire.
- **idempotencyExpiresAt** (string) - The ISO 8601 timestamp when the idempotency key will expire.

#### Response Example
```json
{
  "sessionId": "sess_xxxxxxxx",
  "onboardingUrl": "https://dualhook.com/onboard/<token>",
  "language": "es",
  "expiresAt": "2026-04-29T13:34:56Z",
  "idempotencyExpiresAt": "2026-04-29T13:34:56Z"
}
```
```

--------------------------------

### Example Chatwoot Webhook URLs

Source: https://dualhook.com/docs/guide-chatwoot-webhook

Examples of the webhook URL format for both Chatwoot Cloud and self-hosted instances, using a specific phone number.

```text
# Chatwoot Cloud
https://app.chatwoot.com/webhooks/whatsapp/+15551234567

# Self-hosted (host = your FRONTEND_URL)
https://support.example.com/webhooks/whatsapp/+15551234567
```

--------------------------------

### Create Onboarding Session Response

Source: https://dualhook.com/docs/platform-api-onboarding-sessions

Upon successful creation, the API returns the session details including the unique sessionId, the onboardingUrl for the tenant, and the expiry time.

```json
{
  "sessionId": "sess_xxxxxxxx",
  "onboardingUrl": "https://dualhook.com/onboard/<token>",
  "language": "es",
  "expiresAt": "2026-04-29T13:34:56Z",
  "idempotencyExpiresAt": "2026-04-29T13:34:56Z"
}
```

--------------------------------

### Get Current Calling Settings

Source: https://dualhook.com/docs/calling-configuration

Retrieve the current calling configuration and other phone number settings. Include '?include_sip_credentials=true' to get SIP password.

```http
GET /<PHONE_NUMBER_ID>/settings
```

--------------------------------

### Configure Supported Apps for OTP Handshake

Source: https://dualhook.com/docs/authentication-otp-handshake

Use the `supported_apps` array to specify package name and signature hash pairs for multiple app builds or distributions. Eligibility check passes if any listed pair matches the installed app.

```json
"supported_apps": [
  { "package_name": "com.example.app",       "signature_hash": "K8a/AINcGX7" },
  { "package_name": "com.example.app.debug", "signature_hash": "Lp9/BJOdHY8" }
]
```

--------------------------------

### Create Onboarding Session

Source: https://dualhook.com/docs/platform-api-quickstart

This endpoint creates a one-hour-valid onboarding URL that can be rendered within your application. After the tenant completes Meta's Embedded Signup, Dualhook exchanges the OAuth code, subscribes the Meta webhook to the provided URL, and sends a signed `onboarding.completed` event to your event endpoint.

```APIDOC
## POST /api/v1/onboarding/sessions

### Description
Creates a new onboarding session, returning a URL for the tenant to complete the WhatsApp onboarding process.

### Method
POST

### Endpoint
/api/v1/onboarding/sessions

### Parameters
#### Request Body
- **tenantId** (string) - Required - The unique identifier for the tenant.
- **tenantName** (string) - Required - The name of the tenant.
- **language** (string) - Optional - The language for the onboarding screens. Defaults to 'en'. Use 'es' for Spanish.
- **successRedirectUrl** (string) - Required - The URL to redirect to upon successful onboarding.
- **failureRedirectUrl** (string) - Required - The URL to redirect to upon failed onboarding.
- **cancelRedirectUrl** (string) - Required - The URL to redirect to if the user cancels onboarding.
- **webhookOverrideUrl** (string) - Optional - An alternative URL to receive webhook events.
- **webhookVerifyToken** (string) - Optional - A token to verify the webhook endpoint.
- **expiresInSeconds** (integer) - Optional - The duration in seconds for which the onboarding session is valid (300–86400). Defaults to one hour.

### Request Example
```json
{
  "tenantId": "customer.id",
  "tenantName": "customer.name",
  "language": "en",
  "successRedirectUrl": "https://app.example.com/done?cust=customer.id",
  "failureRedirectUrl": "https://app.example.com/error?cust=customer.id",
  "cancelRedirectUrl": "https://app.example.com/cancel?cust=customer.id",
  "webhookOverrideUrl": "https://api.example.com/whatsapp",
  "webhookVerifyToken": "process.env.MY_WEBHOOK_VERIFY_TOKEN"
}
```

### Response
#### Success Response (200)
- **onboardingUrl** (string) - The URL for the tenant to start the onboarding process.
- **sessionId** (string) - The unique identifier for the onboarding session.
- **language** (string) - The language used for the onboarding session.
- **expiresAt** (string) - The expiration timestamp of the onboarding session.

#### Response Example
```json
{
  "onboardingUrl": "https://dualhook.com/onboarding?session=abc123xyz",
  "sessionId": "sess_abc123xyz",
  "language": "en",
  "expiresAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Get SIP Credentials

Source: https://dualhook.com/docs/calling-sip

Retrieve the SIP user password by including `?include_sip_credentials=true` in the GET settings call. The password is generated per phone number and app combination.

```HTTP
GET /<PHONE_NUMBER_ID>/settings?include_sip_credentials=true
```

--------------------------------

### List Connections

Source: https://dualhook.com/docs/platform-api-connections

Use this endpoint to retrieve a paginated list of connections. Filter by tenant ID. The response includes a `nextCursor` for fetching subsequent pages.

```bash
GET /api/v1/connections?tenantId=cust_abc123&limit=50

```

--------------------------------

### Example Webhook Payload: Incoming Message

Source: https://dualhook.com/docs/basics-overview

This is an example of the JSON payload received when a new message arrives via webhook. It includes message details, sender information, and metadata.

```json
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550001234",
              "phone_number_id": "123456789012345"
            },
            "contacts": [
              {
                "profile": { "name": "Alex Example" },
                "wa_id": "12015550123"
              }
            ],
            "messages": [
              {
                "from": "12015550123",
                "id": "wamid.HBgLMTIwMTU1NTAxMjMVAgARGBI...",
                "timestamp": "1735939200",
                "text": { "body": "Hi" },
                "type": "text"
              }
            ]
          }
        }
      ]
    }
  ]
}
```

--------------------------------

### Sample onboarding.completed Payload for Coexistence Connection

Source: https://dualhook.com/docs/platform-api-event-webhooks

This payload represents a successful onboarding for a coexistence connection, common for partners onboarding existing WhatsApp Business app numbers. It includes details about the connection, tenant, and heartbeat status.

```json
{
  "event": "onboarding.completed",
  "id": "evt_xxxxxxxx",
  "createdAt": "2026-05-01T10:30:00Z",
  "data": {
    "sessionId": "sess_xxxxxxxx",
    "tenantId": "cust_abc123",
    "connectionId": "conn_xxx",
    "wabaId": "123456789",
    "phoneNumberId": "987654321",
    "displayPhoneNumber": "+1 555 0123",
    "verifiedName": "Acme Co",
    "connectionMode": "coexistence",
    "coexistenceStatus": "active",
    "heartbeatStatus": "OK",
    "heartbeatLastConfirmedAt": "2026-05-01T10:30:00Z",
    "heartbeatNextDueAt": "2026-05-14T10:30:00Z",
    "heartbeatReminderSentAt": null,
    "metadata": { "internal_id": "..." }
  }
}
```

--------------------------------

### Meta Verification Handshake (GET Request)

Source: https://dualhook.com/docs/messaging-webhook

Meta sends this GET request to verify callback ownership. Your endpoint should return HTTP 200 with the challenge value as the response body.

```http
GET /webhooks/meta/messages?hub.mode=subscribe&hub.verify_token=<TOKEN>&hub.challenge=1903260781
```

--------------------------------

### Check WhatsApp Installation on Android with OTP SDK

Source: https://dualhook.com/docs/authentication-best-practices

Use the WhatsApp OTP Android SDK to easily check if WhatsApp is installed on the user's device. This is the preferred method for Android.

```java
WhatsAppOtpHandler whatsAppOtpHandler = new WhatsAppOtpHandler();
if (whatsAppOtpHandler.isWhatsAppInstalled(context)) {
    // show WhatsApp option in your UI
}
```

--------------------------------

### Configure Conversational Automation via API

Source: https://dualhook.com/docs/welcome-ice-breakers-commands-config

Use this cURL command to enable welcome messages and set up commands and prompts for your WhatsApp business number via the Graph API. Ensure you replace placeholders like <GRAPH_VERSION>, <PHONE_NUMBER_ID>, and <ACCESS_TOKEN>.

```bash
curl -X POST "https://graph.facebook.com/<GRAPH_VERSION>/<PHONE_NUMBER_ID>/conversational_automation" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_welcome_message": true,
    "commands": [
      { "command_name": "help", "command_description": "Get help" },
      { "command_name": "order", "command_description": "Check order status" }
    ],
    "prompts": ["I need help with my order", "Tell me about your services"]
  }'
```

--------------------------------

### Example Request: Configure Webhook Override (cURL)

Source: https://dualhook.com/docs/basics-overview

This cURL command demonstrates how to configure a webhook override for your WhatsApp Business Account. Replace <GRAPH_VERSION> and <WABA_ID> with your specific identifiers.

```bash
curl -X POST "https://graph.facebook.com/<GRAPH_VERSION>/<WABA_ID>/subscribed_apps" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "override_callback_uri":"https://api.yourcompany.com/webhooks/whatsapp",
    "verify_token":"your-verify-token"
  }'
```

--------------------------------

### Sample onboarding.failed Event Payload

Source: https://dualhook.com/docs/platform-api-event-webhooks

This JSON payload represents an 'onboarding.failed' event, fired when a session terminates without a usable connection. It includes details about the session, tenant, and the specific reason for failure.

```json
{
  "event": "onboarding.failed",
  "id": "evt_xxxxxxxx",
  "createdAt": "2026-05-08T10:30:00Z",
  "data": {
    "sessionId": "sess_xxxxxxxx",
    "tenantId": "cust_abc123",
    "wabaId": "123456789",
    "phoneNumberId": "987654321",
    "displayPhoneNumber": "+1 555 0123",
    "verifiedName": "Acme Co",
    "reason": "webhook_subscribe_failed",
    "errorCode": "webhook_subscribe_failed",
    "errorCategory": "endpoint_forbidden",
    "errorMessage": "(#2200) Callback verification failed with the following errors: HTTP Status Code = 403; HTTP Message = Forbidden",
    "metadata": { "internal_id": "..." }
  }
}
```

--------------------------------

### Check WhatsApp Installation on iOS

Source: https://dualhook.com/docs/authentication-best-practices

Use this Swift code to check if WhatsApp is installed on an iOS device by attempting to open the 'whatsapp://otp' URL scheme. Ensure the 'whatsapp' URL scheme is declared in your Info.plist.

```swift
let schemeURL = URL(string: "whatsapp://otp")!
let isWhatsAppInstalled = UIApplication.shared.canOpenURL(schemeURL)
```

--------------------------------

### Create a QR Code

Source: https://dualhook.com/docs/qr-codes

Use this endpoint to create a new QR code or short link. Specify the prefilled message and the desired image format (SVG or PNG).

```bash
POST /<PHONE_NUMBER_ID>/message_qrdls
```

```json
{
  "prefilled_message": "Cyber Monday",
  "generate_qr_image": "SVG"
}
```

--------------------------------

### GET /api/v1/connections/:id/health

Source: https://dualhook.com/docs/platform-api-connections

Retrieves the latest stored health snapshot for a connection.

```APIDOC
## GET /api/v1/connections/:id/health

### Description
Returns the latest stored snapshot of the connection's health status. The `health` field will be `null` if no snapshot exists yet; in this case, call the refresh endpoint first.

### Method
GET

### Endpoint
/api/v1/connections/:id/health

### Response
#### Success Response (200)
- **connectionId** (string) - The ID of the connection.
- **health** (object | null) - An object containing the health details, or null if no snapshot exists.
  - **healthStatus** (string) - The overall health status.
  - **qualityRating** (string) - The quality rating (e.g., GREEN).
  - **accountMode** (string | null) - The account mode.
  - **messagingTier** (string) - The messaging tier.
  - **nameStatus** (string) - The status of the name.
  - **newNameStatus** (string | null) - The status of the new name.
  - **additionalInfo** (string | null) - Additional information.
  - **errorMessage** (string | null) - An error message, if any.
  - **checkedAt** (string) - The timestamp when the health was last checked.

#### Response Example
```json
{
  "connectionId": "conn_xxx",
  "health": {
    "healthStatus": "AVAILABLE",
    "qualityRating": "GREEN",
    "accountMode": null,
    "messagingTier": "TIER_250",
    "nameStatus": "APPROVED",
    "newNameStatus": null,
    "additionalInfo": null,
    "errorMessage": null,
    "checkedAt": "2026-05-02T10:30:00Z"
  }
}
```
```

--------------------------------

### Get Call Permission State API Endpoint

Source: https://dualhook.com/docs/calling-permissions

Use this GET request to retrieve the current calling permission status for a user, along with their rate-limit budget for sending new permission requests and placing calls. The response indicates if the user has no permission, temporary permission (with an expiration time), or permanent permission.

```bash
GET /<PHONE_NUMBER_ID>/call_permissions?user_wa_id=<USER_WHATSAPP_ID>
```

--------------------------------

### URL Button Parameter

Source: https://dualhook.com/docs/sending-template-messages

Example of sending a template message that includes a URL button.

```APIDOC
## URL Button Parameter

### Description
Send a template message with a URL button.

### Request Body
```json
{
  "messaging_product": "whatsapp",
  "to": "12015550123",
  "type": "template",
  "template": {
    "name": "track_order_button",
    "language": {
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          { "type": "text", "text": "Alex" },
          { "type": "text", "text": "A12345" }
        ]
      },
      {
        "type": "button",
        "sub_type": "url",
        "index": "0",
        "parameters": [
          { "type": "text", "text": "A12345" }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Look up a session

Source: https://dualhook.com/docs/platform-api-onboarding-sessions

Retrieves the status, redirect URLs, and connection ID for a given onboarding session. This is useful for tracking the progress and outcome of an onboarding process.

```APIDOC
## GET /api/v1/onboarding/sessions/:id

### Description
Returns status, redirect URLs, and the resulting `connectionId` if completed.

### Method
GET

### Endpoint
/api/v1/onboarding/sessions/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the onboarding session.
```
Tokens:
Raw