🟢 Interativo Zapo

ZapoQuickReply

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/quickReply HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opcao:"
  },
  "footer": {
    "text": "Rodape opcional"
  },
  "buttons": [
    {
      "display_text": "Opcao 1",
      "id": "op1"
    },
    {
      "display_text": "Opcao 2",
      "id": "op2"
    }
  ]
}

{}

ZapoSingleSelect

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/singleSelect HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opcao:"
  },
  "footer": {
    "text": "Rodape"
  },
  "list": {
    "title": "Ver opcoes",
    "sections": [
      {
        "title": "Secao 1",
        "rows": [
          {
            "id": "1",
            "title": "Item 1",
            "description": "Descricao"
          },
          {
            "id": "2",
            "title": "Item 2"
          }
        ]
      }
    ]
  }
}

{}

ZapoPixButton

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

pixTypestringOpcionalExample: EVP

pixKeystringOpcionalExample: chave-aleatoria-uuid

pixNamestringOpcionalExample: Nome Beneficiario

bodyTextstringOpcionalExample: Pague com PIX:

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/pixButton HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiario",
  "bodyText": "Pague com PIX:"
}

{}

ZapoCtaCopy

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

displayTextstringOpcionalExample: Copiar codigo

copyCodestringOpcionalExample: BR123456789

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/ctaCopy HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "ticketId": 1262,
  "body": {
    "text": "Copie seu codigo:"
  },
  "footer": {
    "text": "Valido por 24h"
  },
  "displayText": "Copiar codigo",
  "copyCode": "BR123456789"
}

{}

ZapoCtaUrl

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

displayTextstringOpcionalExample: Visitar site

urlstringOpcional

exemplo.com"

Example: https://exemplo.com

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/ctaUrl HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "ticketId": 1262,
  "body": {
    "text": "Acesse nosso site:"
  },
  "footer": {
    "text": "Clique para visitar"
  },
  "displayText": "Visitar site",
  "url": "https://exemplo.com"
}

{}

ZapoCtaCall

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

displayTextstringOpcionalExample: Ligar agora

phoneNumberstringOpcionalExample: [phone]

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/ctaCall HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "ticketId": 1262,
  "body": {
    "text": "Precisa de ajuda?"
  },
  "footer": {
    "text": "Ligue para nos"
  },
  "displayText": "Ligar agora",
  "phoneNumber": "[phone]"
}

{}

ZapoPoll

post

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

ticketIdintegerOpcionalExample: 1262

namestringOpcionalExample: Qual sua preferencia?

optionsstring[]OpcionalExample: Opcao A

selectableCountintegerOpcionalExample: 1

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

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

POST /v2/api/external/{apiId}/sendInteractive/zapo/poll HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "ticketId": 1262,
  "name": "Qual sua preferencia?",
  "options": [
    "Opcao A",
    "Opcao B",
    "Opcao C"
  ],
  "selectableCount": 1
}

{}