API Reference

Bridges

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get bridge capabilities

$client->bridges->retrieveCapabilities(string bridgeID): ProvisioningCapabilities

GET/v1/bridges/{bridgeID}/capabilities

Get advanced network capabilities for a bridge. This endpoint is intended for clients that build custom connect or chat-creation flows.

ParametersExpand Collapse

bridgeID: string

Bridge ID.

ReturnsExpand Collapse

ProvisioningCapabilities

array<string,GroupTypeCapabilities> groupCreation

ResolveIdentifierCapabilities resolveIdentifier

Identifier lookup capabilities for this bridge.

?bool imagePackImport

Get bridge capabilities

PHP

HTTP

TypeScript

Python

Go

CLI Tool

PHP

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$provisioningCapabilities = $client->bridges->retrieveCapabilities(
  'local-whatsapp'
);

var_dump($provisioningCapabilities);

200 example

{
  "group_creation": {
    "foo": {
      "type_description": "type_description",
      "avatar": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "disappear": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "name": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "parent": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "participants": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "topic": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "username": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      }
    }
  },
  "resolve_identifier": {
    "any_phone": true,
    "contact_list": true,
    "create_dm": true,
    "lookup_email": true,
    "lookup_phone": true,
    "lookup_username": true,
    "search": true
  },
  "image_pack_import": true
}

Returns Examples

200 example

{
  "group_creation": {
    "foo": {
      "type_description": "type_description",
      "avatar": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "disappear": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "name": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "parent": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "participants": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "topic": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      },
      "username": {
        "allowed": true,
        "max_length": 0,
        "min_length": 0,
        "required": true,
        "settings": {
          "types": [
            ""
          ],
          "omit_empty_timer": true,
          "timers": [
            0
          ]
        }
      }
    }
  },
  "resolve_identifier": {
    "any_phone": true,
    "contact_list": true,
    "create_dm": true,
    "lookup_email": true,
    "lookup_phone": true,
    "lookup_username": true,
    "search": true
  },
  "image_pack_import": true
}