IBM Cloud Docs
Variáveis de contexto de integração telefônica

Variáveis de contexto de integração telefônica

É possível usar variáveis de contexto para gerenciar o fluxo de conversas com clientes que interagem com o assistente por telefone.

As tabelas a seguir descrevem variáveis de contexto que têm significado especial no contexto da integração de telefone. Eles precisam ser usados para o propósito listado e nenhum outro.

Variáveis de contexto que são definidas por diálogo ou ações

Variáveis de contexto de voz configuradas pelo diálogo ou ações
Nome Tipo Descrição Padrão
final_utterance_timeout_count Número O tempo (em milissegundos) que a integração telefônica espera para receber uma elocução final do serviço Speech to Text. O tempo limite ocorrerá se a integração telefônica não receber uma elocução final dentro do prazo especificado, mesmo se as hipóteses continuarem sendo geradas. Quando o tempo limite ocorre, a integração de telefone envia ao watsonx Assistant uma atualização de texto que inclui a palavra vgwFinalUtteranceTimeout para indicar que nenhuma elocução final foi recebida. N/A
post_response_timeout_count Número O tempo (em milissegundos) de espera por uma nova elocução após a resposta ser reproduzida novamente para o responsável pela chamada. Quando esse tempo limite ocorre, o canal de integração telefônica envia uma mensagem de texto para o assistente que inclui a palavra vgwPostResponseTimeout e configura a variável de contexto input.integrations.voice_telephony.post_response_timeout_occurred para true. 7000
turn_settings.timeout_count Número O tempo (em milissegundos) de espera por uma resposta do watsonx Assistant. Se esse tempo for excedido, a integração de telefone tentará entrar em contato novamente com o watsonx Assistant. Se o serviço ainda não puder ser contatado, a chamada falhará. N/A
cdr_custom_data objeto Quaisquer pares de chave/valor JSON para coletar e armazenar com o registro CDR no final da chamada telefônica. Cada vez que esse objeto é recebido, ele é mesclado com qualquer contexto cdr_custom_data recebido anteriormente. N/A

Exemplo

{
  "generic": [
    {
      "response_type": "text",
      "text": "Hello"
    }
  ],
  "context": {
    "integrations": {
      "voice_telephony": {
        "post_response_timeout_count": 10000,
        "turn_settings": {
          "timeout_count": 5000
        },
        "cdr_custom_data": {
          "key1": "value1",
          "key2": "value2"
        }
      }
    }
  }
}

Variáveis de contexto que são definidas por canal telefônico

Variáveis de contexto definidas pelo canal de telefone
Nome Tipo Descrição
sip_call_id sequência O ID de chamada SIP associado à sessão watsonx Assistant.
sip_custom_invite_headers objeto Um objeto JSON com pares de chave ou valor que definem cabeçalhos SIP que são extraídos da solicitação SIP inicial INVITE e transmitidos para o serviço watsonx Assistant (por exemplo, {"Custom-Header1": "123"}).
private.sip_from_uri sequência O URI do SIP From associado ao serviço watsonx Assistant.
private.sip_request_uri sequência O URI de solicitação SIP que iniciou a sessão de conversa.
private.sip_to_uri sequência O URI do SIP To associado à sessão de conversa.
private.user_phone_number sequência O número de telefone do qual a chamada foi recebida.
assistant_phone_number sequência O número do telefone associado ao lado do watsonx Assistant que recebeu o telefonema.

Parâmetros de entrada que são configurados pelo canal telefônico

Os parâmetros de entrada a seguir são válidos apenas para o atual turno da conversa.

Parâmetros de entrada configurados pelo canal do telefone
Nome Tipo Descrição
post_response_timeout_occurred booleano Se o tempo limite de pós-resposta expirou
barge_in_occurred booleano Se ocorreu a interrupção
final_utterance_timeout_occurred true ou false Se o tempo limite de elocução final expirou
dtmf_collection_succeeded booleano Se a coleção DTMF teve êxito ou falhou. Quando true, uma coleção DTMF tem êxito e retorna o número esperado de dígitos. Quando false, uma coleção DTMF falhou ao coletar o número especificado de dígitos. Mesmo quando dtmf_collection_succeeded é false, todos os dígitos coletados são transmitidos para o diálogo na sequência de entrada da solicitação de turno.
is_dtmf booleano Se a entrada para watsonx Assistant é uma sinalização multifrequência de dois tons (DTMF).
speech_to_text_result objeto A resposta final do serviço Speech to Text no formato JSON, incluindo a transcrição e a pontuação de confiança para a hipótese de oportunidade e quaisquer alternativas. O formato corresponde exatamente ao formato recebido do serviço Speech to Text. (Para mais informações, consulte o Speech to Text documentação da API.)
sms_message sequência Uma mensagem SMS recebida do responsável pela chamada

Exemplo

{
  "input": {
    "text": "agent ",
    "integrations": {
      "voice_telephony": {
        "speech_to_text_result": {
          "result_index": 0,
          "stopTimestamp": "2021-09-29T17:43:31.036Z",
          "transaction_ids": {
            "x-global-transaction-id": "43dd6ce0-139a-4d76-95aa-86e03fcfc434",
            "x-dp-watson-tran-id": "6e60695e-fed7-4efe-a376-0888b027d30f"
          },
          "results": [
            {
              "final": true,
              "alternatives": [
                {
                  "transcript": "agent ",
                  "confidence": 0.78
                }
              ]
            }
          ],
          "transactionID": "43dd6ce0-139a-4d76-95aa-86e03fcfc434",
          "startTimestamp": "2021-09-29T17:43:29.436Z"
        },
        "is_dtmf": false,
        "barge_in_occurred": false
      }
    }
  },
  "context": {
    "skills": {
      "main skill": {
        "user_defined": {},
        "system": {}
      }
    },
    "integrations": {
      "voice_telephony": {
        "private": {
          "sip_to_uri": "sip:watson-conversation@10.10.10.10",
          "sip_from_uri": "sip:10.10.10.11",
          "sip_request_uri": "sip:test@10.10.10.10:5064;transport=tcp"
        },
        "sip_call_id": "QjryZsuAS4",
        "assistant_phone_number": "18882346789"
      }
    }
  }
}