Criar processo de Mensagem

Este artigo explica como criar um processo de mensagem através da REST API do Unico Check.

Esse método cria um processo de mensagem (sem assinatura), contendo os dados da pessoa.

Como usar?

Faça uma requisição POST para o endpoint /messages

Com o token de acesso válido, faça uma requisição para o endpoint (POST/messages) enviando os seguintes parâmetros:

{
  "subject": {
    "Code": "CPF_Titular",
    "Name": "NOME_Titular",
    "Gender": "GENERO_Titular",
    "BirthDate": "DATANASCIMENTO_Titular",
    "Email": "EMAIL_Titular",
    "Phone": "PHONE_Titular"
  },
  "indexes": [ 
    {
      "key": "PALAVRA_CHAVE_da_Variavel",
      "value": "VALOR_da_Variavel",
      "page": "SMS_ou_EMAIL",
    },
  ],
  "template": "NOME_TEMPLATE",
  "send": "TRUE_FALSE_ENVIA_MSG",
  "enableQRCode": "TRUE_FALSE_GERA_QRCODE"
}

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso
Content-Type	String	Mandatório	"application/json"

• REQUEST BODY SCHEMA

Nome	Tipo	Mandatorio/Opcional	Descrição
subject.Code	String	Mandatório	CPF válido
subject.Name	String	Mandatório	Nome da pessoa
subject.Gender	String	Opcional	Gênero da pessoa, podendo ser M ou F
subject.BirthDate	String	Opcional	Data de nascimento. String de 10 caracteres. Exemplo: 01/01/0001
subject.Email	String	Opcional	Email da pessoa
subject.Phone	String	Opcional	Telefone da pessoa
indexes.key	String	Mandatório	Palavra chave da varíavel usada no texto SMS ou EMAIL
indexes.value	String	Mandatório	Valor da variável usada no texto SMS ou EMAIL
indexes.page	String	Mandatório	Informar se o texto é SMS ou EMAIL
template	String	Mandatório	Nome do template criado no portal
send	Boolean	Mandatório	Se já envia a mensagem para o usuário
enableQRCode	Boolean	Opcional	Se gera um QR Code e retorna a URL no response

Exemplo de requisição:

Arquivo JSON

{
  "subject": {
    "Code": "12345678910",
    "Name": "Bob",
    "Gender": "M",
    "BirthDate": "01/01/0001",
    "Email": "email@example.com",
    "Phone": "5543999999999"
  },
  "indexes": [
    {
      "key": "{NUMERO DA SOLICITAÇÃO}",
      "value": "0",
      "page": "SMS"
    }
  ],
  "template": "assinatura",
  "send": false,
  "enableQRCode": true
}

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo o ID da transação e o "QRCodeUrl"como a seguir:

{
  "Id": "11111111-1111-1111-1111-111111111111",
  "QRCodeUrl": "http://www3.acesso.io/Handlers/FileHandler.ashx?op=301&name=11111111-1111-1111-1111-111111111111&extension=4&timestamp=637249839336767764&thumb=3&user=1CpHr0APSTfFqpkzzzXMuQ%3d%3d"
}

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.