상담사 엔드포인트는 상담사 객체를 가져오는 방법을 제공합니다. 각 상담사 객체는 Contact Center AI Platform (CCAI Platform) 내의 단일 상담사를 나타냅니다. 다음 모델을 검토하여 개인 식별 정보(PII)가 포함될 수 있는 필드를 확인하세요.
[
{
"id": 0,
"email": "string",
"created_at": "2018-05-30T20:46:31.333Z",
"last_login_time": "2018-05-30T20:46:31.333Z",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"avatar_url": "string",
"agent_number": "string",
"status": {
"id": 0,
"wfm_id": 0,
"name": "string",
"color": "string"
},
"status_updated_at": "2018-05-30T20:46:31.333Z",
"crm_authenticated": true,
"online": true,
"wrap_up": true,
"call_count": 0,
"chat_count": 0,
"location": "string",
"roles": [
"agent"
],
"teams": [
{
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"agents_count": 0
}
],
"channels": [
{
"channel_type": "chat",
"menu": {
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"hidden": "string",
"menu_type": "ivr_menu",
"output_msg": "string"
}
}
]
}
]
에이전트
| 매개변수 | 필수 | 데이터 유형 | 정의 |
|---|---|---|---|
| 페이지 | FALSE | 문자열 | 레코드의 페이지를 나타내기 위해 per와 함께 사용됩니다. 예를 들어 per이 200이고 page가 2이면 페이지 1에 1~200이 포함되므로 응답에는 레코드 201~400이 포함됩니다. |
| / | FALSE | 문자열 | 레코드 페이지에 포함될 레코드 수를 나타내는 페이지와 쌍을 이룹니다. 예를 들어 per이 200이고 page가 2이면 페이지 1에 1~200이 포함되므로 응답에는 레코드 201~400이 포함됩니다. |
| id[] | FALSE | Array[String] | Array[Strings] 검색하고 반환할 레코드의 ID |
| agent_number[] | FALSE | Array[String] | 관리자가 에이전트를 만들 때 할당한 에이전트 번호 |
| status_id[] | FALSE | Array[String] | 상담사 상태별로 필터링합니다. |
| online[] | FALSE | 불리언 | 상담사의 온라인 여부로 필터링 |
| wrap_up[] | FALSE | 불리언 | 상담사가 마무리 상태인지 여부로 필터링 |
| location[] | FALSE | Array[String] | 상담사 위치별로 필터링 |
| last_login_time[from] | FALSE | UTC 시간 | 마지막 로그인 시간 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후의 값입니다. |
| last_login_time[to] | FALSE | UTC 시간 | 마지막 로그인 시간 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전입니다. |
| status_updated_at[from] | FALSE | UTC 시간 | status updated at 필드의 하한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이후의 값입니다. |
| status_updated_at[to] | FALSE | UTC 시간 | status updated at 필드의 상한을 만듭니다. 반환되는 모든 레코드는 입력된 값 이전입니다. |
엔드포인트:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents
요청/응답 예시 더보기:
요청 예시: 에이전트 예시
본문: 없음
응답 예시: 에이전트 예시
[
{
"id": 45,
"email": "craigT@nelson.com",
"roles": [
"agent"
],
"first_name": "Craig T",
"middle_name": null,
"last_name": "Nelson",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -6,
"name": "Wrap-up",
"color": "purple",
"wfm_id": 33
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2016-11-10T00:15:04.000Z",
"last_login_time": "2016-11-10T00:17:57.000Z",
"status_updated_at": null,
"teams": [
{
"id": 163,
"name": "team CTN",
"parent_id": null,
"position": 11,
"agents_count": 12,
"deleted": false
}
],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 2029,
"name": "Mobile Queue",
"parent_id": null,
"position": 0,
"deleted": false,
"menu_type": "mobile_menu",
"output_msg": null,
"hidden": false
}
}
]
},
{
"id": 60,
"email": "notanakinskywalker@empire.com",
"roles": [
"agent"
],
"first_name": "Darth",
"middle_name": null,
"last_name": "Vader",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -7,
"name": "In-call",
"color": "light_blue",
"wfm_id": 34
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2017-02-03T19:44:14.000Z",
"last_login_time": "2017-02-03T20:05:31.000Z",
"status_updated_at": "2017-02-04T12:36:11.000Z",
"teams": [],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 1693,
"name": "Premium Support",
"parent_id": null,
"position": 0,
"deleted": false,
"menu_type": "ivr_menu",
"output_msg": "You selected premium support",
"hidden": false
}
}
]
},
{
"id": 81,
"email": "email@email.com",
"roles": [
"agent"
],
"first_name": "Barry",
"middle_name": null,
"last_name": "Allen",
"avatar_url": "https://subdomain.somedomain.com/default-profile.png",
"agent_number": null,
"crm_authenticated": false,
"status": {
"id": -10,
"name": "Offline",
"color": "grey",
"wfm_id": 36
},
"online": false,
"wrap_up": false,
"call_count": 0,
"chat_count": 0,
"location": null,
"created_at": "2017-03-13T23:47:39.000Z",
"last_login_time": "2017-03-13T23:48:17.000Z",
"status_updated_at": "2017-03-13T23:56:04.000Z",
"teams": [],
"channels": [
{
"channel_type": "voice_call",
"menu": {
"id": 2028,
"name": "Speed Issues",
"parent_id": 2027,
"position": 0,
"deleted": false,
"menu_type": "mobile_menu",
"output_msg": null,
"hidden": false
}
}
]
}
]
상태 코드: 200
상담사의 현재 상태
상담사 현재 상태는 로그인한 모든 상담사와 현재 상태, 해당 상태에 머문 시간, 상담사가 대기 중인지 여부와 대기 시간을 나타내는 추가 정보를 반환합니다.
엔드포인트:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agents/current_status
요청/응답 예시 더보기:
요청 예시: 상담사의 현재 상태
본문: 없음
응답 예시: 상담사의 현재 상태
[
{
"id": 1,
"status": "Available",
"status_id": 0,
"status_updated_at": "2021-05-10T17:45:01.000Z",
"on_hold": false,
"on_hold_duration": 0
}
]
상태 코드: 0
API 응답에서 인식할 수 없는 JSON 키 예상
모든 API 업데이트는 하위 호환됩니다. Google은 언제든지 기존 API 응답에 새로운 JSON 키를 도입할 권리를 보유합니다. 인식할 수 없는 키를 무시하여 계속 기능을 유지함으로써 방어적으로 응답을 처리하는 것이 좋습니다.