🟩 Interativo Uaz API

UazapiButton

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/button

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

textstringOpcional

choicesstring[]Opcional

footerTextstringOpcional

imageButtonstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/button

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/button HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "ticketId": 1262,
  "text": "Escolha uma opcao:",
  "choices": [
    "Opcao 1",
    "Opcao 2",
    "Opcao 3"
  ],
  "footerText": "Rodape opcional",
  "imageButton": "https://exemplo.com/img.png"
}

200

Successful response

UazapiList

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/list

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

textstringOpcional

choicesstring[]Opcional

listButtonstringOpcional

footerTextstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/list

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/list HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "ticketId": 1262,
  "text": "Escolha uma opcao:",
  "choices": [
    "Item 1",
    "Item 2",
    "Item 3",
    "Item 4"
  ],
  "listButton": "Ver opcoes",
  "footerText": "Selecione uma opcao"
}

200

Successful response

UazapiPoll

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/poll

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

textstringOpcional

choicesstring[]Opcional

selectableCountnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/poll

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/poll HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

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

200

Successful response

UazapiCarousel

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/carousel

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

textstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/carousel

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/carousel HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "ticketId": 1262,
  "text": "Confira nossas opcoes:",
  "carousel": [
    {
      "text": "Produto A",
      "image": "https://exemplo.com/a.png",
      "buttons": [
        {
          "text": "Ver detalhes",
          "type": "REPLY"
        }
      ]
    },
    {
      "text": "Produto B",
      "image": "https://exemplo.com/b.png",
      "buttons": [
        {
          "text": "Comprar",
          "type": "URL"
        }
      ]
    }
  ]
}

200

Successful response

UazapiPixButton

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/pixButton

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

pixTypestringOpcional

pixKeystringOpcional

pixNamestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/pixButton

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/pixButton HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

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

200

Successful response

UazapiLocationButton

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/locationButton

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

textstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/locationButton

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/locationButton HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "ticketId": 1262,
  "text": "Por favor, compartilhe sua localizacao:"
}

200

Successful response

UazapiRequestPayment

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{ApiID}/sendInteractive/uazapi/requestPayment

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

amountnumberOpcional

titlestringOpcional

textstringOpcional

footerstringOpcional

itemNamestringOpcional

invoiceNumberstringOpcional

pixTypestringOpcional

pixKeystringOpcional

pixNamestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendInteractive/uazapi/requestPayment

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendInteractive/uazapi/requestPayment HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "ticketId": 1262,
  "amount": 150,
  "title": "Pedido #001",
  "text": "Sua cobranca esta pronta:",
  "footer": "Vencimento em 3 dias",
  "itemName": "Produto X",
  "invoiceNumber": "NF-001",
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiario"
}

200

Successful response