Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
sip-info
Get SIP information
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
}

​
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

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

​
Response

​
200

​
host
string
SIP server address
​
user
string
SIP user identifier
​
token
string
SIP authentication token (partially masked)
​
active
boolean
SIP activation status
With configured token: 
{
  "host": "sip.z-api.io",
  "user": "3C67AB641C8AA0412F6A2242B4E23AC7",
  "token": "BZ9***",
  "active": true
}
Without configured token: 
{
  "host": "sip.z-api.io",
  "user": "3C67AB641C8AA0412F6A2242B4E23AC7",
  "active": false
}

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