List WhatsApp configs for a customer

curl --request GET \
  --url https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs"

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

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

print(response.text)

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

fetch('https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs",
  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;
}

package main

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

func main() {

	url := "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs")

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

{
  "data": [
    {
      "id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
      "name": "Client WhatsApp",
      "display_name": "Client WhatsApp (+1234567890)",
      "phone_number_id": "1234567890",
      "business_account_id": "98765432109",
      "display_phone_number": "+56 9 61461262",
      "display_phone_number_normalized": "56961461262",
      "webhook_verify_token": "<string>",
      "webhook_destination_url": "<string>",
      "customer_id": "3f2e1d0c-9b8a-7f6e-5d4c-3b2a1f0e9d8c",
      "inbound_processing_enabled": true,
      "calls_enabled": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

GET

customers

{customer_id}

whatsapp_configs

List WhatsApp configs for a customer

curl --request GET \
  --url https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs"

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

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

print(response.text)

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

fetch('https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs",
  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;
}

package main

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

func main() {

	url := "https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/customers/{customer_id}/whatsapp_configs")

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

{
  "data": [
    {
      "id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
      "name": "Client WhatsApp",
      "display_name": "Client WhatsApp (+1234567890)",
      "phone_number_id": "1234567890",
      "business_account_id": "98765432109",
      "display_phone_number": "+56 9 61461262",
      "display_phone_number_normalized": "56961461262",
      "webhook_verify_token": "<string>",
      "webhook_destination_url": "<string>",
      "customer_id": "3f2e1d0c-9b8a-7f6e-5d4c-3b2a1f0e9d8c",
      "inbound_processing_enabled": true,
      "calls_enabled": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

{
  "error": "Resource not found"
}

{
  "error": "Resource not found"
}

Authorizations

X-API-Key

string

header

required

Your project API key

Path Parameters

customer_id

string

required

Query Parameters

page

integer

default:1

per_page

integer

default:20

business_account_id

string

Filter by WhatsApp Business Account ID

q[business_account_id_eq]

string

Filter by exact WhatsApp Business Account ID (Ransack syntax)

q[name_cont]

string

Filter by name containing string

q[created_at_gteq]

string<date-time>

Filter by created date >= (ISO 8601 format)

q[created_at_lteq]

string<date-time>

Filter by created date <= (ISO 8601 format)

Response

A list of WhatsApp configurations

data

object[]

Show child attributes

Customers

WhatsApp Display Names

Setup Links

WhatsApp Webhooks

WhatsApp Configs

WhatsApp Broadcasts

List WhatsApp configs for a customer

Authorizations

Path Parameters

Query Parameters

Response