API de retorno de chamada Omichannel

Referência de API Zurich

Release

zurich

ft:locale

pt-BR

ft:publication_title

Referência de API Zurich

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

API de retorno de chamada Omichannel

Versão de lançamento: Zurich

Atualizado 1 de ago. de 2025

18 min. de leitura

. Retorno de chamada omnicanal A API fornece métodos para criar ou atualizar uma solicitação de retorno de chamada e recuperar metadados relacionados de um provedor CCaaS (Contact Center as a Service, Centro de contato como serviço).

. Retorno de chamada omnicanal A API permite que os agentes chamem os usuários de forma programática em vez de esperar na fila por um agente disponível. Por exemplo, os agentes podem usar a funcionalidade de retorno de chamada para chamar os usuários de volta quando o tempo de espera do agente for longo ou quando não houver agentes disponíveis. Você pode executar as seguintes ações com esta API:

Crie uma nova solicitação de retorno de chamada imediata ou programe uma nova solicitação.
Crie uma interação inicial e interações de novas tentativas subsequentes.
Atualize um retorno de chamada existente.

Esta API pertence ao namespace sn_omni_callback e requer a função Administrador com API de retorno de chamada [sn_omni_callback.callback_api].

Para obter mais informações sobre Retorno de chamada omnicanal aplicação como um ServiceNow Capacidade da plataforma de IA, consulte Omnichannel Callback.

Retorno de chamada omnicanal - POST /api/sn_omni_callback/callback/attempt

Inicia uma interação para um retorno de chamada existente, incluindo tentativas de novas tentativas.

Formato de URL

URL padrão: /api/sn_omni_callback/callback/attempt

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 2. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
CallbackID	Obrigatório. Sys_id ou external_id do retorno de chamada. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Cadeia de caracteres
InteractionDetails	Opcional. Detalhes sobre a interação. Destinado a tipos de retorno de chamada imediato para que os detalhes da interação sejam roteados diretamente para o agente sem esperar. Todos os detalhes da interação são passados na carga do Recurso de interação de voz - POST /cs/voice-interactions. Tipo de dados: Objeto `"interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" }`
interactionDetails.callerPhoneNumber	Número de telefone de retorno de chamada do chamador. Este é o número que o agente usa para entrar em contato com o solicitante caso a chamada seja descartada. Tipo de dados: Cadeia de caracteres E.164 em conformidade com o padrão Padrão: Nenhum
InteractionDetails.clientSessionId	Identificador exclusivo de um registro em um sistema externo usado para rastrear esta chamada telefônica em sistemas, permitindo a integração entre a ServiceNow e plataformas de terceiros (por exemplo, provedores de CCaaS). Tipo de dados: Cadeia de caracteres Formato: Normalmente um UUID ou token de sessão exclusivo gerado pelo sistema externo Padrão: Nenhum
interactionDetails.userId	Sys_id do usuário para retornar chamada. Tabela: Usuário [user] Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 5. Cabeçalhos de resposta
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)


Nome	Descrição
erros	Mensagem que contém detalhes sobre as falhas da criação do retorno de chamada, como IDs de solicitação obrigatórios ausentes. Tipo de dados: Matriz de cadeias de caracteres `"errors": ["String", "String"]`
mensagens	Mensagem que contém detalhes sobre o sucesso da criação do retorno de chamada. Tipo de dados: Matriz de cadeias de caracteres `"messages": ["String", "String"]`
resultado	Resultado da solicitação. Tipo de dados: Objeto `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
result.response	Objeto que contém IDs de retorno de chamada e interação da solicitação de retorno de chamada. Tipo de dados: Objeto `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.interaction_id	Sys_id da interação recém-criada. Tabela: Interação [interaction] Tipo de dados: Cadeia de caracteres
result.status	Status de sucesso ou falha da solicitação. Valores válidos: êxito falha Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir demonstra uma solicitação de tentativa POST com detalhes sobre a interação inicial e as interações de novas tentativas subsequentes.

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"
  }
}

Corpo da resposta quando um callback_id válido é fornecido e uma nova interação foi criada com sucesso para o retorno de chamada.

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

Corpo da resposta quando um callback_id inválido foi fornecido na solicitação.

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

Corpo da resposta quando a interação já existe para o retorno de chamada fornecido (a mensagem retorna detalhes sobre a interação existente):

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

Omichannel Callback - POST /api/sn_omni_callback/callback/create

Inicia uma nova solicitação de retorno de chamada imediata ou programada com base nos detalhes fornecidos no corpo da solicitação. Para retornos de chamada imediatos, esta API cria o retorno de chamada e a interação. Para retornos de chamada agendados, cria o retorno de chamada e um compromisso.

Formato de URL

URL padrão: /api/sn_omni_callback/callback/create

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 8. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Context de chamada	Objeto que contém os detalhes de contexto sobre a solicitação de retorno de chamada. Tabela: Contexto de retorno de chamada [sys_cs_callback_context] Tipo de dados: Objeto `"callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String" }`
CallbackContext.ivr_path	O caminho de RVI (Resposta de voz interativa) que um cliente segue antes de ser transferido para um agente humano. Normalmente contém uma lista de filas ou opções de menu pelas quais o cliente navegou no sistema RVI. Esta cadeia de caracteres é passada pelo Contact Center as a Service (CCaaS). Por exemplo, `"ivr_path": "Suporte técnico > Gestão de contas"` Tipo de dados: Cadeia de caracteres
CallbackContext.queue	Atribuições numéricas na fila. Tipo de dados: Cadeia de caracteres
CallbackDetails	Objeto que contém os detalhes sobre a solicitação de retorno de chamada. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Objeto `"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.compromisso	Sys_id do compromisso. Aplicável somente a um `Programado` tipo de retorno de chamada. Tabela: Agendamento de compromisso [sn_apptmnt_booking_appointment_booking] Tipo de dados: Cadeia de caracteres
callbackDetails.channel_to_callback	Canal de envio de mensagens de destino para rotear o retorno de chamada. Tabela: Canal de envio de mensagens [sys_cs_channel], Campo: Sys_id Tipo de dados: Cadeia de caracteres
callbackDetails.description	Descrição completa descrevendo o motivo do retorno de chamada, se necessário. Tipo de dados: Cadeia de caracteres
CallbackDetails.end_time	Valor de data e hora para interromper a tentativa de retorno de chamada. Aplicável somente a um `Programado` tipo de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.expire_time	Data e hora para fechar a solicitação de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.messaging_channel	Origem do retorno de chamada. Identifica a interface do cliente que iniciou a solicitação de retorno de chamada, como um cliente web, aplicativo para celular ou messenger incorporado. Tabela: Canal de envio de mensagens [sys_cs_channel], Campo: Sys_id Tipo de dados: Cadeia de caracteres
CallbackDetails.reason_type	Motivo da solicitação de retorno de chamada. Ajuda com roteamento, análise e emissão de relatórios marcando o retorno de chamada com um motivo padronizado. Valores válidos: `Outro problema` Valores personalizados definidos pela sua implementação. Por exemplo, `"Consulta de faturamento"` , `"Suporte técnico"` Tabela: Retorno de chamada [sys_cs_callback], Campo: Reason_type Tipo de dados: Cadeia de caracteres
CallbackDetails.scheduled_date_time	Valor de data e hora para iniciar o retorno de chamada. Aplicável somente a um `Programado` tipo de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.short_description	Fornece uma explicação detalhada da solicitação de retorno de chamada. Pode incluir preocupações específicas do cliente, contexto ou anotações do agente. Tipo de dados: Cadeia de caracteres
callbackDetails.user_document	Sys_id do usuário que solicitou o retorno de chamada. Usado com callbackDetails.user_tablepara identificar o usuário que está solicitando o retorno de chamada. Tabela: Usuário [sys_user], Campo: Sys_id Tipo de dados: Cadeia de caracteres
callbackDetails.user_table	Tabela em que reside o registro do usuário. Usado com callbackDetails.user_documentpara identificar o usuário que está solicitando o retorno de chamada. O valor é sempre `sys_user` . Tipo de dados: Cadeia de caracteres
ExternalCallbackId	Identificador externo do retorno de chamada que foi criado em um fornecedor de terceiros. Tipo de dados: Cadeia de caracteres
inboundId	Sys_id da chamada de entrada associada ao retorno de chamada. Fornece rastreabilidade vinculando a solicitação de retorno de chamada a um registro de chamada de entrada específico que pode se originar de um provedor de terceiros ou plataforma CCaaS. Tabela: Retorno de chamada [sys_cs_callback], Campo: Provider_application_id Tipo de dados: Cadeia de caracteres
InteractionDetails	Opcional. Detalhes sobre a interação. Destinado a tipos de retorno de chamada imediato para que os detalhes da interação sejam roteados diretamente para o agente sem esperar. Todos os detalhes da interação são passados na carga do Recurso de interação de voz - POST /cs/voice-interactions. Tipo de dados: Objeto `"interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" }`
interactionDetails.callerPhoneNumber	Número de telefone de retorno de chamada do chamador. Este é o número que o agente usa para entrar em contato com o solicitante caso a chamada seja descartada. Tipo de dados: Cadeia de caracteres E.164 em conformidade com o padrão Padrão: Nenhum
InteractionDetails.clientSessionId	Identificador exclusivo de um registro em um sistema externo usado para rastrear esta chamada telefônica em sistemas, permitindo a integração entre a ServiceNow e plataformas de terceiros (por exemplo, provedores de CCaaS). Tipo de dados: Cadeia de caracteres Formato: Normalmente um UUID ou token de sessão exclusivo gerado pelo sistema externo Padrão: Nenhum
interactionDetails.userId	Sys_id do usuário para retornar chamada. Tabela: Usuário [user] Tipo de dados: Cadeia de caracteres
isExternal	Sinalizador que indica se o retorno de chamada é externo e foi solicitado em um fornecedor de terceiros diferente. Valores válidos: Retorno de chamada é externo. Retorno de chamada não é externo. Padrão: falso
tipo	Obrigatório. Tipo de retorno de chamada. Valores válidos: `imediato` : A interação de retorno de chamada é criada instantaneamente. `programado` : A interação de retorno de chamada é criada e programada para um horário posterior selecionado pelo cliente. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Tabela 10. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 11. Cabeçalhos de resposta
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)


Nome	Descrição
resultado	Resultado da solicitação. Tipo de dados: Objeto `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
resultado.erros	Mensagem que contém detalhes sobre as falhas da criação do retorno de chamada, como IDs de solicitação obrigatórios ausentes. Tipo de dados: Matriz de cadeias de caracteres `"errors": ["String", "String"]`
resultado.mensagens	Mensagem que contém detalhes sobre o sucesso da criação do retorno de chamada. Tipo de dados: Matriz de cadeias de caracteres `"messages": ["String", "String"]`
result.response	Objeto que contém IDs de retorno de chamada e interação da solicitação de retorno de chamada. Tipo de dados: Objeto `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.callback_created	Sinalizador que indica se a nova solicitação de retorno de chamada foi criada ou não. Valores possíveis: Retorno de chamada criado com sucesso. Retorno de chamada não criado. Por exemplo, o retorno de chamada já existe com o callback_id fornecido. Tipo de dados: Booliano
result.response.callback_id	Sys_id do novo retorno de chamada, se aplicável. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Cadeia de caracteres
result.response.interaction_id	Sys_id da interação recém-criada. Tabela: Interação [interaction] Tipo de dados: Cadeia de caracteres
result.status	Status de sucesso ou falha da solicitação. Valores válidos: êxito falha Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir cria uma solicitação de retorno de chamada simples de acordo com os detalhes fornecidos pelo agente no corpo da solicitação.

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"
  }
}

O corpo da resposta retorna uma resposta de sucesso com IDs de retorno de chamada e interação para a solicitação de retorno de chamada recém-criada.

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

Corpo da resposta quando os detalhes da interação não foram fornecidos:

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

Corpo da resposta quando o ID de retorno de chamada já existe, mas novos detalhes da interação foram fornecidos:

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

Corpo da resposta quando o ID de retorno de chamada já existe, mas os novos detalhes da interação não foram fornecidos:

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

Corpo da resposta quando os campos obrigatórios estão ausentes na solicitação:

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

Retorno de chamada omnicanal - PATCH /api/sn_omni_callback/callback/update

Atualiza um retorno de chamada existente de acordo com os detalhes fornecidos na solicitação.

Forneça parâmetros de solicitação somente no corpo da solicitação que você deseja atualizar.

Formato de URL

URL padrão: /api/sn_omni_callback/callback/callback/update

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
api_version	Opcional. Versão do endpoint a ser acessado. Por exemplo, `v1` ou `v2` . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
Nome	Descrição
Context de chamada	Objeto que contém os detalhes de contexto sobre a solicitação de retorno de chamada. Tabela: Contexto de retorno de chamada [sys_cs_callback_context] Tipo de dados: Objeto `"callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String" }`
CallbackContext.ivr_path	O caminho de RVI (Resposta de voz interativa) que um cliente segue antes de ser transferido para um agente humano. Normalmente contém uma lista de filas ou opções de menu pelas quais o cliente navegou no sistema RVI. Esta cadeia de caracteres é passada pelo Contact Center as a Service (CCaaS). Por exemplo, `"ivr_path": "Suporte técnico > Gestão de contas"` Tipo de dados: Cadeia de caracteres
CallbackContext.queue	Atribuições numéricas na fila. Tipo de dados: Cadeia de caracteres
CallbackDetails	Objeto que contém os detalhes sobre a solicitação de retorno de chamada. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Objeto `"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.compromisso	Sys_id do compromisso. Aplicável somente a um `Programado` tipo de retorno de chamada. Tabela: Agendamento de compromisso [sn_apptmnt_booking_appointment_booking] Tipo de dados: Cadeia de caracteres
callbackDetails.channel_to_callback	Canal de envio de mensagens de destino para rotear o retorno de chamada. Tabela: Canal de envio de mensagens [sys_cs_channel], Campo: Sys_id Tipo de dados: Cadeia de caracteres
callbackDetails.description	Descrição completa descrevendo o motivo do retorno de chamada, se necessário. Tipo de dados: Cadeia de caracteres
CallbackDetails.end_time	Valor de data e hora para interromper a tentativa de retorno de chamada. Aplicável somente a um `Programado` tipo de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.expire_time	Data e hora para fechar a solicitação de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.messaging_channel	Origem do retorno de chamada. Identifica a interface do cliente que iniciou a solicitação de retorno de chamada, como um cliente web, aplicativo para celular ou messenger incorporado. Tabela: Canal de envio de mensagens [sys_cs_channel], Campo: Sys_id Tipo de dados: Cadeia de caracteres
CallbackDetails.reason_type	Motivo da solicitação de retorno de chamada. Ajuda com roteamento, análise e emissão de relatórios marcando o retorno de chamada com um motivo padronizado. Valores válidos: `Outro problema` Valores personalizados definidos pela sua implementação. Por exemplo, `"Consulta de faturamento"` , `"Suporte técnico"` Tabela: Retorno de chamada [sys_cs_callback], Campo: Reason_type Tipo de dados: Cadeia de caracteres
CallbackDetails.scheduled_date_time	Valor de data e hora para iniciar o retorno de chamada. Aplicável somente a um `Programado` tipo de retorno de chamada. Valor Glide_date_time, como `aaaa-MM-dd HH:mm:ss` Tipo de dados: Cadeia de caracteres
CallbackDetails.short_description	Fornece uma explicação detalhada da solicitação de retorno de chamada. Pode incluir preocupações específicas do cliente, contexto ou anotações do agente. Tipo de dados: Cadeia de caracteres
callbackDetails.user_document	Sys_id do usuário que solicitou o retorno de chamada. Usado com callbackDetails.user_tablepara identificar o usuário que está solicitando o retorno de chamada. Tabela: Usuário [sys_user], Campo: Sys_id Tipo de dados: Cadeia de caracteres
callbackDetails.user_table	Tabela em que reside o registro do usuário. Usado com callbackDetails.user_documentpara identificar o usuário que está solicitando o retorno de chamada. O valor é sempre `sys_user` . Tipo de dados: Cadeia de caracteres
CallbackID	Obrigatório. Sys_id ou external_id do retorno de chamada. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Cadeia de caracteres
inboundId	Sys_id da chamada de entrada associada ao retorno de chamada. Fornece rastreabilidade vinculando a solicitação de retorno de chamada a um registro de chamada de entrada específico que pode se originar de um provedor de terceiros ou plataforma CCaaS. Tabela: Retorno de chamada [sys_cs_callback], Campo: Provider_application_id Tipo de dados: Cadeia de caracteres
phoneNumber	Número de telefone do chamador. Tipo de dados: Cadeia de caracteres de números E.164 em conformidade com o padrão

Cabeçalhos

Tabela 16. Cabeçalhos da solicitação
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Tabela 17. Cabeçalhos de resposta
Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml. Padrão: application/json

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status
Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
500	Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

Parâmetros do corpo da resposta (JSON ou XML)


Nome	Descrição
erros	Mensagem que contém detalhes sobre as falhas da criação do retorno de chamada, como IDs de solicitação obrigatórios ausentes. Tipo de dados: Matriz de cadeias de caracteres `"errors": ["String", "String"]`
mensagens	Mensagem que contém detalhes sobre o sucesso da criação do retorno de chamada. Tipo de dados: Matriz de cadeias de caracteres `"messages": ["String", "String"]`
resultado	Resultado da solicitação. Tipo de dados: Objeto `"result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] }`
result.response	Objeto que contém IDs de retorno de chamada e interação da solicitação de retorno de chamada. Tipo de dados: Objeto `"response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" }`
result.response.callback_created	Sinalizador que indica se a nova solicitação de retorno de chamada foi criada ou não. Valores possíveis: Retorno de chamada criado com sucesso. Retorno de chamada não criado. Por exemplo, o retorno de chamada já existe com o callback_id fornecido. Tipo de dados: Booliano
result.response.callback_id	Sys_id do novo retorno de chamada, se aplicável. Tabela: Retorno de chamada [sys_cs_callback] Tipo de dados: Cadeia de caracteres
result.response.interaction_id	Sys_id da interação recém-criada. Tabela: Interação [interaction] Tipo de dados: Cadeia de caracteres
result.status	Status de sucesso ou falha da solicitação. Valores válidos: êxito falha Tipo de dados: Cadeia de caracteres

Solicitação de curl

O exemplo a seguir atualiza alguns detalhes de retorno de chamada na solicitação de retorno de chamada associada.

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"
}

Resposta de uma atualização bem-sucedida do ID de retorno de chamada válido existente.

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

Resposta quando um ID de retorno de chamada inválido é fornecido na solicitação:


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

Resposta quando um ID de retorno de chamada está ausente na solicitação:


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