Bot이 포함된 대화방 생성
Bot이 포함된 대화방을 생성한다.
Bot이 생성된 후에 대화방 ID를 획득할 수 있다.
이를 이용하여 메시지를 전송하거나 Bot이 소속된 대화방 구성원 목록을 조회할 수 있다.
API 종류
서버 API
Request URL
https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/room
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
파라미터 | 필수 여부 | 설명 |
---|---|---|
botNo | Y | 대화방을 생성할 메시지 Bot 번호 |
Request
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accountIds | array |
Y | 대화방에 참여할 구성원 목록 |
title | string | N | 대화방 이름 지정 최대 글자수: 1000 |
Request Example
simple
POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/room
{
"accountIds": ["user1@example.com", "user2@example.com"]
}
detail
POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/room
{
"accountIds": ["user1@example.com", "user2@example.com"],
"title": "my title"
}
Response
호출에 성공하면 HTTP 상태 코드 200과 함께 생성된 대화방 ID가 응답으로 반환된다.
속성 | 타입 | 설명 |
---|---|---|
channelId | string | 생성된 대화방 ID |
Response Example
{
"channelId": "12345a12-b12c-12d3-e123fghijkl"
}
Error Code
호출에 실패하면 오류 코드와 오류 메시지를 반환한다.
오류 코드는 메시지 Bot REST API 오류 코드를 참고한다.