💬 Interativo Messenger

Quick Reply

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

messagestringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "ticketId": 123,
  "message": "Escolha:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    }
  ]
}

200

Successful response

Button Template

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

messagestringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/buttonTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "ticketId": 123,
  "message": "Opções:",
  "buttons": [
    {
      "type": "postback",
      "title": "Opção 1",
      "payload": "OPT_1"
    },
    {
      "type": "web_url",
      "title": "Visitar",
      "url": "https://..."
    }
  ]
}

200

Successful response

Generic Template (cards)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/genericTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "ticketId": 123,
  "elements": [
    {
      "title": "Card 1",
      "subtitle": "Subtítulo",
      "image_url": "https://...",
      "buttons": [
        {
          "type": "postback",
          "title": "Ação",
          "payload": "ACT"
        }
      ]
    }
  ]
}

200

Successful response

Media Template (image/video + botões)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

mediaTypestringOpcional

mediaUrlstringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/mediaTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "ticketId": 123,
  "mediaType": "image",
  "mediaUrl": "https://exemplo.com/imagem.jpg",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    }
  ]
}

200

Successful response

Receipt Template (recibo)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/receiptTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "ticketId": 123,
  "receipt": {
    "recipient_name": "João Silva",
    "order_number": "ORD-001",
    "currency": "BRL",
    "payment_method": "PIX",
    "summary": {
      "total_cost": 150
    },
    "elements": [
      {
        "title": "Produto A",
        "price": 100,
        "quantity": 1
      },
      {
        "title": "Produto B",
        "price": 50,
        "quantity": 1
      }
    ]
  }
}

200

Successful response

Message Tag (Marketing/Utility)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

messagestringOpcional

tagstringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/messageTag HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "ticketId": 123,
  "message": "Seu pedido foi aprovado.",
  "tag": "POST_PURCHASE_UPDATE"
}

200

Successful response

Customer Feedback Template (NPS/CSAT)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

titlestringOpcional

subtitlestringOpcional

business_privacy_urlstringOpcional

expires_in_daysnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/messenger/customerFeedback HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "ticketId": 123,
  "title": "Avalie sua experiência",
  "subtitle": "Opcional",
  "business_privacy_url": "https://exemplo.com/privacidade",
  "expires_in_days": 7,
  "feedback_screens": [
    {
      "questions": [
        {
          "id": "CSAT",
          "type": "csat",
          "title": "Como foi nosso atendimento?"
        }
      ]
    }
  ]
}

200

Successful response

Greeting Text (get/set/delete)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

actionstringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/messenger/greeting HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "action": "set",
  "greetings": [
    {
      "locale": "default",
      "text": "Olá! Como podemos ajudar?"
    }
  ]
}

200

Successful response

Personas (list/create/delete)

post

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

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

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

actionstringOpcional

namestringOpcional

profilePictureUrlstringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/messenger/personas HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "action": "create",
  "name": "Atendente Ana",
  "profilePictureUrl": "https://exemplo.com/ana.jpg"
}

200

Successful response