Skip to main content
GET
Obter informações SIP

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

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

Response

200

string
Endereço do servidor SIP
string
Identificador do usuário SIP
string
Token de autenticação SIP (parcialmente mascarado)
boolean
Status de ativação SIP
Com token configurado:
Sem token configurado:

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”.