채팅 플랫폼 API 엔드포인트

채팅 플랫폼 API 엔드포인트는 채팅 객체에 대한 액세스를 제공합니다. Contact Center AI Platform (CCAI Platform)으로 주고받는 모든 채팅에 대해 chat 객체가 생성됩니다.

채팅 플랫폼 API 엔드포인트는 다음과 같습니다.

채팅 객체

CCAI Platform의 모든 모바일 및 웹 채팅 세션에 대해 채팅 객체가 생성됩니다. 다음은 채팅 객체입니다.

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

채팅 업데이트

매개변수 필수 데이터 유형 정의
id TRUE 정수 업데이트할 채팅 ID

엔드포인트:

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id

헤더:

키 값 설명
Content-Type application/json
수락 application/json

본문:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "string",
        "escalation_id": "integer"
    }
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅 업데이트

이 예시에서는 기존 채팅이 성공적으로 업데이트되었음을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
id 정수 (필수)

본문:

{
    "finished_by_user_id": "integer",
    "chat": {
        "deflection_channel": "string",
        "status": "finished",
        "escalation_id": "integer"
    }
}
응답
{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

상태 코드: 200

채팅에서 메시지 보내기

이 메서드는 기존 채팅 세션에서 메시지를 보낼 수 있는 기능을 제공합니다.

매개변수 필수 데이터 유형 정의
id TRUE 정수 메시지를 전송할 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:id/message

헤더:

키 값 설명
Content-Type application/json

본문:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": "string"
            }
    }
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

메시지 전송 성공

이 예에서는 기존 채팅 세션에 메시지를 성공적으로 제출하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
id 정수 (필수)

본문:

{
    "from_user_id": integer,
    "message": {
            "type": "string",
            "content": : "string"
            }
    }
}
응답
{
}

상태 코드: 200

가상 에이전트 채팅 에스컬레이션

가상 에이전트의 채팅을 상담사에게 에스컬레이션합니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 에스컬레이션에 필요한 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations

헤더:

키 값 설명
Content-Type application/json
수락 application/json

본문:

{
    "reason": "string",
    "force_escalate": "boolean"
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅 에스컬레이션 성공

이 예에서는 기존 채팅을 상담사에게 에스컬레이션하는 요청을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)

본문:

{
    "reason": "by_end_user_ask",
    "force_escalate": true
}
응답
{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

상태 코드: 200

에스컬레이션 업데이트

전환 채널을 선택하는 데만 사용됩니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 전환 메뉴 ID를 업데이트하는 데 필요한 채팅 ID입니다.
id TRUE 정수 필수 메뉴 ID입니다.

엔드포인트:

Method: PATCH
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/escalations/:id

헤더:

키 값 설명
Content-Type application/json

본문:

{
    "deflection_channel": "string"
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

에스컬레이션 업데이트 성공

이 예시에서는 에스컬레이션 채널이 성공적으로 업데이트되었음을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
id 정수 (필수)

본문:

{
    "deflection_channel": "string"
}
응답
{
    "id": "integer",
    "chat_id": "integer",
    "status": "string"
}

상태 코드: 200

업로드된 사진을 채팅에 추가

미디어 저장소에 업로드된 사진을 채팅에 추가하기

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 사진을 추가하는 데 필요한 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:chat_id/photos

헤더:

키 값 설명
Content-Type application/json
수락 application/json

본문:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅에 사진이 추가됨

다음 예에서는 미디어 저장소에 업로드된 사진을 기존 채팅 대화에 추가하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)

본문:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}
응답
{
    "url": "string",
    "media_id": "integer"
}

상태 코드: 200

채팅에서 모든 사진 가져오기

채팅에 첨부된 모든 사진의 미디어 ID와 저장소 URL을 가져옵니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 미디어 정보를 가져오는 데 필요한 채팅 ID입니다.

엔드포인트:

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos

헤더:

키 값 설명
수락 application/json

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅의 채팅 사진 정보를 성공적으로 가져옴

이 예에서는 기존 채팅 세션의 사진 정보를 가져오기 위해 API를 성공적으로 호출하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
응답
[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

상태 코드: 200

사전 서명된 사진 업로드 URL 가져오기

사진의 사전 서명된 업로드 URL을 가져오는 데 사용됩니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 사전 서명된 사진 URL과 연결될 필수 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/photos/upload

헤더:

키 값 설명
Content-Type application/json
수락 application/json

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

업로드를 위한 서명된 URL을 가져오는 데 성공함

다음은 사진 업로드를 위한 서명된 URL을 가져오는 요청이 성공한 예입니다.

요청

헤더:

키 값 설명
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
응답
{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

상태 코드: 200

업로드된 동영상을 채팅에 추가

미디어 저장소에 업로드된 동영상을 채팅에 추가합니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 동영상이 연결되어야 하는 필수 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

헤더:

키 값 설명
Content-Type application/json
수락 application/json

본문:

{
    "video": {
        "s3_path": "string",
        "gcs_path": "string"
    }
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅 세션에 동영상이 업로드됨

이 예시에서는 채팅 세션에 동영상을 성공적으로 업로드하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)

본문:

{
    "photo": [
        {
            "s3_path": "string",
            "photo_type": "string"
        },
        {
            "s3_path": "string",
            "photo_type": "string"
        }
    ]
}
응답
Body
{
    "url": "string",
    "media_id": "integer"
}

상태 코드: 200

채팅에서 모든 동영상 가져오기

채팅에 첨부된 모든 동영상의 미디어 ID와 저장소 URL을 가져옵니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 동영상 URL을 가져올 필수 채팅 ID입니다.

엔드포인트:

Method: GET
Type:
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos

헤더:

키 값 설명
Content-Type application/json
수락 application/json

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅의 모든 동영상 URL 가져오기

이 예시에서는 기존 채팅의 모든 동영상 URL을 가져오는 방법을 보여줍니다.

요청

헤더:

키 값 설명
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
응답
[
    {
        "url": "string",
        "media_id": "integer"
    },
    {
        "url": "string",
        "media_id": "integer"
    }
]

상태 코드: 200

사전 서명된 동영상 업로드 URL 가져오기

동영상의 사전 서명된 업로드 URL을 가져오는 데 사용됩니다.

매개변수 필수 데이터 유형 정의
chat_id TRUE 정수 사전 서명된 동영상 URL과 연결될 필수 채팅 ID입니다.

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.​{domain}​/apps/api/v1/chats/:chat_id/videos/upload

헤더:

키 값 설명
Content-Type application/json
수락 application/json

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

동영상 업로드를 위한 서명된 URL을 성공적으로 가져옴

다음은 동영상 업로드를 위한 서명된 URL을 가져오는 요청이 성공한 예입니다.

요청

헤더:

키 값 설명
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
응답
{
    "url": "string",
    "fields": {
        "key": "string",
        "success_action_status": "string",
        "Content-Type": "string",
        "Cache-Control": "string",
        "acl": "string",
        "policy": "string",
        "x-amz-credential": "string",
        "x-amz-algorithm": "string",
        "x-amz-date": "string",
        "x-amz-security-token": "string",
        "x-amz-signature": "string",
        "x-goog-algorithm": "string",
        "x-goog-credential": "string",
        "x-goog-date": "string",
        "x-goog-signature": "string"
    }
}

상태 코드: 200

채팅 만들기

새 채팅 세션을 시작합니다.

요청 예시

메서드: POST

URL: https://{subdomain}.{domain}/apps/api/v1/chats

헤더

키 값 설명
Content-Type application/json
수락 application/json

본문

{
    "chat": {
        "menu_id": "integer",
        "end_user_id": "integer",
        "lang": "string",
        "email": "string",
        "context": "object",
        "transcript": "object"
    },
    "end_user": {
        "phone": "string"
    }
}

컨텍스트:

context 객체에는 채팅 대화에 메타데이터를 전달하는 value 객체가 포함됩니다. context 객체를 가상 에이전트에 부호 없는 데이터 매개변수로 전달할 수 있습니다. 아래 예시를 참조하세요.

{
    "context": {
        {"value":
            {"foo": "bar",
             "key": "value"}
        }
    }
}

이 예에서 수신 필드의 부호 없는 데이터 매개변수 값은 context이고 대상 필드는 context로 설정할 수 있습니다. 이렇게 하면 $session.params.context.foo 또는 $session.params.context.key를 사용할 수 있습니다.

응답 예시

{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

ID로 채팅을 반환합니다.

이 메서드는 지정된 채팅 ID의 채팅 객체를 반환합니다.

엔드포인트:

Method: GET
Type:
URL: https://{subdomain}.​{domain}/apps/api/v1/chats/:id

헤더:

키 값 설명
Content-Type application/json
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

채팅을 성공적으로 가져옴

다음 예시는 기존 채팅 ID에 대한 성공적인 요청을 보여줍니다.

요청

헤더:

키 값 설명
Content-type application/json
수락 application/json

질문:

키 값 설명
chat_id 정수 (필수)
응답
{
    "id": "integer",
    "status": "string",
    "status_text": "string",
    "features": [
        "string",
        "string"
    ],
    "created_at": "string",
    "ends_at": "string",
    "timeout_at": "string",
    "agent": {
        "id": "integer",
        "name": "string",
        "first_name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "virtual_agent": {
        "id": "integer",
        "name": "string",
        "avatar_url": "string",
        "status": "string"
    },
    "all_agents": [
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "first_name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "all_virtual_agents": [
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        },
        {
            "id": "integer",
            "name": "string",
            "avatar_url": "string",
            "status": "string"
        }
    ],
    "lang": "string",
    "menus": [
        {
            "id": "integer",
            "name": "string"
        },
        {
            "id": "integer",
            "name": "string"
        }
    ],
    "end_user": {
        "id": "integer",
        "identifier": "string"
    }
}

상태 코드: 200

채팅 중에 예약된 데이터 속성 가져오기

엔드포인트

Method: GET
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/customer_flag

요청 및 응답 예시

이 섹션에는 엔드포인트의 요청 및 응답 예시가 포함되어 있습니다.

성공

이 예시에서는 성공적인 호출을 보여줍니다.

요청

헤더

키 값 설명
수락 application/json

URL 변수

키 값 설명
id 정수 (필수)
응답
{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customer": "boolean"
}

상태 코드 0

채팅 중에 예약된 데이터 속성 업데이트

엔드포인트

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/chats/:id/customer_flag

URL 변수

키 값 설명
id 정수 (필수)

본문

{
    "verified_customer": "boolean",
    "bad_actor": "boolean",
    "repeat_customers": "boolean"
}

채팅에서 맞춤 데이터 전송

채팅에서 맞춤 데이터를 전송합니다.

요청 예시

메서드: POST

URL: https//{subdomain}.{domain}/apps/api/v1/chats/:id/custom_data

헤더

키 값 설명
Content-Type application/json

URL 변수

키 값 설명
id (필수)

응답 예시

// Use unsecured parameter
{
"signed": false,
"data": {
// Start customer_flag fields
"reserved_verified_customer": {
"label": "LABEL 1",
"value": true
},
"reserved_bad_actor": {
"label": "LABEL 2",
"value": false
},
"reserved_repeat_customer": {
"label": "LABEL 3",
"value": true
},
// End customer_flag fields
"field1": {
"label": "LABEL 4",
"value": "dummy1"
},
"field2": {
"label": "LABEL 5",
"value": "dummy2"
}
}
}
// Use secured parameter
// {
// "signed": true,
// "signed_data": "eyJhbGciOiJIUzI1NiJ9.eyJjdXN0b21fZGF0YSI6eyJyZXNlcnZlZF92ZXJpZmllZF9jdXN0b21lciI6eyJ2YWx1ZSI6ZmFsc2V9LCJyZXNlcnZlZF9iYWRfYWN0b3IiOnsidmFsdWUiOnRydWV9LCJyZXNlcnZlZF9yZXBlYXRfY3VzdG9tZXIiOnsidmFsdWUiOmZhbHNlfSwiZmllbGQxIjp7InZhbHVlIjoiZHVtbXkxMTEifSwiZmllbGQyIjp7InZhbHVlIjoiZHVtbXkyMjIifX0sImV4cCI6MTcyOTY4MzU5MywiaWF0IjoxNzI5Njc5OTkzfQ.BMskgKTM3DbgrMLWjI46ZJ1K73H25JRd16SgHK0A1Ts"
// }
// ======================= How to create <signed_data> =======================
// payload = {
// "custom_data": {
// // Start customer_flag fields
// "reserved_verified_customer": {
// "label": "LABEL 1",
// "value": true
// },
// "reserved_bad_actor": {
// "label": "LABEL 2",
// "value": false
// },
// "reserved_repeat_customer": {
// "label": "LABEL 3",
// "value": true
// },
// // End customer_flag fields
// "field1": {
// "label": "LABEL 4",
// "value": "dummy1"
// },
// "field2": {
// "label": "LABEL 5",
// "value": "dummy2"
// }
// },
// "exp": 1734567890, // expiration timestamp
// "iat": 1734560000 // issue timestamp
// }
// signed_data = JWT.encode(payload, 'Company secret', 'HS256')
// ======================= End how to create <signed_data> =======================

진행 중인 채팅 세션 중에 최종 사용자 업데이트

현재 활성 채팅 세션과 연결된 최종 사용자를 업데이트합니다. 또한 CRM 티켓에 연결된 연락처 정보도 업데이트합니다. _Identifier은 필수이고 name, email, phone는 선택사항입니다.

요청 예시

메서드: POST

URL: https//{subdomain}.{domain}/apps/api/v1/chats/:chat_id/end-user

헤더

키 값 설명
Content-Type application/json

URL 변수

키 값 설명
chat_id

본문

{
    "identifier": "string",
    "name": "string",
    "email": "string",
    "phone": "string"
}

응답 예시

{
    "message": "accepted"
}