CCCIF Media Resource API

. Recurso de mídia da Estrutura de interoperabilidade do chatbot de bate-papo personalizado (CCCIF) A API fornece endpoints que permitem que um bot primário carregue anexos para o associado ServiceNow instância.

Chame esta API em seu bot primário para carregar anexos privados de um usuário que está conversando por meio de Virtual Agent(VA). Em seguida, você deve enviar o. URL média Parâmetro retornado por esta API para a API do VA.

Se o anexo for público, você poderá simplesmente enviar o URL do anexo no corpo da solicitação do seu Integração do bot do Virtual Agent chamada.

Para acessar esta API, o plug-in Conversational Custom Chat Integration (com.glide.cs.custom.adapter) deve estar ativado. Além disso, as propriedades do sistema de anexo devem ser configuradas.

Para obter informações adicionais sobre os recursos do Virtual Agent API, consulte API do Virtual Agent .

CCCIF - PUBLICAR /cccif/media/upload

Carrega um anexo privado para o chamado ServiceNow Instância que armazena o anexo na tabela Anexos [sys_attachment].

Chame este método em seu bot primário para carregar anexos privados de um usuário que está conversando por meio de Virtual Agent(VA). Em seguida, você deve enviar o. URL média Parâmetro retornado por este método para a API do VA usando API de integração de bot do Virtual Agent.

Formato de URL

URL com controle de versão: /api/now/

URL padrão: /api/now/cccif/media/upload

Nota:

As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

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. Parâmetros do corpo da solicitação

Nome	Descrição
arquivo	Obrigatório. Caminho do arquivo a ser carregado. Tipo de dados: Cadeia de caracteres, como o caminho do arquivo, por exemplo <file_path>, o caminho do arquivo
provider_application_id	Sys_id do sys_cs_provider_application interagindo com o bot do VA. Padrão: Sys_id da aplicação do VA Bot to Bot Provider
user_id	Obrigatório. Identificador de usuário exclusivo do usuário que interage com o bot do VA. Qualquer cadeia de caracteres que seja exclusiva para cada usuário. 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: multipart/form-data.

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a 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
201	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.
401	Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
404	Não encontrado. O item solicitado não foi encontrado.
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)

Nome	Descrição
attachmentId	Sys_id do anexo que foi armazenado. Tipo de dados: Cadeia de caracteres
erro	Descrição de qualquer erro detectado ao processar a solicitação. Tipo de dados: Objeto "error": { "detail": "String", "message": "String" }
error.detail	Detalhes sobre o erro encontrado. Tipo de dados: Cadeia de caracteres
mensagem.erro	Mensagem descrevendo o erro que foi lançado. Tipo de dados: Cadeia de caracteres
mediaUrl	URL do anexo a ser enviado ao bot primário para acessar o anexo. O bot primário deve enviar esta URL no message.attachment.urlparâmetro do corpo da solicitação do PUBLICAR /sn_va_as_service/bot/integration endpoint. Tipo de dados: Cadeia de caracteres
nome	Nome do arquivo do anexo. Tipo de dados: Cadeia de caracteres
estado	Estado do anexo na tabela Anexo. Valores possíveis: disponível disponível condicionalmente não disponível pendente(s) Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo mostra como carregar um anexo de arquivo .png.

curl --location --request POST 'https://instance.servicenow.com/api/now/v1/cccif/media/upload' \
--header 'Authorization: Basic xxxxxxxxxxxxx' \
--header 'Content-Type:multipart/form-data' \
--form 'user_id="lincoln"' \
--form 'file=@"/Users/Desktop/Screenshot 2021-10-25 at 5.08.14 PM.png"'

Resposta:

Response :{
  "result": {
    "mediaUrl": "https://instance.servicenow.com/api/now/v1/cs/media/vGfewkfAv0VBo2RxmlTM448L789Pp6rqLFLUNYQxZsUUFrsgMA8aW9W0zWx1a5fG",
    "name": "Screenshot 2021-10-25 at 5.08.14 PM.png",
    "state": "pending",
    "attachmentId": "299c648887b73c1022b6a6cd0ebb3534"
  }