> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/cs-bo-api/phone-appointment-management.md).
# Phone Appointment Management
## Change/Complete Phone Appointment Detail
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PhoneAppointmentPopupRequest":{"type":"object","properties":{"ccnNo":{"type":"string","description":"Consultation No."},"cnslProcSeq":{"type":"string","description":"Consultation Processing Sequence No."},"telPrmsSeq":{"type":"string","description":"Phone Appointment Sequence No."},"savegub":{"type":"string","description":"Save Type (0: Change, 1: Processing Complete)"},"prmsDtm":{"type":"string","description":"Appointment Date/Time"},"notiTmCd":{"type":"string","description":"Notification Time Code (CS013)","enum":["ALIM_MIN_1","ALIM_MIN_3","ALIM_MIN_5","ALIM_MIN_10","ALIM_MIN_15","ALIM_MIN_20","ALIM_MIN_30"]},"prmsMethCd":{"type":"string","description":"Appointment Method Code (CS008)","enum":["CALL"]},"prmsStatCd":{"type":"string","description":"Appointment Status Code (CS009)","enum":["APPOINTMENT","COMPLETE"]},"cnslMemo":{"type":"string","description":"Consultation Memo"},"aempConfDtm":{"type":"string","description":"Agent Confirmation Date/Time"},"telTryCnt":{"type":"string","description":"Call Attempt Count"},"cnslindInfoMemo":{"type":"string","description":"Consultation Personal Information Memo"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Code"},"telEndNo":{"type":"string","description":"Phone Last Digits"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/phoneAppointmentMgmt/savePhoneAppointment":{"post":{"tags":["Phone Appointment Management"],"summary":"Change/Complete Phone Appointment Detail","description":"## Function Description\n* Changes the phone appointment detail information or marks it as complete.\n---\n## Detailed Description\n* Changes the selected phone appointment information or marks it as complete.\n* The appointment date/time, notification settings, mobile phone number, and consultation memo can be modified.\n* When appointment information is changed, the existing phone appointment is marked complete and a new phone appointment is created.\n* The agent for the newly created phone appointment resulting from the modification is the logged-in agent.\n","operationId":"savePhoneAppointment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneAppointmentPopupRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Phone Appointment Detail Information
> \## Function Description\
> \* Retrieves phone appointment detail information.\
> \---\
> \## Detailed Description\
> \* Retrieves the detail information of the selected phone appointment.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponsePhoneAppointmentPopupResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/PhoneAppointmentPopupResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"PhoneAppointmentPopupResponse":{"type":"object","properties":{"procState":{"type":"string"},"procStateCd":{"type":"string"},"prmsDtm":{"type":"string"},"notiTmCd":{"type":"string"},"prmsMethCd":{"type":"string"},"cnslMemo":{"type":"string"},"mbrNo":{"type":"string"},"mbrId":{"type":"string"},"mbrNm":{"type":"string"},"telRgnNo":{"type":"string"},"telTxnoNo":{"type":"string"},"telTxnoNos":{"type":"string"},"telEndNo":{"type":"string"},"telEndNos":{"type":"string"},"ordNo":{"type":"string"},"ccnNo":{"type":"string"},"acptmnNm":{"type":"string"},"acptmnId":{"type":"string"},"acpCont":{"type":"string"},"acptmnDept":{"type":"string"},"procmnNm":{"type":"string"},"procmnId":{"type":"string"},"procmnDept":{"type":"string"},"aempConfDtm":{"type":"string"},"aempProcDtm":{"type":"string"},"cnslProcSeq":{"type":"string"},"telPrmsSeq":{"type":"string"},"cnslTypText":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentPopup":{"get":{"tags":["Phone Appointment Management"],"summary":"Retrieve Phone Appointment Detail Information","description":"## Function Description\n* Retrieves phone appointment detail information.\n---\n## Detailed Description\n* Retrieves the detail information of the selected phone appointment.\n","operationId":"getPhoneAppointmentPopup","parameters":[{"name":"ccnNo","in":"query","description":"Consultation No.","required":false,"schema":{"type":"string","description":"Consultation No."}},{"name":"cnslProcSeq","in":"query","description":"Consultation Processing Sequence No.","required":false,"schema":{"type":"string","description":"Consultation Processing Sequence No."}},{"name":"telPrmsSeq","in":"query","description":"Phone Appointment Sequence No.","required":false,"schema":{"type":"string","description":"Phone Appointment Sequence No."}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponsePhoneAppointmentPopupResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Phone Appointment List
> \## 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
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponsePhoneAppointmentResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PhoneAppointmentResponse"}}}},"PhoneAppointmentResponse":{"type":"object","properties":{"procState":{"type":"string"},"procStateCd":{"type":"string"},"prmsDtm":{"type":"string"},"notiTmCd":{"type":"string"},"prmsMethCd":{"type":"string"},"cnslMemo":{"type":"string"},"mbrNo":{"type":"string"},"mbrId":{"type":"string"},"mbrNm":{"type":"string"},"telRgnNo":{"type":"string"},"telTxnoNo":{"type":"string"},"telEndNo":{"type":"string"},"ordNo":{"type":"string"},"ccnNo":{"type":"string"},"acptmnNm":{"type":"string"},"accpCont":{"type":"string"},"accpDtm":{"type":"string"},"acptmnDept":{"type":"string"},"procmnId":{"type":"string"},"procmnNm":{"type":"string"},"procmnTel":{"type":"string"},"procmnEmpNo":{"type":"string"},"procmnDept":{"type":"string"},"aempProcDtm":{"type":"string"},"cnslProcSeq":{"type":"string"},"telPrmsSeq":{"type":"string"},"procmnProcDtm":{"type":"string"},"acptmnId":{"type":"string"},"siteNm":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentList":{"get":{"tags":["Phone Appointment Management"],"summary":"Retrieve Phone Appointment List","description":"## Function Description\n* Retrieves the phone appointment list.\n---\n## Detailed Description\n* Retrieves the phone appointment list matching the selected conditions.\n---\n## Code Reference\n* Period search type (periodType): Appointment Date (0), Completion Date (1)\n* Appointment status (procState): Scheduled (R), Imminent (I), Delayed (D), Completed (C)\n* Member search type (mbrType): Member ID (0), Member Name (1)\n* Agent search type (userType): Receiver (0), Handler (1)\n---\n## Revision History\n* Release v2.00_240613: Improved period search conditions\n","operationId":"getPhoneAppointmentList","parameters":[{"name":"periodType","in":"query","description":"Period Search Type","required":false,"schema":{"type":"string","description":"Period Search Type"}},{"name":"startDate","in":"query","description":"Search Start Date","required":false,"schema":{"type":"string","format":"date","description":"Search Start Date"}},{"name":"endDate","in":"query","description":"Search End Date","required":false,"schema":{"type":"string","format":"date","description":"Search End Date"}},{"name":"procState","in":"query","description":"Call Appointment Status","required":false,"schema":{"type":"string","description":"Call Appointment Status"}},{"name":"prmsMethCd","in":"query","description":"Appointment Method Code (CS008)","required":false,"schema":{"type":"string","description":"Appointment Method Code (CS008)","enum":["CALL"]}},{"name":"mbrNo","in":"query","description":"Member No.","required":false,"schema":{"type":"string","description":"Member No."}},{"name":"userType","in":"query","description":"Contact Search Type","required":false,"schema":{"type":"string","description":"Contact Search Type"}},{"name":"userText","in":"query","description":"Person in Charge ID","required":false,"schema":{"type":"string","description":"Person in Charge ID"}},{"name":"ordNo","in":"query","description":"Order No.","required":false,"schema":{"type":"string","description":"Order No."}},{"name":"ccnNo","in":"query","description":"Consultation No.","required":false,"schema":{"type":"string","description":"Consultation No."}},{"name":"siteNo","in":"query","description":"Site No.","required":false,"schema":{"type":"string","description":"Site No."}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePhoneAppointmentResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Phone Appointment Detail History List
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridListResponsePhoneAppointmentResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/PhoneAppointmentResponse"}}}},"PhoneAppointmentResponse":{"type":"object","properties":{"procState":{"type":"string"},"procStateCd":{"type":"string"},"prmsDtm":{"type":"string"},"notiTmCd":{"type":"string"},"prmsMethCd":{"type":"string"},"cnslMemo":{"type":"string"},"mbrNo":{"type":"string"},"mbrId":{"type":"string"},"mbrNm":{"type":"string"},"telRgnNo":{"type":"string"},"telTxnoNo":{"type":"string"},"telEndNo":{"type":"string"},"ordNo":{"type":"string"},"ccnNo":{"type":"string"},"acptmnNm":{"type":"string"},"accpCont":{"type":"string"},"accpDtm":{"type":"string"},"acptmnDept":{"type":"string"},"procmnId":{"type":"string"},"procmnNm":{"type":"string"},"procmnTel":{"type":"string"},"procmnEmpNo":{"type":"string"},"procmnDept":{"type":"string"},"aempProcDtm":{"type":"string"},"cnslProcSeq":{"type":"string"},"telPrmsSeq":{"type":"string"},"procmnProcDtm":{"type":"string"},"acptmnId":{"type":"string"},"siteNm":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentHistoryList":{"get":{"tags":["Phone Appointment Management"],"summary":"Retrieve Phone Appointment Detail History List","description":"## Function Description\n* Retrieves the phone appointment detail history list.\n---\n## Detailed Description\n* Retrieves the complete change history list for a consultation with a scheduled phone appointment.\n* Only the most recent consultation history can be viewed in detail.\n","operationId":"getPhoneAppointmentHistoryList","parameters":[{"name":"ccnNo","in":"query","description":"Consultation No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponsePhoneAppointmentResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Phone Appointment Notification List
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseListPhoneAppointmentResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"array","description":"payload","items":{"$ref":"#/components/schemas/PhoneAppointmentResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"PhoneAppointmentResponse":{"type":"object","properties":{"procState":{"type":"string"},"procStateCd":{"type":"string"},"prmsDtm":{"type":"string"},"notiTmCd":{"type":"string"},"prmsMethCd":{"type":"string"},"cnslMemo":{"type":"string"},"mbrNo":{"type":"string"},"mbrId":{"type":"string"},"mbrNm":{"type":"string"},"telRgnNo":{"type":"string"},"telTxnoNo":{"type":"string"},"telEndNo":{"type":"string"},"ordNo":{"type":"string"},"ccnNo":{"type":"string"},"acptmnNm":{"type":"string"},"accpCont":{"type":"string"},"accpDtm":{"type":"string"},"acptmnDept":{"type":"string"},"procmnId":{"type":"string"},"procmnNm":{"type":"string"},"procmnTel":{"type":"string"},"procmnEmpNo":{"type":"string"},"procmnDept":{"type":"string"},"aempProcDtm":{"type":"string"},"cnslProcSeq":{"type":"string"},"telPrmsSeq":{"type":"string"},"procmnProcDtm":{"type":"string"},"acptmnId":{"type":"string"},"siteNm":{"type":"string"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/phoneAppointmentMgmt/getPhoneAppointmentAlarmList":{"get":{"tags":["Phone Appointment Management"],"summary":"Retrieve Phone Appointment Notification List","description":"## Function Description\n* Retrieves an agent's phone appointment notification list.\n---\n## Detailed Description\n* Retrieves the list of phone appointments that the logged-in agent needs to handle.\n* Imminent phone appointments are displayed as a popup.\n","operationId":"getPhoneAppointmentAlarmList","parameters":[{"name":"aempId","in":"query","description":"Person in Charge ID","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListPhoneAppointmentResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```