API

Autorização

Para utilização de todas as APIs é necessário colocar no Header sua x-api-key.

Acesse seu perfil e selecione Token, sua Chave de API será apresentada. Dúvidas acesse o link Journey - Token

URL

URL Produção: https://app.vya.digital

Respostas padroes

Erros - 401 Unauthorized

{
    "status": false,
    "error": 1,
    "message": "Usuário não autorizado"
}

Erros - 400 Bad Request

{
    "status": false,
    "erro": 1,
    "message": "Campo Telefone não está preenchido"
}

Messages

SMS

Enviar mensagens por SMS.

Endpoint:

Method: POST
Type: RAW
URL: {{baseUrl}}/api/v2/messages/sms

Headers:

Key	Value
x-api-key	{{apiKey}}

Body:

{
    "contatos": [
        {
            "telefone": "11999999999",
            "referenciaCliente": "10347081_92627",
            "mensagem": "Seu texto aqui até 160 caracteres"
        }
    ]
}

Response:

Success - 201 Created

{
    "status": true,
    "error": 0,
    "message": "sms registrado com sucesso",
    "codigoAcao": "98883",
    "codigoContatos": [
        19680366
    ]
}

WhatsApp Business

Enviar mensagens por WhatsApp Business.

Endpoint:

Method: POST
Type: RAW
URL: {{baseUrl}}/api/v2/messages/WhatsApp

Headers:

Key	Value
x-api-key	{{apiKey}}

Body:

{
    "contatos": [
        {
            "telefone": "11999999999",
            "referenciaCliente": "10347081_92627",
            "mensagem": "Seu texto aqui"
        }
    ]
}

Response:

Success - 201 Created

{
    "status": true,
    "error": 0,
    "message": "sms registrado com sucesso",
    "codigoAcao": "98883",
    "codigoContatos": [
        19680366
    ]
}

Contacts

Criar Contato

Criar contato para uma campanha.

Endpoint:

Method: POST
Type: RAW
URL: {{baseUrl}}/api/v2/contact

Headers:

Key	Value
x-api-key	{{apiKey}}

Body:

{
    "codigoCampanha": "001",
    "contatos": [
        {
            "referenciaCliente": "33544103885",
            "nome": "nome do contato",
            "telefone": "telefone com DDD+Numero",
            "cpf": "não obrigatorio",
            "nome do campo": "xpto",
        }
    ]
}

Obs: Os campos do contato podem ter nomes diferentes, porque cada campanha exige propriedades particulares.

Response:

Success - 201 CREATED

{
    "status": true,
    "error": 0,
    "message": "Contato registrado e iniciado",
    "codigoAcao": "101878",
    "codigoContatos": [
        22579459
    ]
}

Atualizar Contato

Atualiza um contato.

Endpoint:

Method: PATCH
Type: RAW
URL: {{baseUrl}}/api/v2/contact

Headers:

Key	Value
x-api-key	{{apiKey}}

Body:

{
    "codigoAcao": "Codigo coletado no momento que foi criado o contato",
    "codigoContato": "Codigo coletado no momento que foi criado o contato",
    "nome": "Teste Paulo",
    "cpfcnpj": "99999999999",
    "telefone": "11912341234",
    "email": "teste@gmail.com"
}

Obs: Os campos do contato podem ter nomes diferentes, porque cada campanha exige propriedades particulares.

Response:

Success - 200 OK

{
    "status": true,
    "error": 0,
    "message": "Atualização realizada com sucesso"
}