Agent(AI) 통화를 종료하도록 콜브릿지 통화 시스템(PBX)에 요청하는 API입니다.
1. API 개요
이 API는 진행 중인 Agent(AI) 통화를 종료 요청합니다.처리 과정
1.
요청된 통화 정보 검증
2.
PBX 서버로 Agent 통화 종료 요청 전달
3.
종료 요청 처리
4.
처리 결과 반환
2. 사전 조건 / 권한
이 API를 사용하기 위해 다음 조건이 필요합니다.
•
콜브릿지(Call Bridge) 계정 생성
•
API Access Token 발급
3. API 정보
Method / Endpoint
Header
이름 | 타입 | 필수 | 기본값 | 설명 |
Authorization | string | O | Bearer {ACCESS_TOKEN} 형식으로 전달 | |
Content-Type | string | O | application/json |
4. Request
Request Body
이름 | 타입 | 필수 | 기본값 | 설명 |
ivrIp | String | O | - | IVR 서버 주소 (IP:Port) |
id | String | O | - | 콜브릿지 통화 시스템에서 발급된 통화 고유 ID (UUID) |
cdrId | String | O | - | 통화 CDR ID |
callerNo | String | O | - | 발신자 번호 (caller) |
calleeNo | String | O | - | 수신자 전화번호 (caller) |
actionId | String | O | - | agent ID |
ment | String | O | - | 통화 종료 시 재생할 안내 멘트 |
Request Example
cURL
curl -X POST "https://bnd.happytalk.io/api/openapi/calls/agent-terminate" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ivrIp": "192.168.150.103:29034",
"id": "20240411133800001",
"cdrId": "10012918",
"callerNo": "01012345678",
"calleeNo": "07042379689",
"actionId": "1.755065124269E9",
"ment": "카라 AI서비스를 종료합니다. 이용해 주셔서 감사합니다."
}'
JavaScript
복사
5. Response
Response 정보
•
Status Code: 200 OK
•
Content-Type: application/json
Response Body Example
json
{
"code": "OK",
"timestamp": 1735437506000,
"message": "Agent 호종료 요청이 완료되었습니다",
"data": {
"id": "20240411133800001",
"siteId": "921004320891",
"cdrId": "10012918",
"callerNo": "01012345678",
"calleeNo": "07042379689",
"actionId": "1755065124.269",
"requestedAt": "2025-01-28 15:30:00"
}
}
JavaScript
복사
Resonse Field명
이름 | 타입 | 필수 | 기본값 | 설명 |
code | String | O | - | 응답 코드 |
timestamp | Long | O | - | 응답 시각 (Unix timestamp) |
message | String | X | - | 응답 메시지 |
data | Object | O | - | Agent 통화 종료 요청 결과 |
data
이름 | 타입 | 필수 | 기본값 | 설명 |
id | String | O | - | 콜브릿지 통화 시스템 통화 고유 ID(UUID) |
siteId | String | O | - | 사이트 ID |
cdrId | String | O | - | 통화 CDR ID |
callerNo | String | O | - | 발신자 전화번호 |
calleeNo | String | O | - | 수신자 전화번호 |
actionId | String | O | - | agent ID |
requestedAt | String | O | - | 요청 시각 (YYYY-MM-DD HH:mm:ss) |
6. 에러 / 예외처리
오류 응답 본문의 “code"와 "message" 속성에서 오류에 대한 더 구체적인 세부 정보를 확인할 수 있습니다.
HTTP 상태명 | Error Code | Message | 설명 |
400 Bad Request | BAD_REQUEST | CDR ID 형식이 올바르지 않습니다 | CDR ID 형식 오류 |
401 Unauthorized | UNAUTHORIZED | Invalid credentials | API Key 미전송 또는 인증 실패 |
500 Internal Server Error | INTERNAL_SERVER_ERROR | PBX 서버 통신에 실패했습니다 | 콜브릿지 통화 시스템 통신 오류 |