Referência da APIInstancias
Detalhe de uma instancia
Retorna o detalhe de uma instancia especifica do Projeto da API key. Use para consultar o status atual (notadamente confirmar status==CONNECTED antes de enviar mensagens) e, quando ja pareada, o numero (phoneNumber) e o JID. So enxerga instancias do mesmo Projeto e do mesmo modo (teste ou producao) da key; caso contrario responde 404 (nao distingue inexistente de pertencente a outro tenant/modo, por isolamento).
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador da instancia.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/instances/cm5x8a9k20001abc123def456"{
"id": "string",
"projectId": "string",
"name": "string",
"status": "DISCONNECTED",
"phoneNumber": "string",
"jid": "string",
"settings": {
"rejectCalls": false,
"rejectCallMessage": "string",
"ignoreGroups": false,
"alwaysOnline": false,
"readReceipts": false,
"importHistory": false
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}