Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Bridges

Get bridge capabilities

bridges.retrieve_capabilities(strbridge_id) -> 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
bridge_id: str

Bridge ID.

minLength1
ReturnsExpand Collapse
class ProvisioningCapabilities: …

Advanced network capabilities for account lookup and group creation.

group_creation: Dict[str, GroupTypeCapabilities]
type_description: str
avatar: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
disappear: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
name: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
parent: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
participants: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
topic: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
username: Optional[GroupFieldCapability]

Group creation field capability.

allowed: bool
max_length: Optional[int]
min_length: Optional[int]
required: Optional[bool]
settings: Optional[DisappearingTimerCapability]

Disappearing-message timer capability.

types: List[Literal["", "after_read", "after_send"]]
One of the following:
""
"after_read"
"after_send"
omit_empty_timer: Optional[Literal[true]]
timers: Optional[List[int]]
resolve_identifier: ResolveIdentifierCapabilities

Identifier lookup capabilities for this bridge.

any_phone: bool
contact_list: bool
create_dm: bool
lookup_email: bool
lookup_phone: bool
lookup_username: bool
image_pack_import: Optional[bool]

Get bridge capabilities

import os
from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
)
provisioning_capabilities = client.bridges.retrieve_capabilities(
    "local-whatsapp",
)
print(provisioning_capabilities.resolve_identifier)
{
  "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
{
  "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
}