Lalexi
APIСправочникChannels

Get a channel

One channel, hidden ones included. A channel you do not work in answers 404 not_found.

GET
/channels/{id}

Authorization

personalToken
AuthorizationBearer <token>

Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.

In: header

Path Parameters

id*integer

The channel's id.

Header Parameters

X-Workspace-Id?integer

The workspace to work in (an id from GET /me). Optional when you belong to a single workspace; required otherwise (400 workspace_required).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.lalexi.com/v1/channels/0" \  -H "X-Workspace-Id: 7"
{
  "id": 0,
  "name": "string",
  "type": "whatsapp",
  "status": "connected",
  "connected_by": {
    "id": 0,
    "name": "string"
  },
  "note": "string",
  "hidden": true,
  "capabilities": {
    "can_start_dialog": true,
    "reply_only": true,
    "attachments": true,
    "chat_list": true,
    "broadcasts": true
  },
  "created_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "workspace_required",
    "message": "You belong to several workspaces: pass the X-Workspace-Id header."
  }
}
{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is missing or invalid."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "You are not allowed to do this."
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the number of seconds in Retry-After."
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}