Skip to content
Beeper Developer Docs
Download Beeper
API Reference
Bridges

Get bridge capabilities

client.bridges.retrieveCapabilities(stringbridgeID, RequestOptionsoptions?): ProvisioningCapabilities { group_creation, resolve_identifier, image_pack_import }
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.

minLength1
ReturnsExpand Collapse
ProvisioningCapabilities { group_creation, resolve_identifier, image_pack_import }

Advanced network capabilities for account lookup and group creation.

group_creation: Record<string, GroupTypeCapabilities { type_description, avatar, disappear, 5 more } >
type_description: string
avatar?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
disappear?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
name?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
parent?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
participants?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
topic?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
username?: GroupFieldCapability { allowed, max_length, min_length, 2 more }

Group creation field capability.

allowed: boolean
max_length?: number
min_length?: number
required?: boolean
settings?: DisappearingTimerCapability { types, omit_empty_timer, timers }

Disappearing-message timer capability.

types: Array<"" | "after_read" | "after_send">
One of the following:
""
"after_read"
"after_send"
omit_empty_timer?: true
timers?: Array<number>
resolve_identifier: ResolveIdentifierCapabilities { any_phone, contact_list, create_dm, 4 more }

Identifier lookup capabilities for this bridge.

any_phone: boolean
contact_list: boolean
create_dm: boolean
lookup_email: boolean
lookup_phone: boolean
lookup_username: boolean
image_pack_import?: boolean

Get bridge capabilities

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

const provisioningCapabilities = await client.bridges.retrieveCapabilities('local-whatsapp');

console.log(provisioningCapabilities.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
}