💬 Interativo Messenger
Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Escolha:Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/quickReply HTTP/1.1
Host: api.seudominio.com.br
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"
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Opções:Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/buttonTemplate HTTP/1.1
Host: api.seudominio.com.br
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://..."
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/genericTemplate HTTP/1.1
Host: api.seudominio.com.br
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"
}
]
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123imageexemplo.com/imagem.jpg",
https://exemplo.com/imagem.jpgRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/mediaTemplate HTTP/1.1
Host: api.seudominio.com.br
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"
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/receiptTemplate HTTP/1.1
Host: api.seudominio.com.br
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
}
]
}
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Seu pedido foi aprovado.POST_PURCHASE_UPDATERequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/messageTag HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"ticketId": 123,
"message": "Seu pedido foi aprovado.",
"tag": "POST_PURCHASE_UPDATE"
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
123Avalie sua experiênciaOpcionalexemplo.com/privacidade",
https://exemplo.com/privacidade7Requisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/sendInteractive/messenger/customerFeedback HTTP/1.1
Host: api.seudominio.com.br
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?"
}
]
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
setRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/messenger/greeting HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"action": "set",
"greetings": [
{
"locale": "default",
"text": "Olá! Como podemos ajudar?"
}
]
}{}Token da API do tenant (na coleção Postman: BearerToken).
ID da API externa cadastrada no Z-PRO.
createAtendente Anaexemplo.com/ana.jpg"
https://exemplo.com/ana.jpgRequisição processada com sucesso.
Parâmetros inválidos ou faltando.
Token ausente, inválido ou sem permissão.
POST /v2/api/external/{apiId}/messenger/personas HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"action": "create",
"name": "Atendente Ana",
"profilePictureUrl": "https://exemplo.com/ana.jpg"
}{}Atualizado
Isto foi útil?

