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


---

# Conversa - com escopo

# Conversa - com escopo {#ariaid-title1}

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

A API de conversa permite que você crie ou modifique conversas do Connect.

Para usar esta classe em uma aplicação com escopo, use o identificador de namespace `sn_connect`. O plug-in Connect Scriptable APIs (ID: com.glide.connect.scriptable) deve ser habilitado para acessar a API de conversa.

## Conversa - addSubscriber(String sysID) {#ariaid-title2}

Adiciona um usuário a uma conversa.
{#conversation-addSubscriber_string__table_e3k_bmx_cbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sysID | Cadeia de caracteres | Sys_ID do usuário que você deseja adicionar a uma conversa. |
[Tabela 1. Parâmetros]

{#conversation-addSubscriber_string__table_e3k_bmx_cbb} {#conversation-addSubscriber_string__table_f3k_bmx_cbb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 2. Retorna]

{#conversation-addSubscriber_string__table_f3k_bmx_cbb}  

    var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");
    conversation.addSubscriber("a8f98bb0eb32010045e1a5115206fe3a");

## Conversa - create(String name) {#ariaid-title3}

Cria uma conversa Connect.
{#conversation-create_String_String__table_lwg_b4w_cbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| nome | Cadeia de caracteres | Crie uma conversa com um nome específico. |
| tipo | Cadeia de caracteres | Inclua um tipo de conversa específico. O tipo é determinado pela lista de seleção de tipos. O sistema de base inclui as seguintes opções de tipo: * conectar * suporte * grupo * colega * qanda * equipe {#conversation-create_String_String__ul_ut2_4df_wbb} |
[Tabela 3. Parâmetros]

{#conversation-create_String_String__table_lwg_b4w_cbb} {#conversation-create_String_String__table_mwg_b4w_cbb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Conversa programável |
[Tabela 4. Retorna]

{#conversation-create_String_String__table_mwg_b4w_cbb}  

    var conversation = sn_connect.Conversation.create({
        name: "Hello world",
        type: "connect"
    });

## Conversa - get(String sysID) {#ariaid-title4}

Retorna uma conversa existente do Connect por sys_id.
{#conversation-get-string__table_zkg_1x5_bbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| sysID | Cadeia de caracteres | O sys_id do registro da conversa. |
[Tabela 5. Parâmetros]

{#conversation-get-string__table_zkg_1x5_bbb} {#conversation-get-string__table_alg_1x5_bbb__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Objeto de conversa |
[Tabela 6. Retorna]

{#conversation-get-string__table_alg_1x5_bbb}  

    var conversation = sn_connect.Conversation.get("27b9844c1385030034bb58a12244b037");

## Conversa - removeSubscriber(String sysID) {#ariaid-title5}

Remove um usuário de uma conversa.
{#conversation-removeSubscriber_string__table_e3k_bmx_cbb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| SysID | Cadeia de caracteres | O sys_id do usuário que você deseja remover de uma conversa. |
[Tabela 7. Parâmetros]

{#conversation-removeSubscriber_string__table_e3k_bmx_cbb} {#conversation-removeSubscriber_string__table_f3k_bmx_cbb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 8. Retorna]

{#conversation-removeSubscriber_string__table_f3k_bmx_cbb}  

    var conversation = sn_connect.Conversation.get("7caf49111309030034bb58a12244b06c");
    conversation.removeSubscriber("a8f98bb0eb32010045e1a5115206fe3a");

## Conversa - sendMessage(Corpo da cadeia de caracteres, campo da cadeia de caracteres) {#ariaid-title6}

Envia uma mensagem para uma conversa.
{#conversation-sendMessage_String_String__table_kcw_pmv_2bb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Corpo | Cadeia de caracteres | O texto principal da mensagem. |
| Campo | Cadeia de caracteres | O campo como você deseja que a mensagem apareça. Use esta opção somente se adicionar uma mensagem a uma conversa de registro. Escolha entre work_notes, comentários ou sistema. O uso do sistema de campo trata a mensagem como uma mensagem do sistema. |
[Tabela 9. Parâmetros]

{#conversation-sendMessage_String_String__table_kcw_pmv_2bb} {#conversation-sendMessage_String_String__table_lcw_pmv_2bb__entry__2}

| Tipo | Descrição |
|-|-|
| vazio |   |
[Tabela 10. Retorna]

{#conversation-sendMessage_String_String__table_lcw_pmv_2bb}  

    var conversation = sn_connect.Conversation.get("2064fa3919010300964f5270e9840fbb");
    conversation.sendMessage({body: "Hello world", field: "work_notes"});