🎫 Tickets

AddTag

post

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

/v2/api/external/{ApiID}/addTag

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

tagIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/addTag

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/addTag HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "ticketId": 4,
  "tagId": 1
}

200

Successful response

CreateNotes

post

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

/v2/api/external/{ApiID}/createNotes

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

notesstringOpcional

ticketIdnumberOpcional

userIdnumberOpcional

idFrontstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/createNotes

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/createNotes HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "notes": "Mensagem da nota",
  "ticketId": 1262,
  "userId": 1,
  "idFront": "ID_UNICA_DO_SISTEMA_CLIENTE_PARA_EXECUTAR_UMA_ACAO_COM_WEBHOOK"
}

200

Successful response

CreateTicketWebmail

post

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

/v2/api/external/{ApiID}/createTicket

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

bodystringOpcional

emailstringOpcional

channelIdnumberOpcional

externalKeystringOpcional

userIdnumberOpcional

statusstringOpcional

namestringOpcional

firstNamestringOpcional

lastNamestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/createTicket

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/createTicket HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "body": "Mensagem inicial do ticket por email",
  "email": "[e-mail]",
  "channelId": 17841443941506796,
  "externalKey": "{{SecretKey}}",
  "userId": 3,
  "status": "pending",
  "name": "Nome do Contato",
  "firstName": "Nome",
  "lastName": "Sobrenome"
}

200

Successful response

ListNotes

get

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

/v2/api/external/{ApiID}/listNotes

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Parâmetros de consulta

ticketIdintegerOpcional

ID do ticket

Example: 1262

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

200

Successful response

RemoveTag

post

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

/v2/api/external/{ApiID}/removeTag

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

tagIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/removeTag

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/removeTag HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "ticketId": 4,
  "tagId": 1
}

200

Successful response

SendPresence

post

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

/v2/api/external/{ApiID}/sendPresence

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

statestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/sendPresence

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/sendPresence HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "ticketId": 1262,
  "state": "typing"
}

200

Successful response

SetQueue

post

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

/v2/api/external/{ApiID}/updatequeue

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

queueIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updatequeue

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updatequeue HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "ticketId": 4,
  "queueId": 1
}

200

Successful response

SetTag

post

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

/v2/api/external/{ApiID}/updatetag

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

tagnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updatetag

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updatetag HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "ticketId": 4,
  "tag": 1
}

200

Successful response

SetTicketInfo

post

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

/v2/api/external/{ApiID}/updateticketinfo

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

userIdnumberOpcional

statusstringOpcional

queueIdstring · anulávelOpcional

typebotStatusbooleanOpcional

chatgptStatusbooleanOpcional

dialogflowStatusbooleanOpcional

difyStatusbooleanOpcional

n8nStatusbooleanOpcional

chatFlowIdstring · anulávelOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateticketinfo

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateticketinfo HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "ticketId": 1262,
  "userId": 1,
  "status": "pending",
  "queueId": null,
  "typebotStatus": false,
  "chatgptStatus": false,
  "dialogflowStatus": false,
  "difyStatus": false,
  "n8nStatus": false,
  "chatFlowId": null
}

200

Successful response

ShowAllMessages

post

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

/v2/api/external/{ApiID}/showAllMessages

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/showAllMessages

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/showAllMessages HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ticket": "123"
}

200

Successful response

ShowAllTicketInformation

post

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

/v2/api/external/{ApiID}/showallticket

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/showallticket

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/showallticket HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "number": "5515998566622"
}

200

Successful response

ShowTicketInformation

post

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

/v2/api/external/{ApiID}/showticket

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/showticket

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/showticket HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "number": "5515998566622"
}

200

Successful response

ShowTicketInformationChatBot

post

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

/v2/api/external/{ApiID}/showticketchatbot

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

numberstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/showticketchatbot

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/showticketchatbot HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "number": "5515998566622"
}

200

Successful response

UpdateNote

post

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

/v2/api/external/{ApiID}/updateNote

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

noteIdnumberOpcional

notesstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateNote

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateNote HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "noteId": 1,
  "notes": "Conteúdo atualizado da nota"
}

200

Successful response

UpdateTicketChannel

post

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

/v2/api/external/{ApiID}/updateTicketChannel

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

ticketIdnumberOpcional

whatsappIdnumberOpcional

channelstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{ApiID}/updateTicketChannel

HTTPcURLJavaScriptPython

POST /v2/api/external/{ApiID}/updateTicketChannel HTTP/1.1
Host: {{baseurl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "ticketId": 1262,
  "whatsappId": 1,
  "channel": "whatsapp"
}

200

Successful response