Kapso

https://docs.kapso.ai/
Admin
Kapso provides WhatsApp infrastructure for developers, offering simple APIs, visual flows, and a...
Tokens:510,149
Snippets:3,475
Trust Score:4.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run recommended setup

Source: https://docs.kapso.ai/docs/whatsapp/hermes-agent

Runs the interactive setup command that installs the Kapso CLI, configures the webhook, and prompts for required values.

```bash
hermes kapso setup --install-cli --funnel-url https://<your-funnel-host>
```

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

### Example setup link response JSON

Source: https://docs.kapso.ai/docs/platform/setup-links/detect-connection

Example response showing a completed WhatsApp setup with a provisioned phone number. The whatsapp_setup_status field indicates progress, and when it is failed, whatsapp_setup_error carries the reason.

```json
{
  "whatsapp_setup_status": "completed",
  "whatsapp_setup_error": null,
  "provisioned_phone_number": {
    "id": "7c6b5a49-3827-1605-4433-2211aabbccdd",
    "phone_number": "+14155551234",
    "display_number": "+1 415 555 1234",
    "status": "assigned",
    "area_code": "415",
    "country_iso": "US",
    "country_dial_code": "1"
  }
}
```

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

### Go example

Source: https://docs.kapso.ai/api/meta/whatsapp/usernames/get-reserved-username-suggestions

Go example using net/http to make the GET request.

```go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username_suggestions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Install and configure OpenClaw WhatsApp plugin

Source: https://docs.kapso.ai/docs/whatsapp/personal-agent

Install the @kapso/openclaw-whatsapp plugin and enable the kapso-whatsapp channel via OpenClaw config. Then run the setup command from the OpenClaw guide.

```bash
openclaw plugins install clawhub:@kapso/openclaw-whatsapp
openclaw config set 'plugins.allow' '["codex","kapso-whatsapp"]' --strict-json
openclaw config set 'channels["kapso-whatsapp"].enabled' true --strict-json

```

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

### Ruby example

Source: https://docs.kapso.ai/api/meta/whatsapp/usernames/get-reserved-username-suggestions

Ruby example using net/http to make the GET request.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username_suggestions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

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

### Install and configure Hermes Agent WhatsApp plugin

Source: https://docs.kapso.ai/docs/whatsapp/personal-agent

Install the gokapso/hermes-agent-plugin, run the Kapso setup command with your funnel URL, and restart the Hermes gateway. The setup command installs the CLI, picks the number, generates the webhook secret, and creates the webhook.

```bash
hermes plugins install gokapso/hermes-agent-plugin --enable
hermes kapso setup --install-cli --funnel-url https://<your-funnel-host>
hermes gateway restart

```

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

### Go example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses the net/http package to send a GET request. Requires an X-API-Key header.

```go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Install and use Kapso CLI

Source: https://docs.kapso.ai/docs/build-with-ai

Install the Kapso CLI and run setup, list WhatsApp numbers, and send a message. Use for live project operations from a terminal session.

```bash
curl -fsSL https://kapso.ai/install.sh | bash

kapso setup
kapso whatsapp numbers list
kapso whatsapp messages send --phone-number "<your-number>" --to 15551234567 --text "Hello"

```

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

### Go example to get media URL

Source: https://docs.kapso.ai/api/meta/whatsapp/media/get-media-url

Uses the net/http package to send a GET request to the Kapso API. Requires the X-API-Key header for authentication.

```Go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{media_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### Create a workflow with Start node using @kapso/workflows

Source: https://docs.kapso.ai/docs/flows/step-types/start-node

Use this example to create a new workflow with the Start node. It imports START and Workflow from @kapso/workflows, creates a workflow named 'welcome-flow', adds the START node at position (100, 100), and exports the workflow as default.

```typescript
import { START, Workflow } from "@kapso/workflows";

const workflow = new Workflow("welcome-flow", {
  name: "Welcome Flow"
});

workflow.addNode(START, {
  position: { x: 100, y: 100 }
});

export default workflow;

```

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

### List setup links

Source: https://docs.kapso.ai/llms.txt

Gets WhatsApp onboarding links for a customer, most recent first.

```APIDOC
## GET /api/platform/v1/setup-links/list-setup-links

### Description
Gets WhatsApp onboarding links for a customer, most recent first.

### Method
GET

### Endpoint
/api/platform/v1/setup-links/list-setup-links

```

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

### Full example: create setup link and send email

Source: https://docs.kapso.ai/docs/platform/setup-links/create-and-configure

Complete example of creating a setup link via the Kapso API and sending it to the customer. Uses the platform endpoint with an API key, includes redirect URLs, allowed origins, billing mode, connection types, phone provisioning, language, and theme. The response URL is used in an email to the customer.

```javascript
const setupLink = await fetch(
  `https://api.kapso.ai/platform/v1/customers/${customerId}/setup_links`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      setup_link: {
        success_redirect_url: 'https://app.example.com/onboarding/complete',
        failure_redirect_url: 'https://app.example.com/onboarding/error',
        allowed_origins: ['https://app.example.com'],
        meta_billing_mode: 'partner_managed',
        allowed_connection_types: ['dedicated'],
        provision_phone_number: true,
        phone_number_country_isos: ['US'],
        language: 'es',
        theme_config: {
          primary_color: '#10b981',
          background_color: '#ffffff',
          text_color: '#111827'
        }
      }
    })
  }
);

// Send link to customer
await sendEmail(customer.email, {
  subject: 'Connect your WhatsApp',
  body: `Click here to connect: ${setupLink.data.url}`
});
```

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

### Quickstart: Create Chat bot with Kapso adapter

Source: https://docs.kapso.ai/docs/whatsapp/chat-sdk

Sets up a Chat instance with memory state and the Kapso adapter, then handles direct messages by echoing the text.

```javascript
import { Chat } from 'chat';
import { createMemoryState } from '@chat-adapter/state-memory';
import { createKapsoAdapter } from '@kapso/chat-adapter';

export const bot = new Chat({
  userName: 'support',
  state: createMemoryState(),
  adapters: {
    kapso: createKapsoAdapter(),
  },
});

bot.onDirectMessage(async (thread, message) => {
  await thread.post(`You said: ${message.text}`);
});

```

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

### List, get, create, health check, and resolve WhatsApp numbers

Source: https://docs.kapso.ai/docs/whatsapp/cli

Commands to manage WhatsApp numbers: list all numbers, get a specific number by phone or phone-number-id, start setup, check health, and resolve a number reference to its canonical ID. Most commands accept --phone-number or --phone-number-id.

```bash
# List all numbers
kapso whatsapp numbers list

# Get a specific number
kapso whatsapp numbers get "+1234567890"
kapso whatsapp numbers get --phone-number-id <meta-id>

# Start WhatsApp number setup
kapso whatsapp numbers new

# Health check
kapso whatsapp numbers health "+1234567890"

# Resolve a number reference to its canonical ID
kapso whatsapp numbers resolve "+1234567890"

```

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

### Quick example: create customer, generate setup link, send message

Source: https://docs.kapso.ai/docs/platform/customer-guide

Shows the core workflow: create a customer, generate a setup link, and send a WhatsApp message. Uses the Kapso API functions createCustomer, generateSetupLink, and sendWhatsAppMessage.

```javascript
// 1. Create customer
const customer = await createCustomer({ name: 'Acme Corp' });

// 2. Setup link
const setupLink = await generateSetupLink(customer.id);
console.log(`Setup link: ${setupLink.url}`);

// 3. Send message
await sendWhatsAppMessage({
  customer_id: customer.id,
  phone_number: '+1234567890',
  content: 'Order confirmed!'
});
```

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

### POST /platform/v1/customers/{CUSTOMER_ID}/setup_links

Source: https://docs.kapso.ai/docs/migrate/from-360dialog

Creates a setup link for a customer to connect their WhatsApp Business Account. The returned URL should be sent to the customer for onboarding.

```APIDOC
## POST /platform/v1/customers/{CUSTOMER_ID}/setup_links

### Description
Creates a setup link for a customer to connect their WhatsApp Business Account. The returned URL should be sent to the customer for onboarding.

### Method
POST

### Endpoint
https://api.kapso.ai/platform/v1/customers/{CUSTOMER_ID}/setup_links

### Parameters
#### Path Parameters
- **CUSTOMER_ID** (string) - Required - The ID of the customer created via POST /platform/v1/customers.

#### Request Body
- **setup_link** (object) - Required - Setup link object containing:
  - **success_redirect_url** (string) - Required - URL to redirect the customer after successful connection.
  - **meta_billing_mode** (string) - Required - Billing mode, e.g., "partner_managed".

### Request Example
```
curl -X POST https://api.kapso.ai/platform/v1/customers/CUSTOMER_ID/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "meta_billing_mode": "partner_managed"
    }
  }'
```

### Response
#### Success Response (200)
- **url** (string) - The setup link URL to send to the customer.

#### Response Example
(Not provided in source)
```

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

### POST /platform/v1/customers/{customer_id}/setup_links

Source: https://docs.kapso.ai/docs/platform/onboard-customers-own-meta-app

Creates a setup link for a customer. The returned URL can be sent to the customer or opened from your onboarding UI. Use allowed_connection_types to control the customer path.

```APIDOC
## POST /platform/v1/customers/{customer_id}/setup_links

### Description
Creates a setup link for a customer. The returned `url` can be sent to the customer or opened from your onboarding UI. Use `allowed_connection_types` to control the customer path.

### Method
POST

### Endpoint
https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links

### Parameters
#### Path Parameters
- **customer_id** (string) - Required - The ID of the customer.

#### Request Body
- **setup_link** (object) - Required - Setup link configuration:
  - **success_redirect_url** (string) - Required - URL to redirect after successful setup.
  - **failure_redirect_url** (string) - Required - URL to redirect after failed setup.
  - **meta_billing_mode** (string) - Required - Billing mode, e.g., "customer_managed".
  - **allowed_connection_types** (array of strings) - Required - Controls the customer path. Possible values: "dedicated", "coexistence", or both.
  - **provision_phone_number** (boolean) - Optional - If true, Kapso provisions a number during setup.
  - **phone_number_country_isos** (array of strings) - Optional - List of country ISO codes for provisioning, e.g., ["US"].

### Request Example
```
curl -X POST https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "failure_redirect_url": "https://your-app.com/whatsapp/failed",
      "meta_billing_mode": "customer_managed",
      "allowed_connection_types": ["dedicated"]
    }
  }'
```

### Response
#### Success Response
- **url** (string) - The setup link URL to send to the customer.

#### Response Example
No response example provided in the source.

```

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

### Go example to get message template by ID

Source: https://docs.kapso.ai/api/meta/whatsapp/templates/get-message-template-by-id

Go example using net/http to fetch a message template. It creates a GET request with the X-API-Key header and prints the response body.

```go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{business_account_id}/message_templates/{template_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### PHP cURL example

Source: https://docs.kapso.ai/api/meta/whatsapp/usernames/get-reserved-username-suggestions

PHP example using cURL to make the GET request.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username_suggestions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

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

### Kapso: Create a customer and generate a setup link

Source: https://docs.kapso.ai/docs/migrate/from-twilio

In multi-tenant setups, each customer connects their own number through a setup link. The first call creates a customer, and the second generates a setup link with a success redirect URL and partner-managed billing. Send the returned URL to the customer; they log in with Facebook and connect in about five minutes.

```bash
curl -X POST https://api.kapso.ai/platform/v1/customers \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer": {"name": "Acme Corporation", "external_customer_id": "CUS-12345"}}'

curl -X POST https://api.kapso.ai/platform/v1/customers/CUSTOMER_ID/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "meta_billing_mode": "partner_managed"
    }
  }'

```

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

### JavaScript fetch example

Source: https://docs.kapso.ai/api/meta/whatsapp/usernames/get-reserved-username-suggestions

JavaScript example using fetch to get username suggestions.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/username_suggestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### Create a setup link on your backend (JavaScript)

Source: https://docs.kapso.ai/docs/platform/tech-providers/embed-onboarding

Create a setup link using fetch. Return only data.token to your frontend.

```javascript
const res = await fetch(
  `https://api.kapso.ai/platform/v1/customers/${customerId}/setup_links`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      setup_link: {
        allowed_origins: ['https://app.example.com'],
        allowed_connection_types: ['dedicated'],
        meta_billing_mode: 'partner_managed'
      }
    })
  }
);

const { data } = await res.json();

```

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

### Create a setup link on your backend (cURL)

Source: https://docs.kapso.ai/docs/platform/tech-providers/embed-onboarding

Create a setup link with allowed origins and connection types. Keep your Kapso API key on the server.

```bash
curl -X POST https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "allowed_origins": ["https://app.example.com"],
      "allowed_connection_types": ["dedicated"],
      "meta_billing_mode": "partner_managed"
    }
  }'

```

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

### Java Unirest example to get message template by ID

Source: https://docs.kapso.ai/api/meta/whatsapp/templates/get-message-template-by-id

Java example using Unirest to fetch a message template. It sends a GET request with the X-API-Key header and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.kapso.ai/meta/whatsapp/v24.0/{business_account_id}/message_templates/{template_id}")
  .header("X-API-Key", "<api-key>")
  .asString();
```

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

### Create setup link prompt

Source: https://docs.kapso.ai/docs/whatsapp/mcp

Prompt to create a setup link for the default customer using the kapso setup_links tool with action=create.

```text
Use kapso setup_links with action=create for the default customer, then return the setup URL.

```

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

### Ruby example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses net/http to send a GET request. Requires an X-API-Key header.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

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

### JavaScript example for onboarding and messaging

Source: https://docs.kapso.ai/docs/platform/customer-guide

Provides async functions to create a customer, generate a setup link, and send a WhatsApp message using the Kapso AI APIs.

```javascript
const KAPSO_API_KEY = 'YOUR_API_KEY';
const PLATFORM_API_URL = 'https://api.kapso.ai/platform/v1';
const WHATSAPP_API_URL = 'https://api.kapso.ai/meta/whatsapp';

async function onboardCustomer(customerData) {
  // 1. Create customer
  const customer = await fetch(`${PLATFORM_API_URL}/customers`, {
    method: 'POST',
    headers: {
      'X-API-Key': KAPSO_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ customer: customerData })
  }).then(r => r.json());

  // 2. Generate setup link
  const setupLink = await fetch(
    `${PLATFORM_API_URL}/customers/${customer.data.id}/setup_links`,
    {
      method: 'POST',
      headers: {
        'X-API-Key': KAPSO_API_KEY,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        setup_link: { meta_billing_mode: 'partner_managed' }
      })
    }
  ).then(r => r.json());

  return setupLink.data.url;
}

async function sendMessage(phoneNumberId, recipientPhone, message) {
  return fetch(`${WHATSAPP_API_URL}/v24.0/${phoneNumberId}/messages`, {
    method: 'POST',
    headers: {
      'X-API-Key': KAPSO_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      messaging_product: 'whatsapp',
      to: recipientPhone,
      type: 'text',
      text: { body: message }
    })
  });
}
```

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

### Create a setup link with JavaScript

Source: https://docs.kapso.ai/docs/platform/setup-links/create-and-configure

Uses the Fetch API to POST the same setup link configuration to the Kapso API. The response is parsed as JSON and the data is extracted.

```javascript
const res = await fetch(
  `https://api.kapso.ai/platform/v1/customers/${customerId}/setup_links`,
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      setup_link: {
        success_redirect_url: 'https://your-app.com/whatsapp/success',
        failure_redirect_url: 'https://your-app.com/whatsapp/failed',
        allowed_origins: ['https://your-app.com'],
        meta_billing_mode: 'partner_managed'
      }
    })
  }
);

const { data } = await res.json();
```

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

### JavaScript fetch example for get conversation details

Source: https://docs.kapso.ai/api/meta/whatsapp/conversations/get-conversation-details

Uses fetch to make a GET request and logs the JSON response.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/conversations/{conversation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### Generate a setup link for a customer with curl

Source: https://docs.kapso.ai/docs/platform/onboard-customers-own-meta-app

Creates a setup link for a customer. Send the returned url to the customer or open it from your onboarding UI. Use allowed_connection_types to control the customer path: ["dedicated"] for API-only numbers, ["coexistence"] for keeping the WhatsApp Business App, or both for customer choice.

```bash
curl -X POST https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "failure_redirect_url": "https://your-app.com/whatsapp/failed",
      "meta_billing_mode": "customer_managed",
      "allowed_connection_types": ["dedicated"]
    }
  }'
```

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

### Successful response example for get conversation details

Source: https://docs.kapso.ai/api/meta/whatsapp/conversations/get-conversation-details

Example 200 response with conversation details including Kapso extensions.

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "phone_number": "15551234567",
  "status": "active",
  "last_active_at": "2024-01-15T14:30:00.000Z",
  "created_at": "2024-01-15T10:00:00.000Z",
  "updated_at": "2024-01-15T14:30:00.000Z",
  "whatsapp_config_id": "456e7890-a12b-34c5-d678-901234567890",
  "metadata": {
    "tags": [
      "vip",
      "priority"
    ],
    "customer_tier": "premium"
  },
  "phone_number_id": "110987654321",
  "kapso": {
    "contact_name": "John Doe",
    "messages_count": 15,
    "last_message_id": "wamid.HBgNMTU1NTE0OTU5Nzg1FQIAERgSMDhGRjdBMDEyOTcxQzFFQkFBAA==",
    "last_message_type": "text",
    "last_message_timestamp": "2024-01-15T14:30:00.000Z",
    "last_message_text": "Hello! I need help with my order",
    "last_inbound_at": "2024-01-15T14:30:00.000Z",
    "last_outbound_at": "2024-01-15T14:25:00.000Z"
  }
}
```

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

### GET /platform/v1/customers/{customer_id}/setup_links

Source: https://docs.kapso.ai/docs/platform/setup-links/manage

Lists all setup links for a specific customer. Requires an API key.

```APIDOC
## GET /platform/v1/customers/{customer_id}/setup_links

### Description
Fetches all setup links associated with a given customer.

### Method
GET

### Endpoint
`https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links`

### Parameters
#### Path Parameters
- **customer_id** (string) - Required - The unique identifier of the customer.

### Request Example
```bash
curl https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  -H "X-API-Key: YOUR_API_KEY"
```

### Response
#### Success Response (200)
Returns a list of setup links for the customer.

#### Response Example
(No explicit response example provided in the source.)
```

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

### Python requests example to get message by ID

Source: https://docs.kapso.ai/api/meta/whatsapp/messages/get-message-by-id

Uses the requests library to perform a GET request. Prints the response text.

```python
import requests

url = "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages/{message_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Create a customer and generate a setup link with curl

Source: https://docs.kapso.ai/docs/migrate/from-360dialog

Two curl commands: first creates a customer, second generates a setup link for that customer. Replace YOUR_API_KEY and CUSTOMER_ID with actual values. The returned url is sent to the customer for Facebook login and WhatsApp connection.

```bash
curl -X POST https://api.kapso.ai/platform/v1/customers \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer": {"name": "Acme Corporation", "external_customer_id": "CUS-12345"}}'
```

```bash
curl -X POST https://api.kapso.ai/platform/v1/customers/CUSTOMER_ID/setup_links \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "setup_link": {
      "success_redirect_url": "https://your-app.com/whatsapp/success",
      "meta_billing_mode": "partner_managed"
    }
  }'
```

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

### PHP cURL example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses PHP cURL to perform a GET request. Requires an X-API-Key header.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

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

### List all setup links with curl

Source: https://docs.kapso.ai/docs/platform/setup-links/manage

Fetches the complete list of setup links for a customer. Replace {customer_id} and YOUR_API_KEY with real values.

```bash
curl https://api.kapso.ai/platform/v1/customers/{customer_id}/setup_links \
  -H "X-API-Key: YOUR_API_KEY"

```

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

### JavaScript fetch example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses the fetch API to send a GET request. Requires an X-API-Key header.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### setup_links

Source: https://docs.kapso.ai/docs/whatsapp/mcp

Manage setup links with actions: help, list, create, update, revoke.

```APIDOC
## setup_links

### Description
Manage setup links.

### Actions
- `help`
- `list`
- `create`
- `update`
- `revoke`
```

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

### Python requests example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses the requests library to perform a GET request. Requires an X-API-Key header.

```python
import requests

url = "https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Python requests example for get conversation details

Source: https://docs.kapso.ai/api/meta/whatsapp/conversations/get-conversation-details

Uses the requests library to perform a GET request. Prints the response text.

```python
import requests

url = "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/conversations/{conversation_id}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### Go example to get message by ID

Source: https://docs.kapso.ai/api/meta/whatsapp/messages/get-message-by-id

Uses the net/http package to send a GET request with the X-API-Key header and prints the response body.

```go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages/{message_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

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

### JavaScript fetch example to get message by ID

Source: https://docs.kapso.ai/api/meta/whatsapp/messages/get-message-by-id

Uses the fetch API to make a GET request and logs the JSON response or error.

```javascript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/messages/{message_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

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

### Check setup status

Source: https://docs.kapso.ai/docs/whatsapp/cli

Displays full setup status.

```bash
kapso status
```

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

### Java Unirest example for get flow assets

Source: https://docs.kapso.ai/api/meta/whatsapp/flows/get-flow-assets

Uses the Unirest HTTP library to send a GET request. Requires an X-API-Key header.

```java
HttpResponse<String> response = Unirest.get("https://api.kapso.ai/meta/whatsapp/v24.0/{flow_id}/assets")
  .header("X-API-Key", "<api-key>")
  .asString();
```

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

### Go example

Source: https://docs.kapso.ai/api/meta/whatsapp/contacts/get-contact-details

Uses the net/http package to send a GET request with the X-API-Key header and prints the response body.

```go
package main

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

func main() {

	url := "https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/contacts/{wa_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```
Tokens:
Raw