Integrações

Integrações prontas (ex.: Chatwoot) ligadas à instância.

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Listar integrações

GET/v1/instances/{instanceId}/integrations

API OnZap

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Criar integração

POST/v1/instances/{instanceId}/integrations

API OnZap

Corpo (JSON)

appstringobrigatório

Valores:argentine-phone-numbersbrazilian-phone-numberschatwootcallsmcpmexican-phone-numbersphone-numbers

configobjectobrigatório

idstringobrigatório

enabledbooleanopcional

Enable or disable this app without deleting it. If omitted, treated as enabled (true).

Requisição

curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "argentine-phone-numbers",
    "config": {},
    "id": "app_01jabcdefghjkmnpqrstvwxy"
  }'

Resposta

Sucesso

Dados da integração

GET/v1/instances/{instanceId}/integrations/{appId}

API OnZap

Parâmetros do caminho

appIdstringobrigatório

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/APPID" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Atualizar integração

PUT/v1/instances/{instanceId}/integrations/{appId}

API OnZap

Parâmetros do caminho

appIdstringobrigatório

Corpo (JSON)

appstringobrigatório

Valores:argentine-phone-numbersbrazilian-phone-numberschatwootcallsmcpmexican-phone-numbersphone-numbers

configobjectobrigatório

idstringobrigatório

enabledbooleanopcional

Enable or disable this app without deleting it. If omitted, treated as enabled (true).

Requisição

curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/APPID" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "app": "argentine-phone-numbers",
    "config": {},
    "id": "app_01jabcdefghjkmnpqrstvwxy"
  }'

Resposta

Sucesso

Excluir integração

DELETE/v1/instances/{instanceId}/integrations/{appId}

API OnZap

Parâmetros do caminho

appIdstringobrigatório

Requisição

curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/APPID" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar dados armazenados da integração

POST/v1/instances/{instanceId}/integrations/{appId}/purge

API OnZap

Parâmetros do caminho

appIdstringobrigatório

Requisição

curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/APPID/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar dados de uma integração pelo tipo

POST/v1/instances/{instanceId}/integrations/types/{app}/purge

API OnZap

Parâmetros do caminho

appstringobrigatório

Requisição

curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/types/APP/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache em memória — números (regras próprias)

GET/v1/instances/{instanceId}/integrations/phone-numbers/cache/memory

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/phone-numbers/cache/memory" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache persistente — números (regras próprias)

GET/v1/instances/{instanceId}/integrations/phone-numbers/cache/db

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/phone-numbers/cache/db" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Estatísticas do cache — números (regras próprias)

GET/v1/instances/{instanceId}/integrations/phone-numbers/cache/stats

API OnZap

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/phone-numbers/cache/stats" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar cache — números (regras próprias)

DELETE/v1/instances/{instanceId}/integrations/phone-numbers/cache/purge

API OnZap

Requisição

curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/phone-numbers/cache/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache em memória — números brasileiros (9º dígito)

GET/v1/instances/{instanceId}/integrations/brazilian-phone-numbers/cache/memory

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/brazilian-phone-numbers/cache/memory" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache persistente — números brasileiros (9º dígito)

GET/v1/instances/{instanceId}/integrations/brazilian-phone-numbers/cache/db

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/brazilian-phone-numbers/cache/db" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Estatísticas do cache — números brasileiros (9º dígito)

GET/v1/instances/{instanceId}/integrations/brazilian-phone-numbers/cache/stats

API OnZap

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/brazilian-phone-numbers/cache/stats" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar cache — números brasileiros (9º dígito)

DELETE/v1/instances/{instanceId}/integrations/brazilian-phone-numbers/cache/purge

API OnZap

Requisição

curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/brazilian-phone-numbers/cache/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache em memória — números argentinos

GET/v1/instances/{instanceId}/integrations/argentine-phone-numbers/cache/memory

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/argentine-phone-numbers/cache/memory" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache persistente — números argentinos

GET/v1/instances/{instanceId}/integrations/argentine-phone-numbers/cache/db

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/argentine-phone-numbers/cache/db" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Estatísticas do cache — números argentinos

GET/v1/instances/{instanceId}/integrations/argentine-phone-numbers/cache/stats

API OnZap

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/argentine-phone-numbers/cache/stats" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar cache — números argentinos

DELETE/v1/instances/{instanceId}/integrations/argentine-phone-numbers/cache/purge

API OnZap

Requisição

curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/argentine-phone-numbers/cache/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache em memória — números mexicanos

GET/v1/instances/{instanceId}/integrations/mexican-phone-numbers/cache/memory

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/mexican-phone-numbers/cache/memory" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Cache persistente — números mexicanos

GET/v1/instances/{instanceId}/integrations/mexican-phone-numbers/cache/db

API OnZap

Parâmetros de query

limitnumberopcional

offsetnumberopcional

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/mexican-phone-numbers/cache/db" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Estatísticas do cache — números mexicanos

GET/v1/instances/{instanceId}/integrations/mexican-phone-numbers/cache/stats

API OnZap

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/mexican-phone-numbers/cache/stats" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso

Limpar cache — números mexicanos

DELETE/v1/instances/{instanceId}/integrations/mexican-phone-numbers/cache/purge

API OnZap

Requisição

curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/integrations/mexican-phone-numbers/cache/purge" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Sucesso