🔌 Canais e Sessões

CreateSession

post

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

/v2/api/external/{ApiID}/createtSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

namestringOpcional

statusstringOpcional

typestringOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "name": "My WhatsApp Instance",
  "status": "DISCONNECTED",
  "type": "baileys"
}

200

Successful response

DeleteSession

post

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

/v2/api/external/{ApiID}/deleteSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "whatsappId": 1
}

200

Successful response

ListGroupsInfo

post

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

/v2/api/external/{ApiID}/listGroupInfo

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

listGroupsbooleanOpcional

listParticipantsbooleanOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "listGroups": true,
  "listParticipants": true
}

200

Successful response

RequestNewQrCode

post

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

/v2/api/external/{ApiID}/requestNewQrCodeSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "whatsappId": 1
}

200

Successful response

ShowChannelInformation

post

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

/v2/api/external/{ApiID}/showChannel

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}/showChannel

HTTPcURLJavaScriptPython

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

{
  "number": "5515998566622"
}

200

Successful response

ShowChannelInformationById

post

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

/v2/api/external/{ApiID}/showChannelById

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

idnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "id": 43
}

200

Successful response

ShowQrCode

post

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

/v2/api/external/{ApiID}/qrCodeSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "whatsappId": 1
}

200

Successful response

StartSession

post

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

/v2/api/external/{ApiID}/startSession

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

ApiIDstringObrigatório

Corpo

application/json

whatsappIdnumberOpcional

Respostas

200

Successful response

application/json

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

HTTPcURLJavaScriptPython

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

{
  "whatsappId": 1
}

200

Successful response