Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
me
Dados da instância
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/me \
  --header 'Client-Token: <api-key>'
{
  "id": "abc1234567890",
  "name": "Minha Instância",
  "connected": true,
  "phone": "5511999999999",
  "receivedCallbackUrl": "https://example.com/webhooks/received",
  "deliveryCallbackUrl": "https://example.com/webhooks/delivery",
  "disconnectedCallbackUrl": "https://example.com/webhooks/disconnected",
  "connectedCallbackUrl": "https://example.com/webhooks/connected",
  "messageStatusCallbackUrl": "https://example.com/webhooks/status",
  "presenceChatCallbackUrl": "https://example.com/webhooks/presence",
  "receiveCallbackSentByMe": false,
  "callRejectAuto": false,
  "callRejectMessage": "",
  "autoReadMessage": false,
  "autoReadStatus": false,
  "disableQueueWhenDisconnected": false
}
Retorna metadados da instância, webhooks configurados e ajustes operacionais.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Response

Resposta de sucesso.

​
id
string
required
Example:

"abc1234567890"

​
name
string
required
Example:

"Minha Instância"

​
connected
boolean
required
Example:

true

​
phone
string
required
Example:

"5511999999999"

​
receivedCallbackUrl
string
required
Example:

"https://example.com/webhooks/received"

​
deliveryCallbackUrl
string
required
Example:

"https://example.com/webhooks/delivery"

​
disconnectedCallbackUrl
string
required
Example:

"https://example.com/webhooks/disconnected"

​
connectedCallbackUrl
string
required
Example:

"https://example.com/webhooks/connected"

​
messageStatusCallbackUrl
string
required
Example:

"https://example.com/webhooks/status"

​
presenceChatCallbackUrl
string
required
Example:

"https://example.com/webhooks/presence"

​
receiveCallbackSentByMe
boolean
required
Example:

false

​
callRejectAuto
boolean
required
Example:

false

​
callRejectMessage
string
required
Example:

""

​
autoReadMessage
boolean
required
Example:

false

​
autoReadStatus
boolean
required
Example:

false

​
disableQueueWhenDisconnected
boolean
required
Example:

false