listMembers

POST 
https://yuchat.ai/public/v1/member.list

получение списка участников воркспейса

Request

application/json

Bodyrequired

workspaceIdstringrequired

id воркспейса

Responses

200

список участников

application/json

Schema

Schema

members object[]
Array [
memberIdstring
profile object
информация о профиле участника
profileIdstring
primaryEmailstring
fullNamestring
typeAccountType (string)
тип аккаунта
Possible values: [REGULAR, BOT, VOICE_BOT, INTEGRATION_BOT, GUEST_ACCOUNT]
Example: REGULAR
details object
дополнительная информация о пользователе
positionstring
departmentstring
phoneNumberstring
locationAccountLocation (string)
статус участника
Possible values: [LOCATION_NOT_SET, OFFICE, HOME, VACATION]
roleTypeMemberRoleType (string)
роль участника воркспейса
Possible values: [MEMBER, ADMIN, OWNER, GUEST, GUEST_CALLER]
presence object
isOnlineboolean
isOnCallboolean
lastSeenAtdate-time
statusMemberStatus (string)
статус участника
Possible values: [PENDING, ACTIVE, SUSPENDED]
]

Example (auto)

{
  "members": [
    {
      "memberId": "string",
      "profile": {
        "profileId": "string",
        "primaryEmail": "string",
        "fullName": "string",
        "type": "REGULAR",
        "details": {
          "position": "string",
          "department": "string",
          "phoneNumber": "string",
          "location": "LOCATION_NOT_SET"
        }
      },
      "roleType": "MEMBER",
      "presence": {
        "isOnline": true,
        "isOnCall": true,
        "lastSeenAt": "2024-07-29T15:51:28.071Z"
      },
      "status": "PENDING"
    }
  ]
}

401

Ошибка авторизации, токен не передан или неверный

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWTdescription: Токен, который можно получить от aibot@yuchat.ai с помощью команды /botcreate.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://yuchat.ai/public/v1/member.list");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"workspaceId\": \"w67Y89gu\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://yuchat.ai

Auth

Bearer Token

Body required

{
  "workspaceId": "w67Y89gu"
}

ResponseClear

Click the Send API Request button above and see the response here!