Referência da API

API externa do CRM Hyper · /v2/api/external/{apiId}/… · 207 rotas em 29 categorias.

Exportar spec completa (.json) base: https://backend.hypersistema.com.br

Para não-dev: a API externa permite que outros sistemas conversem com o seu CRM — criar contatos, enviar mensagens, gerar tickets. Cada cliente tem um {apiId} e um token próprio. Você não precisa disso se usa apenas o painel do CRM.

📅 Agendamentos e Lembretes

10 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/appointment/create

AppointmentCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`title`	string	Não
`description`	string	Não
`contactId`	string	Não
`contactName`	string	Não
`contactPhone`	string	Não
`whatsappId`	string	Não
`startAt`	string	Não
`endAt`	string	Não
`status`	string	Não
`notes`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/appointment/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "title": "texto",
    "description": "texto",
    "contactId": "texto",
    "contactName": "texto",
    "contactPhone": "texto",
    "whatsappId": "texto",
    "startAt": "texto",
    "endAt": "texto",
    "status": "texto",
    "notes": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/appointment/delete/{id}

AppointmentDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/appointment/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/appointment/list

AppointmentList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`
`status`	query	Não	pending \| confirmed \| cancelled \| completed	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/appointment/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'
  -G --data-urlencode 'status=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/appointment/show/{id}

AppointmentShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/appointment/show/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/appointment/update/{id}

AppointmentUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`title`	string	Não
`description`	string	Não
`contactId`	string	Não
`contactName`	string	Não
`contactPhone`	string	Não
`whatsappId`	string	Não
`startAt`	string	Não
`endAt`	string	Não
`status`	string	Não
`notes`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/appointment/update/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "title": "texto",
    "description": "texto",
    "contactId": "texto",
    "contactName": "texto",
    "contactPhone": "texto",
    "whatsappId": "texto",
    "startAt": "texto",
    "endAt": "texto",
    "status": "texto",
    "notes": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/scheduleReminder/create

ScheduleReminderCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`description`	string	Não
`hoursBeforeEvent`	integer	Não
`messageType`	string	Não
`messageContent`	string	Não
`whatsappId`	string	Não
`active`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/scheduleReminder/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "description": "texto",
    "hoursBeforeEvent": 1,
    "messageType": "texto",
    "messageContent": "texto",
    "whatsappId": "texto",
    "active": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/scheduleReminder/delete/{id}

ScheduleReminderDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/scheduleReminder/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/scheduleReminder/list

ScheduleReminderList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/scheduleReminder/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/scheduleReminder/toggle/{id}

ScheduleReminderToggle

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/scheduleReminder/toggle/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/scheduleReminder/update/{id}

ScheduleReminderUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`description`	string	Não
`hoursBeforeEvent`	integer	Não
`messageType`	string	Não
`messageContent`	string	Não
`whatsappId`	string	Não
`active`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/scheduleReminder/update/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "description": "texto",
    "hoursBeforeEvent": 1,
    "messageType": "texto",
    "messageContent": "texto",
    "whatsappId": "texto",
    "active": true
  }'

Resposta (200)

resposta.json

{}

📣 Campanhas

15 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/campaign/cancel/{campaignId}

CampaignCancel

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/cancel/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/contacts/add/{campaignId}

CampaignContactsAdd

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/contacts/add/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '[
    {
      "name": "texto",
      "number": "texto"
    }
  ]'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/campaign/contacts/{campaignId}

CampaignContactsList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/contacts/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/contacts/remove/{campaignId}/{contactId}

CampaignContactsRemove

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`
`contactId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/contacts/remove/{campaignId}/{contactId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/contacts/removeAll/{campaignId}

CampaignContactsRemoveAll

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/contacts/removeAll/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/create

CampaignCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`start`	string	Não
`message1`	string	Não
`message2`	string	Não
`message3`	string	Não
`sessionId`	string	Não
`delay`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "start": "texto",
    "message1": "texto",
    "message2": "texto",
    "message3": "texto",
    "sessionId": "texto",
    "delay": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/delete/{campaignId}

CampaignDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/delete/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/duplicate/{campaignId}

CampaignDuplicate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/duplicate/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/campaign/list

CampaignList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/pause/{campaignId}

CampaignPause

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/pause/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/campaign/report/{campaignId}

CampaignReport

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/report/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/resume/{campaignId}

CampaignResume

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/resume/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/skip/{campaignId}

CampaignSkip

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/skip/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/start/{campaignId}

CampaignStart

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/start/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/campaign/update/{campaignId}

CampaignUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`campaignId`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`start`	string	Não
`message1`	string	Não
`message2`	string	Não
`message3`	string	Não
`sessionId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/campaign/update/{campaignId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "start": "texto",
    "message1": "texto",
    "message2": "texto",
    "message3": "texto",
    "sessionId": "texto"
  }'

Resposta (200)

resposta.json

{}

🔌 Canais e Sessões

7 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/createtSession

CreateSession

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não	Nome da instância do WhatsApp
`status`	string	Não	Status inicial da sessão (DISCONNECTED, CONNECTED)
`type`	string	Não	Tipo da sessão

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createtSession'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "status": "texto",
    "type": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteSession

DeleteSession

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	integer	Não	ID da sessão do WhatsApp que será deletada

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteSession'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/requestNewQrCodeSession

RequestNewQrCode

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	integer	Não	ID da sessão do WhatsApp que terá um novo QR Code gerado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/requestNewQrCodeSession'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showChannel

ShowChannelInformation

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do canal (formato: 5511999999999)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showChannel'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showChannelById

ShowChannelInformationById

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`id`	integer	Não	ID do canal que será consultado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showChannelById'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "id": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/qrCodeSession

ShowQrCode

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	integer	Não	ID da sessão do WhatsApp que terá o QR Code gerado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/qrCodeSession'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/startSession

StartSession

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	integer	Não	ID da sessão do WhatsApp que será iniciada

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/startSession'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": 1
  }'

Resposta (200)

resposta.json

{}

👤 Contatos

12 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/blockContact

BlockContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`contactId`	integer	Não	ID do contato que será bloqueado/desbloqueado
`blocked`	boolean	Não	true para bloquear, false para desbloquear

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/blockContact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "contactId": 1,
    "blocked": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createContact

CreateContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não	Nome completo do contato
`number`	string	Não	Número do WhatsApp (formato: 5511999999999)
`email`	string	Não	Email do contato
`cpf`	string	Não	CPF do contato (formato: 000.000.000-00)
`firstName`	string	Não	Primeiro nome do contato
`lastName`	string	Não	Sobrenome do contato
`businessName`	string	Não	Nome da empresa do contato
`birthdayDate`	string	Não	Data de nascimento (formato: DD/MM/AAAA)
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createContact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "number": "texto",
    "email": "texto",
    "cpf": "texto",
    "firstName": "texto",
    "lastName": "texto",
    "businessName": "texto",
    "birthdayDate": "texto",
    "externalKey": "texto",
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/getContactExtraInfo

GetContactExtraInfo

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`contactId`	query	Não	ID do contato	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/getContactExtraInfo'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'contactId=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/contacts/search

SearchContacts

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`searchParam`	string	Não	Parâmetro de busca textual (opcional) - busca em nome, número, CPF, etc
`page`	integer	Não	Número da página (padrão: 1)
`limit`	integer	Não	Limite de resultados por página (padrão: 40)
`tagId`	integer	Não	ID de uma tag para filtrar (opcional)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/contacts/search'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "searchParam": "texto",
    "page": 1,
    "limit": 1,
    "tagId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showcontact

ShowContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do contato (formato: 5511999999999)
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showcontact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateContact

UpdateContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não	Nome completo do contato
`number`	string	Não	Número do WhatsApp (formato: 5511999999999)
`email`	string	Não	Email do contato
`cpf`	string	Não	CPF do contato (formato: 000.000.000-00)
`firstName`	string	Não	Primeiro nome do contato
`lastName`	string	Não	Sobrenome do contato
`businessName`	string	Não	Nome da empresa do contato
`birthdayDate`	string	Não	Data de nascimento (formato: DD/MM/AAAA)
`kanban`	integer	Não	ID do kanban do contato
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateContact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "number": "texto",
    "email": "texto",
    "cpf": "texto",
    "firstName": "texto",
    "lastName": "texto",
    "businessName": "texto",
    "birthdayDate": "texto",
    "kanban": 1,
    "externalKey": "texto",
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateContactExtraInfo

UpdateContactExtraInfo

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`contactId`	integer	Não	ID do contato que terá as informações adicionais atualizadas
`extraInfo`	array<object>	Não	Array de campos personalizados (extraInfo)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateContactExtraInfo'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "contactId": 1,
    "extraInfo": [
      {
        "name": "texto",
        "value": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateContactKanban

UpdateContactKanban

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`contactId`	integer	Não	ID do contato que terá o kanban (carteira) alterado
`kanban`	integer	Não	ID do kanban (carteira) que será atribuído ao contato

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateContactKanban'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "contactId": 1,
    "kanban": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateContactWallet

UpdateContactWallet

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`contactId`	integer	Não	ID do contato que será carteirizado
`walletId`	integer	Não	ID da wallet que será atribuída ao contato (pode usar walletId ou walletIds)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateContactWallet'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "contactId": 1,
    "walletId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/mergecontacts

MergeContacts

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`pairs`	array<object>	Não	Pares a mesclar (max 150 por requisicao — use chunking). Cada par aceita IDs OU numeros. Por numero: resolucao exato-primeiro; se ambiguo, a linha retorna ERR_NUMBER_AMBIGUOUS com os candidatos.

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/mergecontacts'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "pairs": [
      {
        "primaryId": 1,
        "duplicateId": 1
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/findduplicatecontacts

FindDuplicateContacts

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`limit`	integer	Não	Limite de pares retornados (padrao 500)
`matchKinds`	array<string>	Não	Heuristicas (padrao: variante do 9o digito + cross-collision LID)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/findduplicatecontacts'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "limit": 1,
    "matchKinds": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/unmergecontacts

UnmergeContacts

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`duplicateIds`	array<integer>	Não	Desfaz mesclagens registradas (ordem inversa: a mais recente primeiro). Max 150 por requisicao.
`mergeLogIds`	array<object>	Não	Alternativa: ids do log de mesclagem

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/unmergecontacts'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "duplicateIds": [
      1
    ],
    "mergeLogIds": [
      {}
    ]
  }'

Resposta (200)

resposta.json

{}

🏗️ CRM - Pipeline

10 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/pipeline/create

PipelineCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não
`description`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/pipeline/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "description": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/pipeline/delete/{id}

PipelineDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/pipeline/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/pipeline/list

PipelineList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/pipeline/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/pipeline/show/{id}

PipelineShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/pipeline/show/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/pipeline/update/{id}

PipelineUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/pipeline/update/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/stage/create

StageCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`pipelineId`	string	Não
`order`	integer	Não
`color`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/stage/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "pipelineId": "texto",
    "order": 1,
    "color": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/stage/delete/{id}

StageDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/stage/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/stage/list

StageList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`
`pipelineId`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/stage/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'
  -G --data-urlencode 'pipelineId=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/stage/show/{id}

StageShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/stage/show/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/stage/update/{id}

StageUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/stage/update/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

📊 Dashboard

10 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/dash/ticketsAndTimes

DashTicketsAndTimes

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsAndTimes'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsChannels

DashTicketsChannels

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsChannels'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsEvolution

DashTicketsEvolution

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsEvolution'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsEvolutionByValue

DashTicketsEvolutionByValue

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsEvolutionByValue'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsEvolutionChannelsName

DashTicketsEvolutionChannelsName

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsEvolutionChannelsName'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsPerUser

DashTicketsPerUser

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsPerUser'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsQueue

DashTicketsQueue

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsQueue'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsReasons

DashTicketsReasons

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsReasons'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsStatus

DashTicketsStatus

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsStatus'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/dash/ticketsUser

DashTicketsUser

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`startDate`	query	Não		`texto`
`endDate`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/dash/ticketsUser'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'startDate=texto'
  -G --data-urlencode 'endDate=texto'

Resposta (200)

resposta.json

{}

📤 Envio em Lote

8 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/bulkDispatch/incrementProgress/{dispatchId}

BulkDispatchIncrementProgress

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`dispatchId`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`success`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkDispatch/incrementProgress/{dispatchId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "success": true
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/bulkDispatch/list

BulkDispatchList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkDispatch/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/bulkDispatch/show/{dispatchId}

BulkDispatchShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`dispatchId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkDispatch/show/{dispatchId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/bulkDispatch/update/{dispatchId}

BulkDispatchUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`dispatchId`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`status`	string	Não
`cancellationReason`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkDispatch/update/{dispatchId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "status": "texto",
    "cancellationReason": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/bulkFastMessage

BulkFastMessage

v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, destinatarios com ticket aberto ou pendente (em qualquer canal) NAO recebem o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`whatsappType`	string	Não
`arrayNumbers`	array<string>	Não
`message`	string	Não
`min`	integer	Não
`max`	integer	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkFastMessage'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "whatsappType": "texto",
    "arrayNumbers": [
      "texto"
    ],
    "message": "texto",
    "min": 1,
    "max": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/bulkIndividual

BulkIndividual

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não
`number`	string	Não
`message`	string	Não
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkIndividual'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "number": "texto",
    "message": "texto",
    "externalKey": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/bulkSendMessage

BulkSendMessage

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`arrayNumbers`	array<string>	Não
`message`	string	Não
`min`	integer	Não
`max`	integer	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkSendMessage'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "arrayNumbers": [
      "texto"
    ],
    "message": "texto",
    "min": 1,
    "max": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/bulkSendMessageWithVariable

BulkSendMessageWithVariable

v2 crossChannelTicketCheck: quando a flag 'Verificar conversa em outros canais' do tenant esta ligada, o destinatario com ticket aberto ou pendente (em qualquer canal) NAO recebe o disparo. A resposta inclui skipped (contagem) e skippedNumbers (lista). Para ignorar a checagem nesta chamada, envie "skipActiveTicketCheck": false no body.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`message`	string	Não
`dataInput`	string	Não
`min`	integer	Não
`max`	integer	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/bulkSendMessageWithVariable'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "message": "texto",
    "dataInput": "texto",
    "min": 1,
    "max": 1
  }'

Resposta (200)

resposta.json

{}

🎯 Envio por Ticket

1 rota · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendMessageByTicket

SendMessageByTicket

Endpoint com mais de um formato de payload na coleção oficial: **SendMessageByTicketText**, **SendMessageByTicketFile**, **SendMessageByTicketMediaUrl**, **SendMessageByTicketBase64**. Veja os exemplos do corpo para escolher a variante.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket (conversa) que recebera a mensagem
`body`	string	Sim	Texto da mensagem (obrigatorio quando nao ha midia)
`externalKey`	string	Não	Chave unica p/ idempotencia (recomendado)
`reopen`	boolean	Não	Reabrir ticket fechado antes de enviar (sem isto, ticket fechado retorna 409)
`isClosed`	boolean	Não	Fechar o ticket apos o envio

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendMessageByTicket'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": "texto",
    "externalKey": "texto",
    "reopen": true,
    "isClosed": true
  }'

Resposta (200)

resposta.json

{}

📂 Galeria

3 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/gallery/delete/{id}

GalleryDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/gallery/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/gallery/list

GalleryList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`pageNumber`	query	Não		`1`
`fileType`	query	Não		`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/gallery/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'pageNumber=1'
  -G --data-urlencode 'fileType=texto'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/gallery/upload

GalleryUpload

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`description`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/gallery/upload'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "description": "texto"
  }'

Resposta (200)

resposta.json

{}

👥 Grupos WhatsApp

15 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/group/addParticipant

GroupAddParticipant

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`participants`	array<string>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/addParticipant'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "participants": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/changeDescription

GroupChangeDescription

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`description`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/changeDescription'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "description": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/changePicture

GroupChangePicture

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`picture`	string	Não	exemplo.com/foto.jpg"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/changePicture'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "picture": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/changeTitle

GroupChangeTitle

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`title`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/changeTitle'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "title": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/create

GroupCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`titles`	array<string>	Não
`number`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "titles": [
      "texto"
    ],
    "number": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/demote

GroupDemote

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`participants`	array<string>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/demote'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "participants": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/getInviteLink

GroupGetInviteLink

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não
`groupId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/getInviteLink'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupId": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/list

GroupList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/listParticipants

GroupListParticipants

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não
`groupIds`	array<string>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/listParticipants'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/promote

GroupPromote

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`participants`	array<string>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/promote'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "participants": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/removeParticipant

GroupRemoveParticipant

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`participants`	array<string>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/removeParticipant'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "participants": [
      "texto"
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/setAdminsOnly

GroupSetAdminsOnly

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`whatsappId`	string	Não
`groupIds`	array<string>	Não
`adminsOnly`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/setAdminsOnly'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupIds": [
      "texto"
    ],
    "adminsOnly": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/showById

GroupShowById

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	string	Não
`groupId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/showById'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": "texto",
    "groupId": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/listGroupInfo

ListGroupsInfo

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`listGroups`	boolean	Não	lista todos os grupos
`listParticipants`	boolean	Não	lista todos os grupos e adiciona o array de participantes

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listGroupInfo'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "listGroups": true,
    "listParticipants": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/group/leave

GroupLeave

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`whatsappId`	integer	Não	ID da sessao (canal WABA oficial — outros tipos retornam ERR_LEAVE_GROUP_WABA_ONLY)
`groupId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group/leave'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "whatsappId": 1,
    "groupId": "texto"
  }'

Resposta (200)

resposta.json

{}

🟢 Interativo Baileys

6 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendInteractive/baileys/quickReply

BaileysQuickReply

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`buttons`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/quickReply'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "buttons": [
      {
        "display_text": "texto",
        "id": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/baileys/singleSelect

BaileysSingleSelect

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`list`	object	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/singleSelect'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "list": {
      "title": "texto",
      "sections": [
        {
          "title": "texto",
          "rows": []
        }
      ]
    }
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/baileys/pixButton

BaileysPixButton

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`pixType`	string	Não
`pixKey`	string	Não
`pixName`	string	Não
`bodyText`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/pixButton'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "pixType": "texto",
    "pixKey": "texto",
    "pixName": "texto",
    "bodyText": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/baileys/ctaCopy

BaileysCtaCopy

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`copyCode`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/ctaCopy'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "copyCode": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/baileys/ctaUrl

BaileysCtaUrl

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`url`	string	Não	exemplo.com"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/ctaUrl'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "url": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/baileys/ctaCall

BaileysCtaCall

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`phoneNumber`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/baileys/ctaCall'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "phoneNumber": "texto"
  }'

Resposta (200)

resposta.json

{}

📷 Interativo Instagram

5 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendInteractive/instagram/quickReply

Quick Reply

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`message`	string	Não
`quickReplies`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/instagram/quickReply'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "message": "texto",
    "quickReplies": [
      {
        "content_type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/instagram/buttonTemplate

Button Template

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`message`	string	Não
`buttons`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/instagram/buttonTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "message": "texto",
    "buttons": [
      {
        "type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/instagram/genericTemplate

Generic Template (cards)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`elements`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/instagram/genericTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "elements": [
      {
        "title": "texto",
        "subtitle": "texto",
        "image_url": "texto",
        "buttons": [
          {}
        ]
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/instagram/iceBreakers

Ice Breakers (get/set/delete)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`action`	string	Não
`iceBreakers`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/instagram/iceBreakers'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "action": "texto",
    "iceBreakers": [
      {
        "question": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/instagram/persistentMenu

Persistent Menu (get/set/delete)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`action`	string	Não
`composerInputDisabled`	boolean	Não
`menuItems`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/instagram/persistentMenu'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "action": "texto",
    "composerInputDisabled": true,
    "menuItems": [
      {
        "type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

💬 Interativo Messenger

9 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendInteractive/messenger/quickReply

Quick Reply

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`message`	string	Não
`quickReplies`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/quickReply'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "message": "texto",
    "quickReplies": [
      {
        "content_type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/buttonTemplate

Button Template

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`message`	string	Não
`buttons`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/buttonTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "message": "texto",
    "buttons": [
      {
        "type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/genericTemplate

Generic Template (cards)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`elements`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/genericTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "elements": [
      {
        "title": "texto",
        "subtitle": "texto",
        "image_url": "texto",
        "buttons": [
          {}
        ]
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/mediaTemplate

Media Template (image/video + botões)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`mediaType`	string	Não
`mediaUrl`	string	Não	exemplo.com/imagem.jpg",
`buttons`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/mediaTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "mediaType": "texto",
    "mediaUrl": "texto",
    "buttons": [
      {
        "type": "texto",
        "title": "texto",
        "payload": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/receiptTemplate

Receipt Template (recibo)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`receipt`	object	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/receiptTemplate'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "receipt": {
      "recipient_name": "texto",
      "order_number": "texto",
      "currency": "texto",
      "payment_method": "texto",
      "summary": {
        "total_cost": 1.0
      },
      "elements": [
        {
          "title": "texto",
          "price": 1.0,
          "quantity": 1
        }
      ]
    }
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/messageTag

Message Tag (Marketing/Utility)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`message`	string	Não
`tag`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/messageTag'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "message": "texto",
    "tag": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/messenger/customerFeedback

Customer Feedback Template (NPS/CSAT)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`title`	string	Não
`subtitle`	string	Não
`business_privacy_url`	string	Não	exemplo.com/privacidade",
`expires_in_days`	integer	Não
`feedback_screens`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/messenger/customerFeedback'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "title": "texto",
    "subtitle": "texto",
    "business_privacy_url": "texto",
    "expires_in_days": 1,
    "feedback_screens": [
      {
        "questions": [
          {}
        ]
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/messenger/greeting

Greeting Text (get/set/delete)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`action`	string	Não
`greetings`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/messenger/greeting'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "action": "texto",
    "greetings": [
      {
        "locale": "texto",
        "text": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/messenger/personas

Personas (list/create/delete)

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`action`	string	Não
`name`	string	Não
`profilePictureUrl`	string	Não	exemplo.com/ana.jpg"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/messenger/personas'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "action": "texto",
    "name": "texto",
    "profilePictureUrl": "texto"
  }'

Resposta (200)

resposta.json

{}

🟩 Interativo UazAPI

7 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/button

UazapiButton

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`text`	string	Não
`choices`	array<string>	Não
`footerText`	string	Não
`imageButton`	string	Não	exemplo.com/img.png"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/button'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "text": "texto",
    "choices": [
      "texto"
    ],
    "footerText": "texto",
    "imageButton": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/list

UazapiList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`text`	string	Não
`choices`	array<string>	Não
`listButton`	string	Não
`footerText`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "text": "texto",
    "choices": [
      "texto"
    ],
    "listButton": "texto",
    "footerText": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/poll

UazapiPoll

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`text`	string	Não
`choices`	array<string>	Não
`selectableCount`	integer	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/poll'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "text": "texto",
    "choices": [
      "texto"
    ],
    "selectableCount": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/carousel

UazapiCarousel

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`text`	string	Não
`carousel`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/carousel'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "text": "texto",
    "carousel": [
      {
        "text": "texto",
        "image": "texto",
        "buttons": [
          {}
        ]
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/pixButton

UazapiPixButton

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`pixType`	string	Não
`pixKey`	string	Não
`pixName`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/pixButton'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "pixType": "texto",
    "pixKey": "texto",
    "pixName": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/locationButton

UazapiLocationButton

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`text`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/locationButton'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "text": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/uazapi/requestPayment

UazapiRequestPayment

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`amount`	number	Não
`title`	string	Não
`text`	string	Não
`footer`	string	Não
`itemName`	string	Não
`invoiceNumber`	string	Não
`pixType`	string	Não
`pixKey`	string	Não
`pixName`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/uazapi/requestPayment'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "amount": 1.0,
    "title": "texto",
    "text": "texto",
    "footer": "texto",
    "itemName": "texto",
    "invoiceNumber": "texto",
    "pixType": "texto",
    "pixKey": "texto",
    "pixName": "texto"
  }'

Resposta (200)

resposta.json

{}

🔘 Interativo Waba

2 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendButtonWABA

SendButtonWABA

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`message`	string	Não	Mensagem que acompanhará os botões
`button1`	string	Não	Texto do primeiro botão
`button2`	string	Não	Texto do segundo botão
`button3`	string	Não	Texto do terceiro botão (opcional)
`ticketId`	integer	Não	ID do ticket

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendButtonWABA'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "message": "texto",
    "button1": "texto",
    "button2": "texto",
    "button3": "texto",
    "ticketId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendListWABA

SendListWABA

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`header`	string	Não	Cabeçalho da lista
`body`	string	Não	Corpo da lista
`footer`	string	Não	Rodapé da lista
`button_text`	string	Não	Texto do botão
`sections`	array<object>	Não	Seções da lista (array de objetos)
`ticketId`	integer	Não	ID do ticket

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendListWABA'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "header": "texto",
    "body": "texto",
    "footer": "texto",
    "button_text": "texto",
    "sections": [
      {
        "title": "texto",
        "rows": [
          {}
        ]
      }
    ],
    "ticketId": 1
  }'

Resposta (200)

resposta.json

{}

🟢 Interativo Zapo

7 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/sendInteractive/zapo/quickReply

ZapoQuickReply

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`buttons`	array<object>	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/quickReply'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "buttons": [
      {
        "display_text": "texto",
        "id": "texto"
      }
    ]
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/singleSelect

ZapoSingleSelect

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`list`	object	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/singleSelect'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "list": {
      "title": "texto",
      "sections": [
        {
          "title": "texto",
          "rows": []
        }
      ]
    }
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/pixButton

ZapoPixButton

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`pixType`	string	Não
`pixKey`	string	Não
`pixName`	string	Não
`bodyText`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/pixButton'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "pixType": "texto",
    "pixKey": "texto",
    "pixName": "texto",
    "bodyText": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/ctaCopy

ZapoCtaCopy

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`copyCode`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/ctaCopy'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "copyCode": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/ctaUrl

ZapoCtaUrl

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`url`	string	Não	exemplo.com"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/ctaUrl'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "url": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/ctaCall

ZapoCtaCall

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	object	Não
`footer`	object	Não
`displayText`	string	Não
`phoneNumber`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/ctaCall'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": {
      "text": "texto"
    },
    "footer": {
      "text": "texto"
    },
    "displayText": "texto",
    "phoneNumber": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendInteractive/zapo/poll

ZapoPoll

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`name`	string	Não
`options`	array<string>	Não
`selectableCount`	integer	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendInteractive/zapo/poll'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "name": "texto",
    "options": [
      "texto"
    ],
    "selectableCount": 1
  }'

Resposta (200)

resposta.json

{}

🏷️ Kanban / Tags / Motivos / Filas

14 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/createKanban

CreateKanban

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createKanban'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createQueueData

CreateQueueData

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`queue`	string	Não
`isActive`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createQueueData'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "queue": "texto",
    "isActive": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createReason

CreateReason

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createReason'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createTag

CreateTag

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`tag`	string	Não
`color`	string	Não
`isActive`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createTag'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "tag": "texto",
    "color": "texto",
    "isActive": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteKanban/{id}

DeleteKanban

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteKanban/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteQueueData/{id}

DeleteQueueData

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteQueueData/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteReason/{id}

DeleteReason

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteReason/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteTag/{id}

DeleteTag

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteTag/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listKanban

ListKanban

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listKanban'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listReasons

ListReasons

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listReasons'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateKanban/{id}

UpdateKanban

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateKanban/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateQueueData/{id}

UpdateQueueData

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`queue`	string	Não
`isActive`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateQueueData/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "queue": "texto",
    "isActive": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateReason/{id}

UpdateReason

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`name`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateReason/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateTagData/{id}

UpdateTagData

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`tag`	string	Não
`color`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateTagData/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "tag": "texto",
    "color": "texto"
  }'

Resposta (200)

resposta.json

{}

🔍 Listagens Utilitárias

3 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/listAutoReplies

ListAutoReplies

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listAutoReplies'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listChatFlows

ListChatFlows

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listChatFlows'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listFastReplies

ListFastReplies

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listFastReplies'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

📊 Listagens

8 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/getAllSessionApis

GetAllSessionApis

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/getAllSessionApis'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listChannels

ListChannels

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listChannels'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listContacts

ListContacts

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`pageNumber`	query	Não	Número da página	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listContacts'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'pageNumber=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listOpportunities

ListOpportunities

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não	Número da página	`1`
`limit`	query	Não	Limite de resultados por página	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listOpportunities'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listQueues

ListQueues

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listQueues'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listSessions

ListSessions

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listSessions'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listTags

ListTags

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`isActive`	query	Não	Filtrar por tags ativas (true/false)	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listTags'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'isActive=texto'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listTickets

ListTickets

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`pageNumber`	query	Não	Número da página	`1`
`status`	query	Não	Status do ticket (open, pending, closed)	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listTickets'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'pageNumber=1'
  -G --data-urlencode 'status=texto'

Resposta (200)

resposta.json

{}

📞 Logs de Chamadas

4 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/callLog/list

CallLogList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/callLog/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/callLog/show/{id}

CallLogShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/callLog/show/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/wavoip/calls

WavoipCallList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/wavoip/calls'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/wavoip/calls/{id}

WavoipCallShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/wavoip/calls/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

📨 Mensagens Avançadas

3 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/searchMessages

SearchMessages

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	query	Não		`texto`
`searchParam`	query	Não		`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/searchMessages'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'ticketId=texto'
  -G --data-urlencode 'searchParam=texto'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendLocation

SendLocation

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não
`latitude`	number	Não
`longitude`	number	Não
`name`	string	Não
`address`	string	Não
`ticketId`	string	Não
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendLocation'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "latitude": 1.0,
    "longitude": 1.0,
    "name": "texto",
    "address": "texto",
    "ticketId": "texto",
    "externalKey": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendVcard

SendVcard

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não
`contact`	array<object>	Não
`ticketId`	string	Não
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendVcard'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "contact": [
      {
        "fullName": "texto",
        "wuid": "texto",
        "phoneNumber": "texto"
      }
    ],
    "ticketId": "texto",
    "externalKey": "texto"
  }'

Resposta (200)

resposta.json

{}

👥 Mensagens em Grupo

2 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/group

SendGroupMessageAPI

Endpoint com mais de um formato de payload na coleção oficial: **SendGroupMessageAPIFile**, **SendGroupMessageAPIText**. Veja os exemplos do corpo para escolher a variante.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`body`	string	Não	Texto da mensagem que será enviada
`number`	string	Não	ID do grupo do WhatsApp
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/group'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "body": "texto",
    "number": "texto",
    "externalKey": "texto",
    "isClosed": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/groupMediaUrl

SendMessageAPIFileURLGroup

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`mediaUrl`	string	Não	URL do arquivo que será enviado (imagem, documento, etc)
`body`	string	Não	Texto da mensagem que acompanhará o arquivo
`number`	string	Não	ID do grupo do WhatsApp
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/groupMediaUrl'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "mediaUrl": "texto",
    "body": "texto",
    "number": "texto",
    "externalKey": "texto",
    "isClosed": true
  }'

Resposta (200)

resposta.json

{}

📨 Mensagens

6 rotas · exige Authorization: Bearer {token}

GET/v2/api/external/{apiId}/getMessageByMessageId

GetMessageByMessageId

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`messageId`	query	Não	ID da mensagem retornado pela Meta (ex: wamid.xxxxx)	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/getMessageByMessageId'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'messageId=texto'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}

SendMessageAPI

Endpoint com mais de um formato de payload na coleção oficial: **SendMessageAPIFile**, **SendMessageAPIText**. Veja os exemplos do corpo para escolher a variante.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`body`	string	Não	Texto da mensagem que será enviada
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "body": "texto",
    "number": "texto",
    "externalKey": "texto",
    "isClosed": true,
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/url

SendMessageAPIFileURL

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`mediaUrl`	string	Não	URL do arquivo que será enviado (imagem, documento, etc)
`body`	string	Não	Texto da mensagem que acompanhará o arquivo
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/url'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "mediaUrl": "texto",
    "body": "texto",
    "number": "texto",
    "externalKey": "texto",
    "isClosed": true,
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/base64

SendMessageAPITextBase64

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`body`	string	Não	Texto da mensagem que acompanhará o arquivo
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`base64Data`	string	Não	Arquivo codificado em base64
`mimeType`	string	Não	Tipo MIME do arquivo (ex: image/png, application/pdf)
`fileName`	string	Não	Nome do arquivo que será exibido
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/base64'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "body": "texto",
    "number": "texto",
    "base64Data": "texto",
    "mimeType": "texto",
    "fileName": "texto",
    "isClosed": true,
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/voice

SendMessageAPIVoice

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`audio`	string	Não	URL do arquivo de áudio que será enviado
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`externalKey`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/voice'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "audio": "texto",
    "number": "texto",
    "externalKey": "texto",
    "isClosed": true
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/params/

SendMessageParams

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`body`	query	Não	Texto da mensagem que será enviada	`texto`
`number`	query	Não	Número do WhatsApp do destinatário (formato: 5511999999999)	`1`
`externalKey`	query	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)	`texto`
`bearertoken`	query	Não	Token de autenticação	`texto`
`isClosed`	query	Não	Define se o ticket será fechado após o envio	`texto`
`validateNumber`	query	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA).	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/params/'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'body=texto'
  -G --data-urlencode 'number=1'
  -G --data-urlencode 'externalKey=texto'
  -G --data-urlencode 'bearertoken=texto'
  -G --data-urlencode 'isClosed=texto'
  -G --data-urlencode 'validateNumber=texto'

Resposta (200)

resposta.json

{}

💼 Oportunidades

3 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/createOpportunity

CreateOpportunity

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Campos do contato
`contactName`	string	Não	nome do contato
`email`	string	Não	email do contato
`name`	string	Não	Campos da oportunidade
`value`	number	Não	valor da oportunidade
`status`	string	Não	pode ser: "open", "win", "lose"
`pipelineId`	integer	Não	ID do pipeline
`stageId`	integer	Não	ID do estágio
`responsibleId`	integer	Não	ID do responsável
`closingForecast`	string	Não	data esperada de fechamento
`description`	string	Não	descrição da oportunidade
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createOpportunity'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "contactName": "texto",
    "email": "texto",
    "name": "texto",
    "value": 1.0,
    "status": "texto",
    "pipelineId": 1,
    "stageId": 1,
    "responsibleId": 1,
    "closingForecast": "texto",
    "description": "texto",
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/deleteOpportunity

DeleteOpportunity

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`opportunityId`	integer	Não	Campos da oportunidade

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/deleteOpportunity'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "opportunityId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateOpportunity

UpdateOpportunity

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`opportunityId`	integer	Não	Campos da oportunidade
`name`	string	Não	nome da oportunidade
`value`	number	Não	valor da oportunidade
`status`	string	Não	pode ser: "open", "win", "lose"
`pipelineId`	integer	Não	ID do pipeline
`stageId`	integer	Não	ID do estágio
`responsibleId`	integer	Não	ID do responsável
`closingForecast`	string	Não	data esperada de fechamento
`description`	string	Não	descrição da oportunidade

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateOpportunity'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "opportunityId": 1,
    "name": "texto",
    "value": 1.0,
    "status": "texto",
    "pipelineId": 1,
    "stageId": 1,
    "responsibleId": 1,
    "closingForecast": "texto",
    "description": "texto"
  }'

Resposta (200)

resposta.json

{}

📋 Templates WABA

3 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/template

SendTemplateWaba

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`templateData`	object	Não	Dados do template do WhatsApp Business API
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/template'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "isClosed": true,
    "templateData": {
      "messaging_product": "texto",
      "to": "texto",
      "type": "texto",
      "template": {
        "name": "texto",
        "language": {
          "code": "texto"
        }
      }
    },
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/templateBody

SendTemplateWabaBody

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`templateData`	object	Não	Dados do template do WhatsApp Business API
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/templateBody'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "isClosed": true,
    "templateData": {
      "messaging_product": "texto",
      "to": "texto",
      "type": "texto",
      "template": {
        "name": "texto",
        "language": {
          "code": "texto"
        }
      }
    },
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/templateMarketingBody

SendTemplateWabaMarketing

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do destinatário (formato: 5511999999999)
`isClosed`	boolean	Não	Define se o ticket será fechado após o envio
`templateData`	object	Não	Dados do template do WhatsApp Business API
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/templateMarketingBody'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "isClosed": true,
    "templateData": {
      "messaging_product": "texto",
      "to": "texto",
      "type": "texto",
      "template": {
        "name": "texto",
        "language": {
          "code": "texto"
        }
      }
    },
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

🎫 Tickets - Extras

8 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/ticket/pause/end/{ticketId}

EndTicketPause

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/ticket/pause/end/{ticketId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listTicketEvaluations

ListTicketEvaluations

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`page`	query	Não		`1`
`limit`	query	Não		`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listTicketEvaluations'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'page=1'
  -G --data-urlencode 'limit=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendEvaluation

SendEvaluation

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`ticketId`	integer	Não
`body`	string	Não
`externalKey`	string	Não
`force`	boolean	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendEvaluation'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "body": "texto",
    "externalKey": "texto",
    "force": true
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/ticket/pause/logs/{ticketId}

ListTicketPauseLogs

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/ticket/pause/logs/{ticketId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showTicketById

ShowTicketById

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showTicketById'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/ticket/pause/start/{ticketId}

StartTicketPause

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`pauseReason`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/ticket/pause/start/{ticketId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "pauseReason": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/ticket/share

TicketShareCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	string	Não
`inviteUrl`	string	Não	app.example.com/shared"

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/ticket/share'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": "texto",
    "inviteUrl": "texto"
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/ticket/share/{ticketId}

TicketShareShow

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/ticket/share/{ticketId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

🎫 Tickets

17 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/addTag

AddTag

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que receberá a tag
`tagId`	integer	Não	ID da tag que será adicionada (pode usar tagId ou tagIds)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/addTag'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "tagId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/addTagContact

AddTagContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`contactId`	integer	Não	Atribui tag(s) ao CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato.
`tagId`	integer	Não	OU localize pelo numero (aceita variantes BR) "number": "5511999999999", ID da tag a adicionar (use tagId ou tagIds). Mantem as tags existentes.
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/addTagContact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "contactId": 1,
    "tagId": 1,
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/removeTagContact

RemoveTagContact

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Remove tag(s) do CONTATO sem precisar de ticket. Informe contactId OU number para localizar o contato.
`tagIds`	array<integer>	Não	OU localize pelo ID do contato "contactId": 123, ID(s) da tag a remover (use tagId ou tagIds)
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/removeTagContact'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto",
    "tagIds": [
      1
    ],
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createNotes

CreateNotes

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`notes`	string	Não	Texto da nota que será adicionada ao ticket
`ticketId`	integer	Não	ID do ticket que receberá a nota
`userId`	integer	Não	ID do usuário que está criando a nota
`idFront`	string	Não	Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createNotes'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "notes": "texto",
    "ticketId": 1,
    "userId": 1,
    "idFront": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/createTicket

CreateTicket

Endpoint com mais de um formato de payload na coleção oficial: **CreateTicket**, **CreateTicketFile**, **CreateTicketWebmail**. Veja os exemplos do corpo para escolher a variante.

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`body`	string	Não	Texto da mensagem inicial do ticket
`number`	string	Não	Para canais WhatsApp/outros: número do contato (formato: 5511999999999)
`externalKey`	string	Não	Para canal WEBMAIL: email do contato (obrigatório quando channelId for de um canal webmail) "email": "contato@exemplo.com", ID do canal (opcional). Para webmail: envie o id do canal webmail (não vem do APIConfig) "channelId": 17841443941506797, Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)
`userId`	integer	Não	ID do usuário que está criando o ticket
`status`	string	Não	Status inicial do ticket (pending ou open)
`validateNumber`	boolean	Não	Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createTicket'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "body": "texto",
    "number": "texto",
    "externalKey": "texto",
    "userId": 1,
    "status": "texto",
    "validateNumber": true
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listNotes

ListNotes

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`ticketId`	query	Não	ID do ticket	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listNotes'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'ticketId=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/removeTag

RemoveTag

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que terá a tag removida
`tagId`	integer	Não	ID da tag que será removida (pode usar tagId ou tagIds)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/removeTag'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "tagId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/sendPresence

SendPresence

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket associado
`state`	string	Não	Estado de presence: "typing" (digitando), "paused" (pausado) ou "recording" (gravando)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/sendPresence'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "state": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updatequeue

SetQueue

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que terá a fila alterada
`queueId`	integer	Não	ID da fila que será atribuída ao ticket

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updatequeue'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "queueId": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updatetag

SetTag

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que terá a tag alterada
`tag`	integer	Não	ID da tag que será atribuída ao ticket

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updatetag'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "tag": 1
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateticketinfo

SetTicketInfo

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que será atualizado
`userId`	integer	Não	ID do usuário que está fazendo a atualização
`status`	string	Não	Status do ticket (pending, open, closed)
`queueId`	string	Não	ID da fila do ticket (null para remover)
`typebotStatus`	boolean	Não	Status de integração com Typebot
`chatgptStatus`	boolean	Não	Status de integração com ChatGPT
`dialogflowStatus`	boolean	Não	Status de integração com Dialogflow
`difyStatus`	boolean	Não	Status de integração com Dify
`n8nStatus`	boolean	Não	Status de integração com N8N
`chatFlowId`	string	Não	ID do fluxo de chat (null para remover)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateticketinfo'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "userId": 1,
    "status": "texto",
    "queueId": "texto",
    "typebotStatus": true,
    "chatgptStatus": true,
    "dialogflowStatus": true,
    "difyStatus": true,
    "n8nStatus": true,
    "chatFlowId": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showAllMessages

ShowAllMessages

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticket`	string	Não	ID do ticket que terá as mensagens listadas

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showAllMessages'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticket": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showallticket

ShowAllTicketInformation

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do contato (formato: 5511999999999)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showallticket'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showticket

ShowTicketInformation

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do contato (formato: 5511999999999)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showticket'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/showticketchatbot

ShowTicketInformationChatBot

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`number`	string	Não	Número do WhatsApp do contato (formato: 5511999999999)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/showticketchatbot'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "number": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateNote

UpdateNote

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`noteId`	integer	Não	ID da nota que será atualizada
`notes`	string	Não	Novo conteúdo da nota

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateNote'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "noteId": 1,
    "notes": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateTicketChannel

UpdateTicketChannel

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`ticketId`	integer	Não	ID do ticket que terá o canal alterado
`whatsappId`	integer	Não	ID do novo canal (WhatsApp)
`channel`	string	Não	Tipo do canal (whatsapp, baileys, zapo, waba, etc)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateTicketChannel'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "ticketId": 1,
    "whatsappId": 1,
    "channel": "texto"
  }'

Resposta (200)

resposta.json

{}

✅ To-Do List

5 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/todo/create

TodoCreate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.
`name`	string	Não
`description`	string	Não
`owner`	string	Não
`ownerId`	string	Não
`status`	string	Não
`priority`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/todo/create'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "name": "texto",
    "description": "texto",
    "owner": "texto",
    "ownerId": "texto",
    "status": "texto",
    "priority": "texto"
  }'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/todo/delete/{id}

TodoDelete

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/todo/delete/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{}'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/todo/list

TodoList

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/todo/list'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/todo/logs/{userId}

TodoLogs

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`userId`	path	Sim	Identificador do recurso na rota.	`texto`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/todo/logs/{userId}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/todo/update/{id}

TodoUpdate

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`id`	path	Sim	Identificador do recurso na rota.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`status`	string	Não

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/todo/update/{id}'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "status": "texto"
  }'

Resposta (200)

resposta.json

{}

👥 Usuários

4 rotas · exige Authorization: Bearer {token}

POST/v2/api/external/{apiId}/createUser

CreateUser

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`email`	string	Não	Email do usuário
`password`	string	Não	Senha do usuário (mínimo 8 caracteres)
`name`	string	Não	Nome completo do usuário
`profile`	string	Não	Perfil do usuário (admin, user)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/createUser'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "email": "texto",
    "password": "texto",
    "name": "texto",
    "profile": "texto"
  }'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/getUserStatus

GetUserStatus

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`userId`	query	Não	ID do usuário	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/getUserStatus'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'userId=1'

Resposta (200)

resposta.json

{}

GET/v2/api/external/{apiId}/listUsers

ListUsers

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`
`pageNumber`	query	Não	Número da página	`1`

Exemplo de chamada

curl.sh

curl -X GET 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/listUsers'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -G --data-urlencode 'pageNumber=1'

Resposta (200)

resposta.json

{}

POST/v2/api/external/{apiId}/updateUser

UpdateUser

Parâmetros

Nome	Local	Obrig.	Descrição	Exemplo
`apiId`	path	Sim	ID da API externa cadastrada no CRM Hyper.	`texto`

Corpo da requisição (JSON)

Campo	Tipo	Obrig.	Descrição
`userId`	integer	Não	ID do usuário que será atualizado
`name`	string	Não	Nome completo do usuário (opcional)
`email`	string	Não	Email do usuário (opcional)

Exemplo de chamada

curl.sh

curl -X POST 'https://backend.hypersistema.com.br/v2/api/external/{apiId}/updateUser'
  -H 'Authorization: Bearer {token}'
  -H 'Content-Type: application/json'
  -d '{
    "userId": 1,
    "name": "texto",
    "email": "texto"
  }'

Resposta (200)

resposta.json

{}