SoftwareHouse

Obter Informações do Plano

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Plan

Retorna planos disponiveis a ser utilizado na compra de mensagens.

Parameters

No parameters

Responses

{
  "id": 0,
  "name": "string",
  "description": "string",
  "qty": 0
}

Obter Informações da Software House

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse

Retorna Dados da Software House.

Parameters

No parameters

Responses

{
  "name": "string",
  "description": "string",
  "whatsappNumber": "string",
  "email": "string"
}

Mudar Token da Software House

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/ChangeToken

Retorna Novo Token da Software House.

Parameters

No parameters

Responses

{
  "token": "string"
}

Obter Informações do Representante

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Representative

Retorna Dados do Representante.

Parameters

No parameters

Responses

{
  "id": 0,
  "shid": 0,
  "name": "string",
  "description": "string",
  "whatsappNumber": "string",
  "email": "string"
}

Ativar / Desativar Representante

Post https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Representative

Ativa / Desativa Representante.

Parameters

Name
Tipo
Obrigatório
Valor

representativeID

inteiro

isActive

boolean

true/false

Responses

{
  "message": "string"
}

Obter Informações do Representante

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Customer

Retorna Dados dos Clientes.

Parameters

No parameters

Responses

{
  "shid": 0,
  "representativeID": 0,
  "cpfCnpj": "string",
  "name": "string",
  "description": "string",
  "whatsappNumber": "string",
  "email": "string",
  "remarks": "string",
  "createdOnUtc": "2024-04-18T18:48:32.467Z",
  "token": "string",
  "payloadVM": {
    "uri": "string",
    "httpMethod": "string"
  }
}

Cadastrar Cliente da Software House

Post https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Customer

Cadastrar Cliente para usar API.

Parameters

Name
Tipo
Obrigatório
Valor

representativeID

inteiro

cpfCnpj

string

<Cpf ou CNPJ apenas os numero>

name

string

<Nome do Cliente>

description

string

<Ramo do cliente>

whatsappNumber

string

<Whatsapp do Cliente que vai enviar as mensagens, EX: 5511998885645

email

string

<email do cliente>

remarks

string

<outras observações>

payloadVM.uri

string

<endereço do uri do customer>

payloadVM.httpMethod

string

Usar <GET,POST,PUT,DELETE>

Responses

{
  "accessToken": "string",
  "tokenType": "string",
  "expiresIn": 0,
  "expirationDate": "2024-07-03T16:06:08.855Z"
}

Atualizar Cliente da Software House

Put https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/Customer

Atualizar Cliente para usar API.

Parameters

Name
Tipo
Obrigatório
Valor

description

string

<Ramo do cliente>

whatsappNumber

string

<Whatsapp do Cliente que vai enviar as mensagens, EX: 5511998885645

email

string

<email do cliente>

remarks

string

<outras observações>

isActive

boolean

<Ativa (true)/Desativa (false)>

token

string

<Obrigatório informar o token do cliente para que consiga fazer as alterações>

payloadVM.uri

string

<endereço do uri do customer>

payloadVM.httpMethod

string

Usar <GET,POST,PUT,DELETE>

Responses

{
  "accessToken": "string",
  "tokenType": "string",
  "expiresIn": 0,
  "expirationDate": "2024-07-03T16:18:50.789Z"
}

Consultar pedido de mensagens dos clientes

Get https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/PurchaseOrder

Retorna Pedidos feito dos clientes.

Parameters

No parameters

Responses

{
  "customerID": 0,
  "planID": 0,
  "remarks": "string",
  "createdOnUtc": "2024-04-18T19:10:48.080Z"
}

Inserir Pedido de Mensagem do Cliente

Post https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/PurchaseOrder

Inserir Pedido de Mensagens dos Clientes.

Parameters

Name
Tipo
Obrigatório
Valor

token

string

<Obrigatório informar o token do cliente para que consiga fazer as inserção>

planID

inteiro

<Codigo do Plano a ser inserido>

remarks

string

<outras observações>

qty

inteiro

<Quantidade de vezes que gostaria de inserir o plano. Ex: plano de 100 msg x qty: 3 = 300 msgs>

recurrence

boolean

<true/false, se true todo inicio de mês será feito a inserção automatica do plano no primeiro envio de mensagem do cliente>

Responses

{
  "message": "string"
}

Consultar Consumo de mensagens dos Clientes por ano/mês

Post https://zapi.teclaconsultoria.com.br/Api/SoftwareHouse/CustomerMonth

Retorna consumo de mensagens dos clientes.

Parameters

Name
Tipo
Obrigatório
Valor

representativeID

inteiro

<se quiser ver o consumo dos cliente de um determinado representante>

token

string

<Informar o token do cliente para que consiga fazer as inserção>

year

inteiro

<ano com 4 digitos>

month

inteiro

<mês>

Responses

[
  {
    "customer": "string",
    "year": 0,
    "month": 0,
    "qtyMsgAva": 0,
    "qtyMsgUsed": 0,
    "qtyMsgBuy": 0,
    "remarks": "string",
    "lastDateOnUtc": "2024-04-18T19:28:56.604Z"
  }
]

PreviousAdmNextMessage

Last updated