Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
sip-info
Obter informações SIP
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/sip-info \
  --header 'Client-Token: <api-key>'
{
  "host": "<string>",
  "user": "<string>",
  "token": "<string>",
  "active": true
}

​
Conceituação

Método utilizado para consultar as informações SIP da instância.
A funcionalidade de chamadas precisa estar habilitada e contratada. Execute este endpoint a partir do backend para proteger credenciais sensíveis.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Response

​
200

​
host
string
Endereço do servidor SIP
​
user
string
Identificador do usuário SIP
​
token
string
Token de autenticação SIP (parcialmente mascarado)
​
active
boolean
Status de ativação SIP
Com token configurado: 
{
  "host": "sip.z-api.io",
  "user": "3C67AB641C8AA0412F6A2242B4E23AC7",
  "token": "BZ9***",
  "active": true
}
Sem token configurado: 
{
  "host": "sip.z-api.io",
  "user": "3C67AB641C8AA0412F6A2242B4E23AC7",
  "active": false
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.