📊 Listagens

GetAllSessionApis

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/getAllSessionApis

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/getAllSessionApis

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/getAllSessionApis HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListChannels

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listChannels

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listChannels

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listChannels HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListContacts

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listContacts

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageNumberintegerOpcional

Número da página

Example: 1

searchParamstringOpcional

Parâmetro de busca (opcional)

walletIdstringOpcional

ID da wallet (opcional)

tagIdstringOpcional

ID da tag (opcional)

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listContacts

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listContacts HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListOpportunities

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listOpportunities

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageintegerOpcional

Número da página

Example: 1

limitintegerOpcional

Limite de resultados por página

Example: 40

statusstringOpcional

Status da oportunidade (opcional)

pipelineIdstringOpcional

ID do pipeline (opcional)

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listOpportunities

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listOpportunities HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListQueues

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listQueues

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listQueues

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listQueues HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListSessions

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listSessions

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listSessions

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listSessions HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListTags

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listTags

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

isActivebooleanOpcional

Filtrar por tags ativas (true/false)

Example: true

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listTags

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listTags HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

ListTickets

get

https://{{baseurl}}https://{{BaseUrl}}

/v2/api/external/{ApiID}/listTickets

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

pageNumberintegerOpcional

Número da página

Example: 1

statusstringOpcional

Status do ticket (open, pending, closed)

Example: open

searchParamstringOpcional

Parâmetro de busca (opcional)

queuesIdsstringOpcional

IDs das filas (opcional)

whatsappIdsstringOpcional

IDs dos canais (opcional)

Respostas

200

Successful response

application/json

get/v2/api/external/{ApiID}/listTickets

HTTPcURLJavaScriptPython

GET /v2/api/external/{ApiID}/listTickets HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response