그룹 채널 목록 조회
GET /v1/group/channels
Parameters
| 속성 | 설명 | 유형 | 기본값 | 필수여부 |
|---|---|---|---|---|
| limit | 페이지 당 목록 수, 허용 범위 5 ~ 30 | Number | 15 | X |
| name | 검색할 채널 이름(URL 인코딩 권장) | String | 없음 | X |
| include_members | 참가자 검색 목록. 콤마(,)로 구분된 사용자 ID 문자열(공백 허용 안함)로 참가자들이 포함된 채널을 검색합니다. AND 조건입니다. (URL 인코딩 권장) | String | 없음 | X |
| base_channel_id | 검색의 기준점이 되는 채널 ID | String | 없음 | X |
| show_managers | 채널 참가자 정보 포함 여부 | Boolean | false | X |
| show_members | 채널 매니저 정보 포함 여부 | Boolean | false | X |
| show_unread | 사용자별 읽지않은 메시지 수 정보 포함 여부 | Boolean | false | X |
| show_last_message | 채널 마지막 메시지 정보 포함 여부 | Boolean | false | X |
| show_delivery_receipt | 채널 배달 영수증 정보 포함 여부 | Boolean | false | X |
| show_read_receipt | 채널 읽기 영수증 정보 포함 여부 | Boolean | false | X |
Request
/v1/group/channels?show_delivery_receipt=true&show_read_receipt&show_managers=true
/v1/group/channels?include_members=user_1,user_2
Response
200 success
[
{
"channel_id": "Channel ID",
"name": "Channel Name",
"profile_url": "Channel Profile URL",
"type": "group",
"freeze": false,
"total_message_count": 0,
"total_file_count": 0,
"unread": {
"user_1": 0,
"user_2": 0,
...
},
"members": [
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917,
"joined_at": 1658977173917
},
...
],
"managers": [
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917,
"joined_at": 1658977173917
},
...
],
"read_receipt": {
"user_1": 1658977173917,
"user_2": 1658977173917,
...
},
"delivery_receipt": {
"user_1": 1658977173917,
"user_2": 1658977173917,
...
},
"meta": {
"key": "value",
...
},
"last_message": {
"message_id": "Message ID",
"channel_id": "Channel ID",
"user": {
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
},
"type": "text",
"content": "Message Content",
"file": {
"type": "file mime type",
"name": "file name",
"url": "file url",
"size": "file size"
},
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
},
"created_at": 1658977173917,
"updated_at": 1658977173917
}
...
]
그룹 채널 정보
특정 그룹 채널을 조회 할 수 있습니다.
GET /v1/group/channels/{channel_id}
Parameters
| 속성 | 설명 | 유형 | 필수여부 |
|---|---|---|---|
| channel_id | 채널 아이디 | String | O |
Parameters
| 속성 | 설명 | 유형 | 기본값 | 필수여부 |
|---|---|---|---|---|
| show_managers | 채널 참가자 정보 포함 여부 | Boolean | false | X |
| show_members | 채널 매니저 정보 포함 여부 | Boolean | false | X |
| show_unread | 사용자별 읽지않은 메시지 수 정보 포함 여부 | Boolean | false | X |
| show_last_message | 채널 마지막 메시지 정보 포함 여부 | Boolean | false | X |
| show_delivery_receipt | 채널 배달 영수증 정보 포함 여부 | Boolean | false | X |
| show_read_receipt | 채널 읽기 영수증 정보 포함 여부 | Boolean | false | X |
Response
200 success
{
"channel_id": "Channel ID",
"name": "Channel Name",
"profile_url": "Channel Profile URL",
"type": "group",
"freeze": false,
"total_message_count": 0,
"total_file_count": 0,
"unread": {
"user_1": 0,
"user_2": 0,
...
},
"members": [
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917,
"joined_at": 1658977173917
},
...
],
"managers": [
{
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917,
"joined_at": 1658977173917
},
...
],
"read_receipt": {
"user_1": 1658977173917,
"user_2": 1658977173917,
...
},
"delivery_receipt": {
"user_1": 1658977173917,
"user_2": 1658977173917,
...
},
"meta": {
"key": "value",
...
},
"last_message": {
"message_id": "Message ID",
"channel_id": "Channel ID",
"user": {
"user_id": "User ID",
"name": "User Name",
"profile_url": "User Profile URL",
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
},
"type": "text",
"content": "Message Content",
"file": {
"type": "file mime type",
"name": "file name",
"url": "file url",
"size": "file size"
},
"meta": {
"key": "value",
...
},
"created_at": 1658977173917,
"updated_at": 1658977173917
},
"created_at": 1658977173917,
"updated_at": 1658977173917
}