Omichannel 콜백 API

Zurich API 참조

Release

zurich

ft:locale

ko-KR

ft:publication_title

Zurich API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Omichannel 콜백 API

릴리스 버전: Zurich

업데이트 날짜 2025년 08월 01일

소요 시간: 29분

옴니채널 콜백 API는 콜백 요청을 생성 또는 업데이트하고 CCaaS(서비스형 연락처 센터) 제공자로부터 관련 메타데이터를 검색하는 메서드를 제공합니다.

옴니채널 콜백 API를 사용하면 에이전트가 사용 가능한 에이전트를 큐에서 기다리지 않고 프로그래밍 방식으로 사용자를 다시 호출할 수 있습니다. 예를 들어 에이전트는 콜백 기능을 사용하여 에이전트 대기 시간이 길거나 사용 가능한 에이전트가 없을 때 사용자에게 다시 전화를 걸 수 있습니다. 이 API를 사용하여 다음 작업을 수행할 수 있습니다.

즉각적인 새 콜백 요청을 생성하거나 새 요청을 예약합니다.
초기 상호작용 및 후속 상호작용 재시도를 생성합니다.
기존 콜백을 업데이트합니다.

이 API는 sn_omni_callback 네임스페이스에 속하며 콜백 API [sn_omni_callback.callback_api] 역할을 가진 관리자가 필요합니다.

AI Platform 역량으 옴니채널 콜백 로서의 ServiceNow 애플리케이션에 대한 자세한 내용은 을 참조하십시오 Omnichannel Callback.

옴니채널 콜백 - POST /api/sn_omni_callback/callback/attempt

재시도를 포함하여 기존 콜백에 대한 상호작용을 시작합니다.

URL 형식

기본 URL: /api/sn_omni_callback/callback/attempt

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 2. 쿼리 매개변수
이름	설명
없음

표 3. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
콜백ID	필수 콜백의 Sys_id 또는 external_id입니다. 테이블: 콜백 [sys_cs_callback] 데이터 유형: 문자열
interactionDetails	옵션입니다. 상호작용에 대한 상세 정보입니다. 상호작용 상세 정보가 대기 없이 에이전트로 직접 라우팅되도록 즉각적인 콜백 유형을 위한 것입니다. 모든 상호작용 상세 정보는 의 음성 상호작용 자원 - POST /cs/voice-interactions페이로드에 전달됩니다. 데이터 유형: 객체 `"interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" }`
interactionDetails.callerPhoneNumber	호출자의 콜백 전화 번호입니다. 통화가 끊어지는 경우 에이전트가 발신자에게 연락하는 데 사용하는 번호입니다. 데이터 유형: 문자열 형식: E.164 표준 준수 기본값: 없음
interactionDetails.clientSessionId	외부 시스템의 기록에 대한 고유 식별자로, 여러 시스템에서 이 전화 통화를 추적하는 데 사용되며, ServiceNow와 타사 플랫폼(예: CCaaS 제공자) 간의 통합을 가능하게 합니다. 데이터 유형: 문자열 형식: 일반적으로 외부 시스템에서 작성된 UUID 또는 고유한 세션 토큰 기본값: 없음
interactionDetails.userId	콜백할 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


이름	설명
오류	필요한 요청 ID 누락 등 콜백 생성 실패에 대한 상세 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"errors": ["String", "String"]`
메시지	콜백 생성의 성공에 대한 세부 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"messages": ["String", "String"]`
결과	요청의 결과입니다. 데이터 유형: 객체 `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
결과.응답	콜백 요청의 콜백 및 상호작용 ID를 포함하는 객체입니다. 데이터 유형: 객체 `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.interaction_id	새로 생성된 상호작용의 Sys_id입니다. 테이블: 상호작용 [interaction] 데이터 유형: 문자열
결과.상태	요청의 성공 또는 실패 상태입니다. 유효한 값은 다음과 같습니다. 성공 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 초기 상호 작용 및 후속 재시도 상호 작용에 대한 세부 정보와 함께 POST 시도 요청을 보여 줍니다.

curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/attempt' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "callbackId": "<ID#>",
  "interactionDetails": {
    "clientSessionId": "<ID#>",
    "userId": "<ID#>",
    "callerPhoneNumber": "+112345678901"
  }
}

유효한 callback_Id 제공되고 콜백에 대한 새 상호작용이 성공적으로 만들어진 경우의 응답 본문입니다.

{
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "<Interaction ID#>"
    }
  }
}

요청에 잘못된 callback_Id 제공된 경우의 응답 본문입니다.

{
  "result": {
    "status": "failure",
    "response": {
      "interactionId": null
    },
    "errors": [
      "Callback not found for callback ID: <ID#>"
    ]
  }
}

지정된 콜백에 대한 상호작용이 이미 존재하는 경우의 응답 본문(메시지는 기존 상호작용에 대한 상세 정보를 반환함):

{
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "<Interaction ID#>"
    },
    "messages": [
      "Active Interaction <Interaction ID#> already exists for callback <ID#>"
    ]
  }
}

Omichannel 콜백 - POST /api/sn_omni_callback/callback/create

요청 본문에 입력한 상세 정보에 따라 즉시 또는 예약된 새 콜백 요청을 시작합니다. 즉각적인 콜백의 경우 이 API는 콜백과 상호작용을 모두 생성합니다. 예약된 콜백의 경우 콜백과 약속을 생성합니다.

URL 형식

기본 URL: /api/sn_omni_callback/callback/create

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
콜백컨텍스트	콜백 요청에 대한 컨텍스트 상세 정보를 포함하는 객체입니다. 테이블: 콜백 컨텍스트 [sys_cs_callback_context] 데이터 유형: 객체 `"callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String" }`
callbackContext.ivr_path	고객이 실제 에이전트로 전송되기 전에 따르는 IVR(대화형 음성 응답) 경로입니다. 일반적으로 고객이 IVR 시스템에서 탐색한 큐 또는 메뉴 옵션 목록을 포함합니다. 이 문자열은 CCaaS(Contact Center as a Service)에 의해 전달됩니다. 예: `"ivr_path": "기술 지원 > 계정 관리"` 데이터 유형: 문자열
콜백컨텍스트.queue	큐의 번호 할당입니다. 데이터 유형: 문자열
콜백상세 정보	콜백 요청에 대한 상세 정보를 포함하는 객체입니다. 테이블: 콜백 [sys_cs_callback] 데이터 유형: 객체 `"callbackDetails": { "appointment": "String", "channel_to_callback": "String", "description": "String", "end_time": "String", "expire_time": "String", "messaging_channel": String", "reason_type": "String" "scheduled_start_time": "String", "short_description": "String", "user_document": "String", "user_table": "String" }`
callbackDetails.약속	약속의 Sys_id입니다. `예약된` 콜백 유형에만 적용 가능합니다. 테이블: 약속 예약 [sn_apptmnt_booking_appointment_booking] 데이터 유형: 문자열
callbackDetails.channel_to_callback	콜백을 라우팅할 대상 메시징 채널입니다. 테이블: 메시징 채널 [sys_cs_channel], 필드: sys_id 데이터 유형: 문자열
callbackDetails.description	필요한 경우 콜백 이유를 설명하는 전체 설명입니다. 데이터 유형: 문자열
callbackDetails.end_time	콜백 시도를 중지할 날짜 및 시간 값입니다. `예약된` 콜백 유형에만 적용 가능합니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.expire_time	콜백 요청을 종결할 날짜 및 시간입니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.messaging_channel	콜백의 소스입니다. 콜백 요청을 시작한 클라이언트 인터페이스(예: 웹 클라이언트, 모바일 앱 또는 포함된 메신저)를 식별합니다. 테이블: 메시징 채널 [sys_cs_channel], 필드: sys_id 데이터 유형: 문자열
callbackDetails.reason_type	콜백 요청의 이유입니다. 표준화된 이유로 콜백에 태그를 지정하여 라우팅, 분석 및 보고를 지원합니다. 유효한 값은 다음과 같습니다. `기타 문제` 구현에서 정의한 사용자 지정 값입니다. 예: `"청구 문의"`, `"기술 지원"` 테이블: 콜백 [sys_cs_callback], 필드: reason_type 데이터 유형: 문자열
callbackDetails.scheduled_date_time	콜백을 시작하는 날짜 및 시간 값입니다. `예약된` 콜백 유형에만 적용 가능합니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.short_description	콜백 요청에 대한 자세한 설명을 제공합니다. 특정 고객 우려 사항, 컨텍스트 또는 에이전트의 메모를 포함할 수 있습니다. 데이터 유형: 문자열
callbackDetails.user_document	콜백을 요청한 사용자의 Sys_id입니다. 콜백을 요청하는 사용자를 식별하는 데 사용됩니다 callbackDetails.user_table . 테이블: 사용자 [sys_user], 필드: sys_id 데이터 유형: 문자열
callbackDetails.user_table	사용자 기록이 있는 테이블입니다. 콜백을 요청하는 사용자를 식별하는 데 사용됩니다 callbackDetails.user_document . 값은 항상 `sys_user`입니다. 데이터 유형: 문자열
외부 콜백 ID	외부 공급업체 벤더에서 생성된 콜백의 외부 식별자입니다. 데이터 유형: 문자열
inboundId	콜백과 연결된 인바운드 호출의 Sys_id입니다. 콜백 요청을 외부 공급업체 제공자 또는 CCaaS 플랫폼에서 발생할 수 있는 특정 인바운드 통화 기록에 연결하는 추적 가능성을 제공합니다. 테이블: 콜백 [sys_cs_callback], 필드: provider_application_id 데이터 유형: 문자열
interactionDetails	옵션입니다. 상호작용에 대한 상세 정보입니다. 상호작용 상세 정보가 대기 없이 에이전트로 직접 라우팅되도록 즉각적인 콜백 유형을 위한 것입니다. 모든 상호작용 상세 정보는 의 음성 상호작용 자원 - POST /cs/voice-interactions페이로드에 전달됩니다. 데이터 유형: 객체 `"interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" }`
interactionDetails.callerPhoneNumber	호출자의 콜백 전화 번호입니다. 통화가 끊어지는 경우 에이전트가 발신자에게 연락하는 데 사용하는 번호입니다. 데이터 유형: 문자열 형식: E.164 표준 준수 기본값: 없음
interactionDetails.clientSessionId	외부 시스템의 기록에 대한 고유 식별자로, 여러 시스템에서 이 전화 통화를 추적하는 데 사용되며, ServiceNow와 타사 플랫폼(예: CCaaS 제공자) 간의 통합을 가능하게 합니다. 데이터 유형: 문자열 형식: 일반적으로 외부 시스템에서 작성된 UUID 또는 고유한 세션 토큰 기본값: 없음
interactionDetails.userId	콜백할 사용자의 Sys_id입니다. 테이블: 사용자 [user] 데이터 유형: 문자열
isExternal	콜백이 외부인지 여부와 다른 외부 공급업체 벤더에서 요청되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 외부 콜백입니다. false: 콜백이 외부가 아닙니다. 기본값: false
유형	필수 콜백 유형입니다. 유효한 값은 다음과 같습니다. `즉시`: 콜백 상호 작용이 즉시 생성됩니다. `예약됨`: 콜백 상호작용이 생성되고 고객이 선택한 나중 시간으로 예약됩니다. 데이터 유형: 문자열

헤더

표 10. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 11. 응답 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


이름	설명
결과	요청의 결과입니다. 데이터 유형: 객체 `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
결과.오류	필요한 요청 ID 누락 등 콜백 생성 실패에 대한 상세 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"errors": ["String", "String"]`
result.messages	콜백 생성의 성공에 대한 세부 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"messages": ["String", "String"]`
결과.응답	콜백 요청의 콜백 및 상호작용 ID를 포함하는 객체입니다. 데이터 유형: 객체 `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.callback_created	새 콜백 요청이 생성되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 콜백이 성공적으로 작성되었습니다. false: 콜백이 생성되지 않았습니다. 예를 들어, 지정된 callback_id와 함께 콜백이 이미 존재합니다. 데이터 유형: 부울
result.response.callback_id	새 콜백의 Sys_id입니다(해당하는 경우). 테이블: 콜백 [sys_cs_callback] 데이터 유형: 문자열
result.response.interaction_id	새로 생성된 상호작용의 Sys_id입니다. 테이블: 상호작용 [interaction] 데이터 유형: 문자열
결과.상태	요청의 성공 또는 실패 상태입니다. 유효한 값은 다음과 같습니다. 성공 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 에이전트가 요청 본문에 제공하는 세부 정보에 따라 간단한 콜백 요청을 만듭니다.

curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/create' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "type": "immediate",
  "callbackDetails": {
    "appointment": "68cc0a5a9314521060320dd548373cbd",
    "description": "Customer reported issue with order #12345",
    "short_description": "Order issue",
    "reason_type": "product_issue",
    "expire_time": "2025-09-01 17:00",
    "messaging_channel": "web_channel_sys_id",
    "channel_to_callback": "genesys_channel_sys_id",
    "scheduled_start_time: "2025-09-01 1:00",
    "end_time": "2025-09-01 17:00",
    "user_document": "abel.tuter",
    "user_table": "sys_user"
},
  },
  "callbackContext": {
    "queue": "21 value changed via api",
    "ivr_path": "21 some-ivr-path changed via api"
  },
  "inboundId": "ServiceNowVoice",
  "isExternal": true,
  "externalCallbackId": "new-external-id",
  "interactionDetails": {
    "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z",
    "userId": "32423424",
    "callerPhoneNumber": "+14089178877"
  }
}

응답 본문은 새로 생성된 콜백 요청에 대한 콜백 및 상호작용 ID와 함께 성공 응답을 반환합니다.

{
  "status": "success",
  "response": {
    "callback_id": "a16ead53fff0621088c6ffffffffffce",
    "interaction_id": "696e6d57fff0621088c6ffffffffff7d"
  }
}

상호작용 상세 정보가 제공되지 않은 경우의 응답 본문:

{
  "status": "success",
  "response": {
    "callback_created": true,
    "callback_id": "7df2059ffffc221088c6ffffffffff0c"
  }
}

콜백 ID가 이미 있지만 새 상호작용 상세 정보가 제공된 경우의 응답 본문:

{
  "result": {
    "status": "success",
    "response": {
      "interaction_id": "84054fff53786210011eddeeff7b12d6",
      "callback_id": "8b43c3fb53786210011eddeeff7b12a6",
      “callback_created”: false
    },
    "messages": [
      "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6",
      "Successfully created the interaction 84054fff53786210011eddeeff7b12d6"
    ]
  }
}

콜백 ID가 이미 있지만 새 상호작용 상세 정보가 제공되지 않은 경우의 응답 본문:

{
  "result": {
    "status": "success",
    "response": {
      "callback_id": "8b43c3fb53786210011eddeeff7b12a6"
    },
    "messages": [
      "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6"
    ]
  }
}

요청에 필수 필드가 누락된 경우의 응답 본문:

{
  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Parameter 'type' is required in request"
    ]
  }
}

옴니채널 콜백 - PATCH /api/sn_omni_callback/callback/update

요청에 제공된 상세 정보에 따라 기존 콜백을 업데이트합니다.

업데이트하려는 요청 본문에 요청 매개변수만 제공합니다.

URL 형식

기본 URL: /api/sn_omni_callback/callback/update

지원되는 요청 매개변수

표 13. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들어 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열

표 14. 쿼리 매개변수
이름	설명
없음

표 15. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
콜백컨텍스트	콜백 요청에 대한 컨텍스트 상세 정보를 포함하는 객체입니다. 테이블: 콜백 컨텍스트 [sys_cs_callback_context] 데이터 유형: 객체 `"callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String" }`
callbackContext.ivr_path	고객이 실제 에이전트로 전송되기 전에 따르는 IVR(대화형 음성 응답) 경로입니다. 일반적으로 고객이 IVR 시스템에서 탐색한 큐 또는 메뉴 옵션 목록을 포함합니다. 이 문자열은 CCaaS(Contact Center as a Service)에 의해 전달됩니다. 예: `"ivr_path": "기술 지원 > 계정 관리"` 데이터 유형: 문자열
콜백컨텍스트.queue	큐의 번호 할당입니다. 데이터 유형: 문자열
콜백상세 정보	콜백 요청에 대한 상세 정보를 포함하는 객체입니다. 테이블: 콜백 [sys_cs_callback] 데이터 유형: 객체 `"callbackDetails": { "appointment": "String", "channel_to_callback": "String", "description": "String", "end_time": "String", "expire_time": "String", "messaging_channel": String", "reason_type": "String" "scheduled_start_time": "String", "short_description": "String", "user_document": "String", "user_table": "String" }`
callbackDetails.약속	약속의 Sys_id입니다. `예약된` 콜백 유형에만 적용 가능합니다. 테이블: 약속 예약 [sn_apptmnt_booking_appointment_booking] 데이터 유형: 문자열
callbackDetails.channel_to_callback	콜백을 라우팅할 대상 메시징 채널입니다. 테이블: 메시징 채널 [sys_cs_channel], 필드: sys_id 데이터 유형: 문자열
callbackDetails.description	필요한 경우 콜백 이유를 설명하는 전체 설명입니다. 데이터 유형: 문자열
callbackDetails.end_time	콜백 시도를 중지할 날짜 및 시간 값입니다. `예약된` 콜백 유형에만 적용 가능합니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.expire_time	콜백 요청을 종결할 날짜 및 시간입니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.messaging_channel	콜백의 소스입니다. 콜백 요청을 시작한 클라이언트 인터페이스(예: 웹 클라이언트, 모바일 앱 또는 포함된 메신저)를 식별합니다. 테이블: 메시징 채널 [sys_cs_channel], 필드: sys_id 데이터 유형: 문자열
callbackDetails.reason_type	콜백 요청의 이유입니다. 표준화된 이유로 콜백에 태그를 지정하여 라우팅, 분석 및 보고를 지원합니다. 유효한 값은 다음과 같습니다. `기타 문제` 구현에서 정의한 사용자 지정 값입니다. 예: `"청구 문의"`, `"기술 지원"` 테이블: 콜백 [sys_cs_callback], 필드: reason_type 데이터 유형: 문자열
callbackDetails.scheduled_date_time	콜백을 시작하는 날짜 및 시간 값입니다. `예약된` 콜백 유형에만 적용 가능합니다. 형식: glide_date_time 값(예: `yyyy-MM-dd HH:mm:ss)` 데이터 유형: 문자열
callbackDetails.short_description	콜백 요청에 대한 자세한 설명을 제공합니다. 특정 고객 우려 사항, 컨텍스트 또는 에이전트의 메모를 포함할 수 있습니다. 데이터 유형: 문자열
callbackDetails.user_document	콜백을 요청한 사용자의 Sys_id입니다. 콜백을 요청하는 사용자를 식별하는 데 사용됩니다 callbackDetails.user_table . 테이블: 사용자 [sys_user], 필드: sys_id 데이터 유형: 문자열
callbackDetails.user_table	사용자 기록이 있는 테이블입니다. 콜백을 요청하는 사용자를 식별하는 데 사용됩니다 callbackDetails.user_document . 값은 항상 `sys_user`입니다. 데이터 유형: 문자열
콜백ID	필수 콜백의 Sys_id 또는 external_id입니다. 테이블: 콜백 [sys_cs_callback] 데이터 유형: 문자열
inboundId	콜백과 연결된 인바운드 호출의 Sys_id입니다. 콜백 요청을 외부 공급업체 제공자 또는 CCaaS 플랫폼에서 발생할 수 있는 특정 인바운드 통화 기록에 연결하는 추적 가능성을 제공합니다. 테이블: 콜백 [sys_cs_callback], 필드: provider_application_id 데이터 유형: 문자열
phoneNumber	호출자의 전화 번호입니다. 데이터 유형: 숫자의 문자열 형식: E.164 표준 준수

헤더

표 16. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 17. 응답 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 18. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


이름	설명
오류	필요한 요청 ID 누락 등 콜백 생성 실패에 대한 상세 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"errors": ["String", "String"]`
메시지	콜백 생성의 성공에 대한 세부 정보가 포함된 메시지입니다. 데이터 유형: 문자열 배열 `"messages": ["String", "String"]`
결과	요청의 결과입니다. 데이터 유형: 객체 `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
결과.응답	콜백 요청의 콜백 및 상호작용 ID를 포함하는 객체입니다. 데이터 유형: 객체 `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.callback_created	새 콜백 요청이 생성되었는지 여부를 나타내는 플래그입니다. 가능한 값: true: 콜백이 성공적으로 작성되었습니다. false: 콜백이 생성되지 않았습니다. 예를 들어, 지정된 callback_id와 함께 콜백이 이미 존재합니다. 데이터 유형: 부울
result.response.callback_id	새 콜백의 Sys_id입니다(해당하는 경우). 테이블: 콜백 [sys_cs_callback] 데이터 유형: 문자열
result.response.interaction_id	새로 생성된 상호작용의 Sys_id입니다. 테이블: 상호작용 [interaction] 데이터 유형: 문자열
결과.상태	요청의 성공 또는 실패 상태입니다. 유효한 값은 다음과 같습니다. 성공 실패 데이터 유형: 문자열

cURL 요청

다음 예제에서는 연결된 콜백 요청에서 일부 콜백 세부 정보를 업데이트합니다.

curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/update' \ 
  -H 'Accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -u 'username':'password' \ 
  -d ' {
  "callbackDetails": {
    "appointment": "68cc0a5a9314521060320dd548373cbd",
    "description": "Customer reported issue with order #12345",
    "short_description": "Order issue",
    "reason_type": "product_issue",
    "expire_time": "2025-09-01 17:00",
    "messaging_channel": "web_channel_sys_id",
    "channel_to_callback": "genesys_channel_sys_id",
    "scheduled_start_time: "2025-09-01 1:00",
    "end_time": "2025-09-01 17:00",
    "user_document": "abel.tuter",
    "user_table": "sys_user"
},
  "callbackContext": {
    "queue": "5 value changed via api",
    "ivr_path": "5 some-ivr-path changed via api"
  },
  "inboundId": "AmazonConnect",
  "phoneNumber": "+14089178877",
  "callbackId": "a16ead53fff0621088c6ffffffffffce"
}

유효한 기존 콜백 ID에 대한 성공적인 업데이트 응답입니다.

{
  "result": {
    "status": "success",
    "response": {
      "callback_id": "952f763b53786210011eddeeff7b1297"
    },
    "messages": [
      "Successfully updated the callback 952f763b53786210011eddeeff7b1297"
    ]
  }
}

요청에 잘못된 콜백 ID가 제공된 경우의 응답:


  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Callback not found for callback ID: 952f763b53786210011eddeef7b1297"
    ]
  }
}

요청에 콜백 ID가 누락된 경우의 응답:


  "result": {
    "status": "failure",
    "response": {
      "callbackId": null
    },
    "errors": [
      "Parameter 'callbackId' is required in request"
    ]
  }
}