Referência de integração de SMS

Editar online

Inclua comandos de ação no objeto context de mensagem para gerenciar o fluxo de conversas com os clientes que interagem com o assistente enviando mensagens SMS pelo telefone.

Atualmente, esse recurso não está disponível no construtor de assistente de IA do IBM watsonx Orchestrate.

Saiba mais sobre os comandos compatíveis e as variáveis de contexto reservadas que são usadas pela integração do SMS.

Comandos suportados

Cada ação consiste em uma propriedade command, seguida por uma propriedade parameter opcional para definir parâmetros para os comandos que os exigem. Os comandos descritos na tabela a seguir são compatíveis com a integração do SMS.

Tabela 1. Tabela 1. Ações que podem ser iniciadas da ação
Comando de ação	Descrição	Parâmetros
`terminateSession`	Termina a sessão de SMS atual. Use esse comando para assegurar que a mensagem de texto subsequente inicie uma nova sessão em nível de assistente que não retenha valores de contexto da sessão atual.	Nenhum
`smsActSendMedia`	Ativa o sistema de mensagens MMS.	`mediaURL`: especifica uma matriz JSON de URLs de mídia publicamente acessíveis que são enviadas para o usuário.
`smsActSetDisambiguationConfig`	Configura como manipular as opções exibidas em uma lista de desambiguação.	`prefixText`: texto para incluir antes de cada opção. Por exemplo, `Press %s for` em que `%s` representa o número correspondente a uma opção da lista; ele é substituído pelo número real no tempo de execução.
`smsActSetOptionsConfig`	Configura como manipular tipos de resposta de opção.	`prefixText`: texto para incluir antes de cada opção. Por exemplo, `Press %s for` em que `%s` representa o número correspondente a uma opção da lista; ele é substituído pelo número real no tempo de execução.

Variáveis de contexto reservadas

A tabela a seguir descreve as variáveis de contexto que têm um significado especial no contexto da integração do SMS. Elas não devem ser usadas para qualquer finalidade diferente do uso documentado.

A Tabela 2 descreve as variáveis de contexto configuradas por sua ação. A Tabela 3 descreve as variáveis de contexto que você pode definir com a integração do SMS.

Tabela 2. Variáveis de contexto que são configuradas por sua ação

Tabela 2. Tabela 2. Variáveis de contexto do SMS configuradas pela ação
Nome da variável de contexto	Valor esperado	Descrição
`smsConversationResponseTimeout`	Tempo em ms	A quantidade de tempo em milissegundos que a integração espera para receber uma resposta da ação. Se o limite de tempo for excedido, a integração tentará entrar em contato novamente com a ação. Se o serviço ainda não puder ser contatado, a resposta SMS falhará.

Tabela 3. Variáveis de contexto que são definidas pela integração

Tabela 3. Tabela 3. Variáveis de contexto SMS configuradas pela integração
Nome da variável de contexto	Descrição
`smsTenantPhoneNumber`	O número de telefone do locatário de integração para o qual o usuário está enviando mensagem.
`smsUserPhoneNumber`	O número de telefone do usuário que está trocando mensagens com a integração.
`smsUserData`	Dados no formato JSON a serem transmitidos literalmente ao mecanismo de orquestração de serviços ou ao serviço de criação de assistentes de IA. Essa variável será enviada apenas se a sessão for iniciada por meio do locatário de integração e os dados enviados pela API de REST.
`smsSessionTimeoutCount`	O valor de tempo limite da sessão. Essa variável será enviada apenas se o valor de tempo limite for definido por meio da API de REST.
`smsError`	Quando a integração falha ao enviar uma mensagem SMS, essa variável contém detalhes sobre o erro que ocorreu.
`smsSessionID`	O identificador exclusivo global (GUID) para a sessão de SMS Gateway relacionada.
`smsMedia`	O `arraylist` de `mediaURL` e o `mediaContentType` correspondente. Essa variável de contexto é limpa no final de cada turno da conversa.