Pular para o conteúdo

Com a API de canais você pode visualizar os canais de comunicação disponíveis na sua empresa.

Listar Canais

GET https://api.tinko.com.br/v1/channels

Retorna todos os canais disponíveis na empresa. Retorna apenas canais que o usuário tem permissão de acesso.

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Query Parameters

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página. Default: 1
per_pageintegerNãoRegistros por página (máx: 100). Default: 20
typestringNãoFiltrar por tipo: whatsapp, whatsapp_unofficial, instagram, messenger, telegram, widget. Default: todos
statusstringNãoFiltrar por status: connected, disconnected. Default: todos
searchstringNãoBuscar por nome do canal

Exemplo de requisição

Terminal window
curl -X GET "https://api.tinko.com.br/v1/channels?type=whatsapp&status=connected" \
-H "Authorization: Bearer SEU_TOKEN"

Response

{
"success": true,
"data": [
{
"id": "01arz3ndektsv4rrffq69g5fav",
"name": "WhatsApp Vendas",
"type": "whatsapp",
"status": "connected"
},
{
"id": "01hxyz123abc456def789ghjkm",
"name": "WhatsApp Suporte",
"type": "whatsapp_unofficial",
"status": "connected"
},
{
"id": "01j7m8n9p0q1r2s3t4u5v6w7x",
"name": "Instagram",
"type": "instagram",
"status": "connected"
},
{
"id": "01k8l9m0n1o2p3q4r5s6t7u8v9w",
"name": "Chat do Site",
"type": "widget",
"status": "connected"
}
],
"pagination": {
"total": 4,
"per_page": 20,
"current_page": 1,
"last_page": 1
}
}

Campos do Response

CampoTipoDescrição
idstringID do canal
namestringNome do canal
typestringTipo do canal
statusstringStatus: connected, disconnected

Tipos de Canal

TipoDescrição
whatsappWhatsApp Business API (oficial)
whatsapp_unofficialWhatsApp conectado via API
instagramInstagram Direct
messengerFacebook Messenger
telegramTelegram
widgetWidget de chat para websites

Uso do ID

O ID do canal é utilizado em diversas operações:

  • Enviar mensagens: especificando o canal de origem no campo channel
  • Transferir conversas: direcionando para outro canal
  • Vincular usuários: dando acesso a canais específicos
  • Listar templates: filtrando templates por canal