Caixas de Entrada
Liste e consulte os canais de atendimento configurados na sua conta.
GET
Listar Caixas de Entrada
Retorna todas as caixas de entrada da conta.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/inboxes
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/inboxes \
--header 'api_access_token: '
200
{
"payload": [
{
"id": 1,
"name": "WhatsApp Vendas",
"channel_type": "Channel::Whatsapp",
"phone_number": "+5511999990000",
"working_hours_enabled": true,
"out_of_office_message": "Retornaremos em breve!",
"enable_auto_assignment": true
},
{
"id": 2,
"name": "Chat do Site",
"channel_type": "Channel::WebWidget",
"website_url": "https://klivo.marketing"
}
]
}
GET
Agentes de uma Caixa de Entrada
Lista os agentes responsáveis por uma caixa de entrada específica.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/inbox_members/{inbox_id}
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
inbox_id
integer
obrigatório
ID da caixa de entrada.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/inbox_members/{inbox_id} \
--header 'api_access_token: '
200
{
"payload": [
{
"id": 1,
"name": "João Silva",
"role": "agent",
"availability_status": "online"
}
]
}
POST
Atualizar Agentes da Caixa
Define quais agentes têm acesso a uma caixa de entrada.
POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/inbox_members
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Body Parameters
inbox_id
integer
obrigatório
ID da caixa de entrada.
user_ids
array
obrigatório
Array com IDs dos agentes.
CURL
curl --request POST \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/inbox_members \
--header 'api_access_token: ' \
--header 'Content-Type: application/json' \
--data '{
"inbox_id": 1,
"user_ids": [1, 2, 4]
}'
200
{
"payload": [
{"id": 1, "name": "João Silva"},
{"id": 2, "name": "Maria Santos"}
]
}