Skip to main content
GET
Get SIP information

Overview

Method used to query the instance’s SIP information.
The call functionality must be enabled and contracted. Execute this endpoint from the backend to protect sensitive credentials.

Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Response

200

string
SIP server address
string
SIP user identifier
string
SIP authentication token (partially masked)
boolean
SIP activation status
With configured token:
Without configured token:

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.