Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
sip-token
Generate SIP token
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/sip-token \
  --header 'Client-Token: <api-key>'
{
  "host": "<string>",
  "user": "<string>",
  "token": "<string>",
  "active": true
}

​
Overview

This method generates SIP credentials for the instance, enabling telephony integration via SIP protocol for making and receiving calls.
The call functionality must be enabled and contracted. Generating new credentials replaces any existing SIP token.

​
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
​
active
boolean
SIP activation status
{
  "host": "sip.z-api.io",
  "user": "3C67AB641C8AA0412F6A2242B4E23AC7",
  "token": "BZ9vKoEsmmrCP6y4t0XYCYBW5rMZrQmJAt6KfERWLvk",
  "active": true
}

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