Get chat account

$client->accounts->retrieve(string accountID): AccountGetResponse

GET/v1/accounts/{accountID}

Get one chat account connected to this Beeper Client API server.

ParametersExpand Collapse

accountID: string

Account ID this resource belongs to.

ReturnsExpand Collapse

AccountGetResponse

string accountID

Chat account added to Beeper. Use this to route account-scoped actions. Examples include matrix for Beeper/Matrix, discordgo for a cloud bridge, slackgo.TEAM-USER for workspace-scoped cloud bridges, and local-whatsapp_ba_… for local bridges.

AccountBridge bridge

Bridge metadata for the account. Available in Beeper Desktop v4.2.785+.

Status status

Current connection status for this account.

User user

User the account belongs to.

?Capabilities capabilities

Runtime bridgev2 room feature capabilities for this connected account, when available.

?string loginID

Bridge login ID for this account, when known. One bridge login can contain multiple chat accounts.

?string network

Human-friendly network name for the account. Omitted when the network is unknown.

?string statusText

Human-friendly account status text.

Get chat account

<?php

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

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

$account = $client->accounts->retrieve('accountID');

var_dump($account);

{
  "accountID": "accountID",
  "bridge": {
    "id": "id",
    "provider": "cloud",
    "type": "type"
  },
  "status": "connected",
  "user": {
    "id": "id",
    "cannotMessage": true,
    "email": "email",
    "fullName": "fullName",
    "imgURL": "imgURL",
    "isSelf": true,
    "phoneNumber": "phoneNumber",
    "username": "username"
  },
  "capabilities": {
    "allowed_reactions": [
      "string"
    ],
    "archive": true,
    "custom_emoji_reactions": true,
    "delete": -2,
    "delete_chat": true,
    "delete_chat_for_everyone": true,
    "delete_for_me": true,
    "delete_max_age": 0,
    "disappearing_timer": {
      "omit_empty_timer": true,
      "timers": [
        0
      ],
      "types": [
        "after_read"
      ]
    },
    "edit": -2,
    "edit_max_age": 0,
    "edit_max_count": 0,
    "file": {
      "foo": {
        "mime_types": {
          "foo": -2
        },
        "caption": -2,
        "max_caption_length": 0,
        "max_duration": 0,
        "max_height": 0,
        "max_size": 0,
        "max_width": 0,
        "view_once": true
      }
    },
    "formatting": {
      "foo": -2
    },
    "location_message": -2,
    "mark_as_unread": true,
    "max_text_length": 0,
    "member_actions": {
      "ban": -2,
      "invite": -2,
      "kick": -2,
      "leave": -2,
      "revoke_invite": -2
    },
    "message_request": {
      "accept_with_button": -2,
      "accept_with_message": -2
    },
    "poll": -2,
    "reaction": -2,
    "reaction_count": 0,
    "read_receipts": true,
    "reply": -2,
    "state": {
      "com.beeper.disappearing_timer": {
        "level": -2
      },
      "m.room.avatar": {
        "level": -2
      },
      "m.room.name": {
        "level": -2
      },
      "m.room.topic": {
        "level": -2
      }
    },
    "thread": -2,
    "typing_notifications": true
  },
  "loginID": "loginID",
  "network": "network",
  "statusText": "statusText"
}

Returns Examples

{
  "accountID": "accountID",
  "bridge": {
    "id": "id",
    "provider": "cloud",
    "type": "type"
  },
  "status": "connected",
  "user": {
    "id": "id",
    "cannotMessage": true,
    "email": "email",
    "fullName": "fullName",
    "imgURL": "imgURL",
    "isSelf": true,
    "phoneNumber": "phoneNumber",
    "username": "username"
  },
  "capabilities": {
    "allowed_reactions": [
      "string"
    ],
    "archive": true,
    "custom_emoji_reactions": true,
    "delete": -2,
    "delete_chat": true,
    "delete_chat_for_everyone": true,
    "delete_for_me": true,
    "delete_max_age": 0,
    "disappearing_timer": {
      "omit_empty_timer": true,
      "timers": [
        0
      ],
      "types": [
        "after_read"
      ]
    },
    "edit": -2,
    "edit_max_age": 0,
    "edit_max_count": 0,
    "file": {
      "foo": {
        "mime_types": {
          "foo": -2
        },
        "caption": -2,
        "max_caption_length": 0,
        "max_duration": 0,
        "max_height": 0,
        "max_size": 0,
        "max_width": 0,
        "view_once": true
      }
    },
    "formatting": {
      "foo": -2
    },
    "location_message": -2,
    "mark_as_unread": true,
    "max_text_length": 0,
    "member_actions": {
      "ban": -2,
      "invite": -2,
      "kick": -2,
      "leave": -2,
      "revoke_invite": -2
    },
    "message_request": {
      "accept_with_button": -2,
      "accept_with_message": -2
    },
    "poll": -2,
    "reaction": -2,
    "reaction_count": 0,
    "read_receipts": true,
    "reply": -2,
    "state": {
      "com.beeper.disappearing_timer": {
        "level": -2
      },
      "m.room.avatar": {
        "level": -2
      },
      "m.room.name": {
        "level": -2
      },
      "m.room.topic": {
        "level": -2
      }
    },
    "thread": -2,
    "typing_notifications": true
  },
  "loginID": "loginID",
  "network": "network",
  "statusText": "statusText"
}