Phone Appointment Management

Change/Complete Phone Appointment Detail

post

Function Description

Changes the phone appointment detail information or marks it as complete.

Detailed Description

Changes the selected phone appointment information or marks it as complete.
The appointment date/time, notification settings, mobile phone number, and consultation memo can be modified.
When appointment information is changed, the existing phone appointment is marked complete and a new phone appointment is created.
The agent for the newly created phone appointment resulting from the modification is the logged-in agent.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ccnNostringOptional

Consultation No.

Example: 10004891

cnslProcSeqstringOptional

Consultation Processing Sequence No.

Example: 1

telPrmsSeqstringOptional

Phone Appointment Sequence No.

Example: 1

savegubstringOptional

Save Type (0: Change, 1: Processing Complete)

Example: 0

prmsDtmstringOptional

Appointment Date/Time

Example: 2023-09-18 14:49

notiTmCdstring · enumOptional

Notification Time Code (CS013)

Example: 15Possible values:

prmsMethCdstring · enumOptional

Appointment Method Code (CS008)

Example: 10Possible values:

prmsStatCdstring · enumOptional

Appointment Status Code (CS009)

Example: 20Possible values:

cnslMemostringOptional

Consultation Memo

Example: 전화약속 테스트 합니다.

aempConfDtmstringOptional

Agent Confirmation Date/Time

Example: 2023-09-15 15:03:37

telTryCntstringOptional

Call Attempt Count

Example: 0

cnslindInfoMemostringOptional

Consultation Personal Information Memo

telRgnNostringOptional

Phone Area Code

Example: 010

telTxnoNostringOptional

Phone Exchange Code

Example: 1111

telEndNostringOptional

Phone Last Digits

Example: 2222

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Business processing error details

*/*

post/v2/customerservice/phoneAppointmentMgmt/savePhoneAppointment

POST /api/bo/v2/customerservice/phoneAppointmentMgmt/savePhoneAppointment HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "ccnNo": 10004891,
  "cnslProcSeq": 1,
  "telPrmsSeq": 1,
  "savegub": 0,
  "prmsDtm": "2023-09-18 14:49",
  "notiTmCd": 15,
  "prmsMethCd": 10,
  "prmsStatCd": 20,
  "cnslMemo": "전화약속 테스트 합니다.",
  "aempConfDtm": "2023-09-15 15:03:37",
  "telTryCnt": 0,
  "cnslindInfoMemo": "text",
  "telRgnNo": "010",
  "telTxnoNo": 1111,
  "telEndNo": 2222
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Phone Appointment Detail Information

get

Function Description

Retrieves phone appointment detail information.

Detailed Description

Retrieves the detail information of the selected phone appointment.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ccnNostringOptional

Consultation No.

Example: 10004891

cnslProcSeqstringOptional

Consultation Processing Sequence No.

Example: 1

telPrmsSeqstringOptional

Phone Appointment Sequence No.

Example: 1

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

Business processing error details

*/*

get/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentPopup

GET /api/bo/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentPopup HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "procState": "text",
    "procStateCd": "text",
    "prmsDtm": "text",
    "notiTmCd": "text",
    "prmsMethCd": "text",
    "cnslMemo": "text",
    "mbrNo": "text",
    "mbrId": "text",
    "mbrNm": "text",
    "telRgnNo": "text",
    "telTxnoNo": "text",
    "telTxnoNos": "text",
    "telEndNo": "text",
    "telEndNos": "text",
    "ordNo": "text",
    "ccnNo": "text",
    "acptmnNm": "text",
    "acptmnId": "text",
    "acpCont": "text",
    "acptmnDept": "text",
    "procmnNm": "text",
    "procmnId": "text",
    "procmnDept": "text",
    "aempConfDtm": "text",
    "aempProcDtm": "text",
    "cnslProcSeq": "text",
    "telPrmsSeq": "text",
    "cnslTypText": "text"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Phone Appointment List

get

Function Description

Retrieves the phone appointment list.

Detailed Description

Retrieves the phone appointment list matching the selected conditions.

Code Reference

Period search type (periodType): Appointment Date (0), Completion Date (1)
Appointment status (procState): Scheduled (R), Imminent (I), Delayed (D), Completed (C)
Member search type (mbrType): Member ID (0), Member Name (1)
Agent search type (userType): Receiver (0), Handler (1)

Revision History

Release v2.00_240613: Improved period search conditions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

periodTypestringOptional

Period Search Type

Example: 0

startDatestring · dateOptional

Search Start Date

Example: 2023-08-20

endDatestring · dateOptional

Search End Date

Example: 2023-09-19

procStatestringOptional

Call Appointment Status

Example: R

prmsMethCdstring · enumOptional

Appointment Method Code (CS008)

Example: 10Possible values:

mbrNostringOptional

Member No.

Example: 10000001

userTypestringOptional

Contact Search Type

Example: 0

userTextstringOptional

Person in Charge ID

Example: x2beecc

ordNostringOptional

Order No.

Example: 20230718O002626

ccnNostringOptional

Consultation No.

Example: 10004891

siteNostringOptional

Site No.

Example: 1

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentList

GET /api/bo/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "procState": "text",
      "procStateCd": "text",
      "prmsDtm": "text",
      "notiTmCd": "text",
      "prmsMethCd": "text",
      "cnslMemo": "text",
      "mbrNo": "text",
      "mbrId": "text",
      "mbrNm": "text",
      "telRgnNo": "text",
      "telTxnoNo": "text",
      "telEndNo": "text",
      "ordNo": "text",
      "ccnNo": "text",
      "acptmnNm": "text",
      "accpCont": "text",
      "accpDtm": "text",
      "acptmnDept": "text",
      "procmnId": "text",
      "procmnNm": "text",
      "procmnTel": "text",
      "procmnEmpNo": "text",
      "procmnDept": "text",
      "aempProcDtm": "text",
      "cnslProcSeq": "text",
      "telPrmsSeq": "text",
      "procmnProcDtm": "text",
      "acptmnId": "text",
      "siteNm": "text"
    }
  ]
}

Retrieve Phone Appointment Detail History List

get

Function Description

Retrieves the phone appointment detail history list.

Detailed Description

Retrieves the complete change history list for a consultation with a scheduled phone appointment.
Only the most recent consultation history can be viewed in detail.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

ccnNoStringRequired

Consultation No.

Example: 10004891

Responses

200

Success

*/*

totalCountinteger · int32Optional

900

Business processing error details

*/*

get/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentHistoryList

GET /api/bo/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentHistoryList?ccnNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "procState": "text",
      "procStateCd": "text",
      "prmsDtm": "text",
      "notiTmCd": "text",
      "prmsMethCd": "text",
      "cnslMemo": "text",
      "mbrNo": "text",
      "mbrId": "text",
      "mbrNm": "text",
      "telRgnNo": "text",
      "telTxnoNo": "text",
      "telEndNo": "text",
      "ordNo": "text",
      "ccnNo": "text",
      "acptmnNm": "text",
      "accpCont": "text",
      "accpDtm": "text",
      "acptmnDept": "text",
      "procmnId": "text",
      "procmnNm": "text",
      "procmnTel": "text",
      "procmnEmpNo": "text",
      "procmnDept": "text",
      "aempProcDtm": "text",
      "cnslProcSeq": "text",
      "telPrmsSeq": "text",
      "procmnProcDtm": "text",
      "acptmnId": "text",
      "siteNm": "text"
    }
  ]
}

Retrieve Phone Appointment Notification List

get

Function Description

Retrieves an agent's phone appointment notification list.

Detailed Description

Retrieves the list of phone appointments that the logged-in agent needs to handle.
Imminent phone appointments are displayed as a popup.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

aempIdStringRequired

Person in Charge ID

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

Business processing error details

*/*

get/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentAlarmList

GET /api/bo/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentAlarmList?aempId=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    {
      "procState": "text",
      "procStateCd": "text",
      "prmsDtm": "text",
      "notiTmCd": "text",
      "prmsMethCd": "text",
      "cnslMemo": "text",
      "mbrNo": "text",
      "mbrId": "text",
      "mbrNm": "text",
      "telRgnNo": "text",
      "telTxnoNo": "text",
      "telEndNo": "text",
      "ordNo": "text",
      "ccnNo": "text",
      "acptmnNm": "text",
      "accpCont": "text",
      "accpDtm": "text",
      "acptmnDept": "text",
      "procmnId": "text",
      "procmnNm": "text",
      "procmnTel": "text",
      "procmnEmpNo": "text",
      "procmnDept": "text",
      "aempProcDtm": "text",
      "cnslProcSeq": "text",
      "telPrmsSeq": "text",
      "procmnProcDtm": "text",
      "acptmnId": "text",
      "siteNm": "text"
    }
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

PreviousCompensation Type Management

NextOB Type Management

Last updated 2 months ago