This API will soon be deprecated. Please use another API.

    Get Members of the Chatroom with a Bot

    Gets a list of members of the chatroom which a bot belongs to.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/{API ID}/message/getRoomMemberList

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Request

    Parameter Type Required Description
    botNo number Y Message bot number to get the chatroom
    roomId string Y Room ID to get the chatroom
    page number N Page number. If you cannot get all members at once, specify this parameter to get additional arrays containing the members that belong to the chatroom.

    Request Example

    {
      "botNo": 123,
      "roomId": "123456",
      "page": 2
    }
    

    Response

    It returns code 200 when the API call is successful. You can get members using accountIdList, which returns up to 100 elements. If the number of members is large, use totalPage to get the members of another page.

    Property Type Description
    code number ● 200: Success
    ● 4xx: Client request errors
    ● 5xx: Unexpected errors and server internal errors
    message string Description about the code
    accountIdList array<string> Array that contains members of the chatroom.
    totalPage number Total number of pages

    Response Example

    {
      "code": 200,
      "message": "OK",
      "accountIdList": ["user1@example.com", "user2@example.com"],
      "totalPage":2
    }