Classic/VPC 환경에서 이용 가능합니다.
여러 사용자를 대상으로 한 번에 친구 요청을 전송합니다. 요청을 수신한 사용자들은 알림을 통해 요청 내역을 확인할 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /v1/api/v1/api/friendship/bulk |
요청 헤더
Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
userId |
String | Required | 사용자 아이디
|
friendId |
String | Required | 친구 아이디
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/bulk' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '[
{
"userId": "guestID2",
"friendId": "osoriz123"
},
{
"userId": "guestID2",
"friendId": "NCP007"
}
]'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
message |
String | - | 응답 메시지 |
응답 상태 코드
Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"message": "Friends added successfully"
}