---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API Gestão de interações

# API Gestão de interações {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 min. de leitura

A API Gestão de interações fornece endpoints para criar interações.
Esta classe requer o plug-in Registro em log, roteamento e enfileiramento de interações (com.glide.interaction).

## Interação - POST /now/interaction {#ariaid-title2}

Insere ou atualiza um registro na tabela de interação.

### Formato da URL {#interaction-POST__section_msq_nfz_cmb}

URL com controle de versão: /api/now/{api_version}/interaction

URL padrão: /api/now/interaction

### Parâmetros de solicitação compatíveis

{#interaction-POST__entry__2}{#interaction-POST__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#interaction-POST__entry__6}

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

{#interaction-POST__entry__10}

| Elemento | Descrição |
|-|-|
| canal | Obrigatório. Sys_id do conector de interação para o qual você deseja criar uma interação. Tipo de dados: cadeia de caracteres |
| contexto | Um mapa ou um par de tabela/sys_id. Por padrão, as interações têm um registro na tabela interaction_json_blob que armazena dados de contexto como um objeto JSON. Você pode apontar uma interação para um registro diferente para contexto. Use context ou context_table/context_id para definir o contexto de uma interação. Tipo de dados: cadeia de caracteres |
| context_id | ID de documento de um registro que você deseja usar para armazenar contexto. O padrão é um novo registro na tabela insteraction_json_blob. Se você definir o ID de contexto, também precisará definir a tabela. Tipo de dados: cadeia de caracteres |
| tabela_contexto | Tabela de contexto que você deseja usar para armazenar o contexto de interação de. O padrão é interaction_json_blob. Se você definir a tabela de contexto, também precisará definir o ID de contexto. Tipo de dados: cadeia de caracteres |
| canal_metadados | Mapa ou um par tabela/sys_id. Os metadados do canal contêm informações que um conector pode usar para se comunicar por meio do canal associado. Tipo de dados: cadeia de caracteres |
| canal_metadata_id | ID do documento de um registro que você deseja usar para armazenar metadados do canal. O padrão é um novo registro na tabela live_group_profile. Se você definir o ID de metadados do canal, também precisará definir a tabela. Tipo de dados: cadeia de caracteres |
| canal_metadados_tabela | Tabela que você deseja usar para armazenar metadados de canal. O padrão é a tabela live_group_profile. Se você definir a tabela de metadados do canal, também precisará definir o ID de metadados do canal. Tipo de dados: cadeia de caracteres |
| fila | Sys_id da fila que você deseja associar à interação. Tipo de dados: cadeia de caracteres |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#interaction-POST__entry__28}{#interaction-POST__accept-RESTAPI}{#interaction-POST__content_type-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 4. Cabeçalhos da solicitação]

{#interaction-POST__entry__34}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#interaction-POST__entry__38}{#interaction-POST__entry-401-status-code}{#interaction-POST__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 201 | Indica que a consulta foi executada com sucesso. |
| 400 | Indica que um ou mais parâmetros obrigatórios estavam ausentes na solicitação. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]

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

{#interaction-POST__table_bsj_y3z_cmb__entry__2}

| Elemento | Descrição |
|-|-|
| assigned_to | O sys_id do usuário ao qual a interação está atribuída. Tipo de dados: cadeia de caracteres |
| channelMetadataDocument | O sys_id do documento de metadados do canal associado à interação. Tipo de dados: cadeia de caracteres |
| channelMetadataTable | O nome da tabela de metadados de canal associada à interação. Tipo de dados: cadeia de caracteres |
| canal_metadados | Todos os metadados de canal incluídos para a interação. Tipo de dados: cadeia de caracteres |
| closed_by | O sys_id do usuário que encerrou a interação. Tipo de dados: cadeia de caracteres |
| DocumentDocumentocontexto | O sys_id do documento de contexto associado à interação. Tipo de dados: cadeia de caracteres |
| contextTable | O nome da tabela associada à interação. Tipo de dados: cadeia de caracteres |
| número | O número da nova interação. Tipo de dados: cadeia de caracteres |
| aberto_para | O sys_id do usuário para o qual a interação foi aberta. Tipo de dados: cadeia de caracteres |
| fila | O sys_id da fila para a qual você cria a interação. Tipo de dados: cadeia de caracteres |
| estado | O estado em que a interação está. Se você atribuir uma fila, o estado será alterado automaticamente para Em fila, caso contrário, o padrão será Novo. Tipo de dados: cadeia de caracteres |
| sys_id | O sys_id da interação. Tipo de dados: cadeia de caracteres |
[ ]

{#interaction-POST__table_bsj_y3z_cmb}  

### Amostra de solicitação cURL

    curl "http://instance.servicenow.com/api/now/interaction" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{\"channel\":\"28a59893873103002ae97e2526cb0b5d\",\"queue\":\"f3a50867b30303002186a72256a8dcb7\"}" \
    --user "username":"password"

    {
      "result": {
        "channel": "28a59893873103002ae97e2526cb0b5d",
        "context": {
          "present": true
        },
        "queue": "f3a50867b30303002186a72256a8dcb7",
        "state": "queued",
        "number": "IMS0000075",
        "contextDocument": "1863a6f0d9471300964f387107a8a36d",
        "contextTable": "interaction_json_blob",
        "channelMetadataDocument": "9463a6f0d9471300964f387107a8a36c",
        "channelMetadataTable": "live_group_profile",
        "channel_metadata": {
          "present": true
        },
        "sys_id": "dc63a6f0d9471300964f387107a8a36b",
        "assigned_to": "",
        "closed_by": "",
        "opened_for": ""
      }
    }

## Interação - POST /now/interaction/{interaction_id}/close {#ariaid-title3}

Altera o estado de uma interação para encerrado ou encerrado concluído.

### Formato da URL {#interaction-POST-close__section_qhp_23z_cmb}

URL com controle de versão: /api/now/{api_version}interaction/{interaction_id}/close

URL padrão: /api/now/interaction/{interaction_id}/close

### Parâmetros de solicitação compatíveis

{#interaction-POST-close__entry__2}{#interaction-POST-close__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| interaction_id | Sys_id da interação que você deseja fechar. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#interaction-POST-close__entry__8}

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

{#interaction-POST-close__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#interaction-POST-close__entry__16}{#interaction-POST-close__accept-RESTAPI}{#interaction-POST-close__content_type-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou application/xml. Padrão: application/json |
[Tabela 10. Cabeçalhos da solicitação]

{#interaction-POST-close__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#interaction-POST-close__entry__26}{#interaction-POST-close__entry-200-status-code}{#interaction-POST-close__entry-401-status-code}{#interaction-POST-close__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 401 | Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]

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

{#interaction-POST-close__table_ykz_y3z_cmb__entry__2}

| Elemento | Descrição |
|-|-|
| assigned_to | O sys_id do usuário ao qual a interação está atribuída. Tipo de dados: cadeia de caracteres |
| channelMetadataDocument | O sys_id do documento de metadados do canal associado à interação. Tipo de dados: cadeia de caracteres |
| channelMetadataTable | O nome da tabela de metadados de canal associada à interação. Tipo de dados: cadeia de caracteres |
| canal_metadados | Todos os metadados de canal incluídos para a interação. Tipo de dados: cadeia de caracteres |
| closed_by | O sys_id do usuário que encerrou a interação. Tipo de dados: cadeia de caracteres |
| DocumentDocumentocontexto | O sys_id do documento de contexto associado à interação. Tipo de dados: cadeia de caracteres |
| contextTable | O nome da tabela associada à interação. Tipo de dados: cadeia de caracteres |
| número | O número da nova interação. Tipo de dados: cadeia de caracteres |
| aberto_para | O sys_id do usuário para o qual a interação foi aberta. Tipo de dados: cadeia de caracteres |
| fila | O sys_id da fila para a qual você cria a interação. Tipo de dados: cadeia de caracteres |
| estado | O estado em que a interação está. Se você atribuir uma fila, o estado será alterado automaticamente para Em fila, caso contrário, o padrão será Novo. Tipo de dados: cadeia de caracteres |
| sys_id | O sys_id da interação. Tipo de dados: cadeia de caracteres |
[ ]

{#interaction-POST-close__table_ykz_y3z_cmb}  

### Amostra de solicitação cURL

    curl "http://instance.servicenow.com/api/now/interaction/b243cde4208f1700964f959e0488dee8/close" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user "username":"password"

    {
      "result": {
        "channel": "28a59893873103002ae97e2526cb0b5d",
        "context": {
          "present": true
        },
        "queue": "f3a50867b30303002186a72256a8dcb7",
        "state": "closed_complete",
        "number": "IMS0000060",
        "contextDocument": "3a43cde4208f1700964f959e0488dee7",
        "contextTable": "interaction_json_blob",
        "channelMetadataDocument": "fa43cde4208f1700964f959e0488dee8",
        "channelMetadataTable": "live_group_profile",
        "channel_metadata": {
          "present": true
        },
        "sys_id": "b243cde4208f1700964f959e0488dee8",
        "assigned_to": "",
        "closed_by": "6816f79cc0a8016401c5a33be04be441",
        "opened_for": "46d44a23a9fe19810012d100cca80666"
      }
    }