GetInstances#

Este método destina-se a obter todas as instâncias de contas criadas por um parceiro.

Requisição#

Para obter todas as instâncias de conta, é necessário fazer uma solicitação GET para o seguinte URL:

https://api.green-api.com/partner/getInstances/{partnerToken}

A obtenção do parâmetro de solicitação partnerToken é feita através do suporte da Green API (suporte@green-api.com.br) com uma solicitação para obter a chave de API do parceiro.

Resposta#

Campos da resposta#

Campo	Tipo	Descrição
`idInstance`	int	identificador da instância da conta
`apiTokenInstance`	string	token da API da instância da conta
`typeInstance`	string	tipo de mensageiro para a instância da conta
`timeCreated`	string	hora de criação da instância

Exemplo de corpo de resposta#

Em caso de sucesso, em resposta à solicitação, é fornecida uma string JSON no seguinte formato com o status HTTP 200:

[
    {
        "idInstance": 1101728004,
        "name": "Instance 1101728004",
        "typeInstance": "whatsapp",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-03T18:39:44",
        "timeDeleted": "0001-01-01T00:00:00",
        "apiTokenInstance": "1f2485e80f474293b935f77d78c64e76fa4bdceb417a4998a4",
        "deleted": false,
        "tariff": "PARTNER_23",
        "expirationDate": "2022-06-09T18:39:44",
        "isExpired": false
    },
    {
        "idInstance": 1101728204,
        "name": "Instance 1101728204",
        "typeInstance": "whatsapp",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-07T10:36:48",
        "timeDeleted": "2022-06-07T10:37:00",
        "apiTokenInstance": "35d8b4907f8e494289b1d5f999e3582940ceffc413bf4a76b1",
        "deleted": true,
        "tariff": "PARTNER_23",
        "expirationDate": "2022-06-08T10:36:48",
        "isExpired": false
    },
    {
        "idInstance": 1101728478,
        "name": "Instance 1101728478",
        "typeInstance": "whatsapp",
        "typeAccount": "",
        "partnerUserUiid": "",
        "timeCreated": "2022-06-08T09:12:13",
        "timeDeleted": "2022-06-08T09:19:04",
        "apiTokenInstance": "c8b0474542154e0ead529eb3861ca5f483c346eb00564f64a7",
        "deleted": true,
        "tariff": "PARTNER_23",
        "expirationDate": "2022-06-09T09:12:13",
        "isExpired": false
    }
]

Para obter os parâmetros das instâncias das contas, são utilizados os métodos API correspondentes.

Em caso de falha, é retornado uma resposta com o status HTTP 400 e o texto do erro.