List paired channels

/v1/channels

The chats you paired per channel (Telegram, WhatsApp, Discord, Teams); targets[].sender_id is what POST /v1/workflows/{id}/bindings takes.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Response

Paired devices per channel Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

channelsobject

invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os
import requests

response = requests.get(
    "https://api.plungeai.com/v1/channels",
    headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"},
)
if not response.ok:
    raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}")
print(response.json())

const response = await fetch('https://api.plungeai.com/v1/channels', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`)
console.log(await response.json())

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

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.plungeai.com/v1/channels"))
            .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse(""));
            return;
        }
        System.out.println(response.body());
    }
}

curl 'https://api.plungeai.com/v1/channels' \
  -H "Authorization: Bearer $PLUNGE_API_KEY"

Example generated from schema

{
  "channels": {}
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

Example generated from schema

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "connect": {
      "provider": "<string>",
      "method": "oauth",
      "link": "POST /v1/connections/stripe/link"
    }
  }
}

List paired channels

Authorizations

Response

Planned: TI-33

Planned: TI-34