3.1개요
U Connect 테넌트 자원 생성 및 자원 삭제를 위한 API 정의 이다.
API는 http/https 프로토콜을 사용하며, GET, POST, DELETE method를 사용합니다.
request , response는 JSON String 형태로 전달됩니다.
3.1.1설명
그림 3-1U Connect 시스템 구성도
3.1.2지원 목록
테넌트 자원 생성(미지원- 추후지원예정)
테넌트 자원 삭제
3.1.3선결 과제
U Connect 2.0 이상 버전이 설치되어 있어야 한다.
3.2API
3.2.1자원 삭제
3.2.1.1U-PBX 자원 삭제
내선 자원 삭제
트런크 자원 삭제
채팅 내역 삭제
통화 내역 삭제
기타 사용자 정보 삭제
녹취 관련 데이터 삭제는 추후 API 가 제공될 예정입니다.
POST /pbx/resource/delete
- [Header]
Authorization: Bearer 토큰
- [Parameter]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_id | text | Y | tenant_id 값 ex) "tenant_id": "test5" |
mode | text | N | 기본값(없음), 추후 삭제 범위에 대한 항목으로 사용예정 |
- [SAMPLE]
curl -X POST -H "Content-type: application/json" \
-d \
'{"tenant_id":"test"}' \
http://127.0.0.1/pbx/resource/delete* 응답
- [Response]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
code | text | Y | 응답코드 (성공: 200, 실패 : 200외) |
message | text | N | 응답메시지 |
* 응답(성공)
{
"code":"200",
"message":"OK"
}* 응답(실패)
{
"code":"404",
"message":"Tenant not found."
}3.2.1.2U-CTI 자원 삭제
POST /cube/resource/delete
- [Header]
Authorization: Bearer 토큰
- [Parameter]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_id | text | Y | tenant_id 값 ex) "tenant_id": "test5" |
mode | text | N | 기본값(없음), 추후 삭제 범위에 대한 항목으로 사용예정 |
- [SAMPLE]
curl -X POST -H "Content-type: application/json" \
-d \
'{"tenant_id":"test"}' \
http://127.0.0.1/cube/resource/delete* 응답
- [Response]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
code | text | Y | 응답코드 (성공: 200, 실패 : 200외) |
message | text | N | 응답메시지 |
* 응답(성공)
{
"code":"200",
"message":"OK"
}* 응답(실패)
{
"code":"404",
"message":"Tenant not found."
}3.2.1.3U-IVR 자원 삭제
POST /ivr/resource/delete
- [Header]
Authorization: Bearer 토큰
- [Parameter]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_id | text | Y | tenant_id 값 ex) "tenant_id": "test5" |
mode | text | N | 기본값(없음), 추후 삭제 범위에 대한 항목으로 사용예정 |
- [SAMPLE]
curl -X POST -H "Content-type: application/json" \
-d \
'{"tenant_id":"test"}' \
http://127.0.0.1/ivr/resource/delete* 응답
- [Response]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
code | text | Y | 응답코드 (성공: 200, 실패 : 200외) |
message | text | N | 응답메시지 |
* 응답(성공)
{
"code":"200",
"message":"OK"
}* 응답(실패)
{
"code":"404",
"message":"Tenant not found."
}3.2.1.4U-Biztalk 자원 삭제
POST /biztalk/resource/delete
- [Header]
Authorization: Bearer 토큰
- [Parameter]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_id | text | Y | tenant_id 값 ex) "tenant_id": "test5" |
mode | text | N | 기본값(없음), 추후 삭제 범위에 대한 항목으로 사용예정 |
- [SAMPLE]
curl -X POST -H "Content-type: application/json" \
-d \
'{"tenant_id":"test"}' \
http://127.0.0.1/biztalk/resource/delete* 응답
- [Response]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
code | text | Y | 응답코드 (성공: 200, 실패 : 200외) |
message | text | N | 응답메시지 |
* 응답(성공)
{
"code":"200",
"message":"OK"
}* 응답(실패)
{
"code":"404",
"message":"Tenant not found."
}3.3코드 정의
3.3.1결과 코드
code | message | 설명 |
|---|---|---|
200 | OK | 정상코드 |
400 | Bad Request | 요청실패 |
401 | UnauthorizedException | 인증 실패 |
403 | Forbidden | 접근거부 |
404 | Not found | 찾기 실패 |
500 | Internal Server Error | |
600 | FailedToSendMessageException | 메시지 전송 실패 |
601 | InternalSystemErrorException | 내부 시스템 에러 |