Get bot information | Sample

2 parameters

tokenstringrequired

Authentication token for the request; the required scope is `users:read`.

botstringoptional

Bot user identifier for the bot whose information to retrieve.

2 status codes

200Returns `ok` set to true and a `bot` object containing the bot's `id`, deletion state, `name`, update timestamp, `app_id`, and `icons`.

botobjectrequired

okbooleanrequired

Allowed:true

defaultReturned when no bot can be found or authentication, authorization, or request validation fails; the response contains `ok` set to false and an `error` value.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:bot_not_foundnot_authedinvalid_authaccount_inactivetoken_revokedno_permissionorg_login_requiredinvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_type

okbooleanrequired

Allowed:false

Error handling

token must be a valid authentication token with the users:read scope. When supplied, bot must identify an existing bot user.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.botsInfo.list({
  token: "sk_live_4eC39Hq",
  bot: "example",
});

{
  "bot": {
    "app_id": "A161CLERW",
    "deleted": false,
    "icons": {
      "image_36": "https://...",
      "image_48": "https://...",
      "image_72": "https://..."
    },
    "id": "B061F7JD2",
    "name": "beforebot",
    "updated": 1449272004,
    "user_id": "U012ABCDEF"
  },
  "ok": true
}

Request

Response

Errors