아웃바운드 콜 지원 API
개요
아웃바운드 콜 지원 API는 사용자의 아웃바운드 콜에 대한 정보를 조회, 수정하는 기능을 제공합니다.
주요기능
- 환자의 Outbound Call 저장: 환자의 Oubound Call 일차를 저장합니다.
- 환자의 Outbound Call 변경: 환자의 Outbound Call 상태를 변경합니다.
[POST] /v2/users/{userId}/support/outbound - 환자의 Outbound Call 저장
환자의 Outbound Call 저장
환자의 Oubound Call 일차를 저장합니다.
- HTTP Method:
POST - 인증: 액세스 토큰 (
accessToken) 필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Authorization | Bearer {accessToken} | 사용자 인증을 통해 발급받은 액세스 토큰 입니다. | ✔ |
Request Body
N/A
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
201 Created | 성공 | - |
401 Unauthorized | 인증실패 | - |
500 Internal Server Error | 서버 내부 오류 | - |
201 Created - 성공
401 Unauthorized - 인증 실패
예시: 토큰이 누락된 경우
{
"status": 401,
"code": 40400,
"message": "Unauthorized",
"detail": ""
}
500 Internal Server Error - 서버 내부 오류
예시: 일반 서버 오류
{
"status": 500,
"code": 40400,
"message": "SERVER_ERROR",
"detail": ""
}
[PATCH] /v2/users/{userId}/support/outbound - 환자의 Outbound Call 변경
환자의 Outbound Call 수정
환자의 Oubound Call 일차를 수정합니다.
- HTTP Method:
PATCH - 인증: 액세스 토큰 (
accessToken) 필요
Headers
| Header | Type | Description | Required |
|---|---|---|---|
| Authorization | Bearer {accessToken} | 사용자 인증을 통해 발급받은 액세스 토큰 입니다. | ✔ |
Request Body
| Field | Type | Description | Required | Validation |
|---|---|---|---|---|
| status | string | 아웃바운드 콜 상태 | ✔ | Enum: Pending, Completed, Skipped |
| callSchedule | number | 아웃바운드 일정 | ✔ | - |
Responses
| Http Status Code | 설명 | Error Code(s) |
|---|---|---|
200 Ok | 성공 | - |
401 Unauthorized | 인증실패 | - |
404 Not Found | 찾을 수 없을 | - |
500 Internal Server Error | 서버 내부 오류 | - |
200 Ok - 성공
401 Unauthorized - 인증 실패
예시: 토큰이 누락된 경우
{
"status": 401,
"code": 40400,
"message": "Unauthorized",
"detail": ""
}
404 Not Found - 찾을 수 없음
예시: 사용자를 찾을 수 없음
{
"status": 404,
"code": 40400,
"message": "User Not Found",
"detail": ""
}
500 Internal Server Error - 서버 내부 오류
예시: 일반 서버 오류
{
"status": 500,
"code": 40400,
"message": "SERVER_ERROR",
"detail": ""
}