CreateInstance#

Este método destina-se a criar uma instância de conta de mensageiro em nome de um parceiro.

Requisição#

Para criar uma instância de conta de mensageiro em nome de um parceiro, você precisa enviar uma solicitação POST para o seguinte URL:

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

O parâmetro de consulta partnerToken é obtido pelo suporte do Green API (suporte@green-api.com.br) mediante solicitação para obter a chave da API do parceiro.

Parâmetros da Requisição#

É permitido fornecer parâmetros seletivamente. Pelo menos um parâmetro deve ser especificado.

Parâmetro	Tipo	Obrigatório	Descrição
`webhookUrl`	string	opcional	URL para enviar notificações de webhook
`webhookUrlToken`	string	opcional	Token para se conectar ao seu servidor de webhook
`delaySendMessagesMilliseconds`	inteiro	opcional	atraso entre o envio de mensagens de saída em milissegundos, o padrão é 3000 ms, o mínimo é 500 ms
`markIncomingMessagesReaded`	string	opcional	marcar mensagens recebidas como lidas ou não ("yes"/"no"), o padrão é "no"
`markIncomingMessagesReadedOnReply`	string	opcional	marcar mensagens recebidas como lidas ou não ("yes"/"no") ao enviar uma mensagem para um chat, o padrão é "no"
`outgoingWebhook`	string	opcional	Receber notificações sobre status de envio/entrega/leitura de mensagens de saída, valores possíveis: “yes”, “no”. O padrão é “no”.
`outgoingMessageWebhook`	string	opcional	Receber notificações sobre mensagens enviadas do telefone, valores possíveis: “yes”, “no”. O padrão é “no”.
`stateWebhook`	string	opcional	Receber notificações sobre alterações no estado de autorização da conta, valores possíveis: “yes”, “no”. O padrão é “no”.
`incomingWebhook`	string	opcional	Receber notificações sobre mensagens e arquivos recebidos, valores possíveis: “yes”, “no”. O padrão é “no”.
`deviceWebhook`	string	opcional	Receber notificações sobre o dispositivo (telefone) e nível de carga da bateria, valores possíveis: “yes”, “no”. O padrão é “no”.
`outgoingAPIMessageWebhook`	string	opcional	Receber notificações sobre mensagens enviadas via API, valores possíveis: “yes”, “no”. O padrão é “no”.
`keepOnlineStatus`	string	opcional	Mostrar o status da instância como "Online". Valores possíveis: “yes”, “no”. O padrão é “no”. Observação: Com essa configuração habilitada, as notificações sonoras para novas mensagens no telefone conectado à API não serão enviadas.

Exemplo de Corpo de Requisição#

{
    "webhookUrl": "https://meusite.com/webhook/green-api/",
    "webhookUrlToken": "f93537eb3e8fed66847b5bd",
    "delaySendMessagesMilliseconds": 1000,
    "markIncomingMessagesReaded": "no",
    "markIncomingMessagesReadedOnReply": "no",
    "outgoingAPIMessageWebhook": "yes",
    "outgoingWebhook": "yes",
    "outgoingMessageWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no",
    "stateWebhook": "no",
    "keepOnlineStatus": "no"
}

Resposta#

Campos da Resposta#

Campo	Tipo	Descrição
`idInstance`	inteiro	ID da instância da conta de mensageiro
`apiTokenInstance`	string	Token da API da instância da conta de mensageiro
`typeInstance`	string	tipo de mensageiro para a instância da conta

Exemplo de Corpo de Resposta#

Em caso de sucesso, a resposta será uma string JSON com a seguinte estrutura e um status HTTP de 200:

{
    "idInstance": 1101728000,
    "apiTokenInstance": "c1b0474542144e0ead529eb4861ca5f583c346eb00564f64a7",
    "typeInstance": "whatsapp"
}

Em caso de falha, a resposta terá um status HTTP de 200 e uma string JSON com um código de erro e descrição:

{
    "code": 401,
    "description": "Unauthorized"
}