Skip to main content
GET
Check username-and-password trunks are available
Whether this workspace can create username-and-password trunks right now. Requires sip_endpoints:read.
true means both of these hold:
  • username-and-password trunks are switched on for your workspace;
  • Yappr’s voice servers answer calls on them.
While it is false:
  • Creating a trunk is refused and nothing is created. The answer says why: 403 SIP_TRUNKS_NOT_ENABLED when trunks aren’t switched on for your workspace (ask Yappr support to switch them on), or 409 VOICE_NOT_READY while Yappr can’t take trunk calls, for example during an update (try again in a few minutes).
  • The dashboard offers SIP address endpoints only.
  • SIP address endpoints can still be created.
  • Existing endpoints can still be listed, changed and deleted, and a trunk can still get a new password with rotate-password.
Yappr checks its voice servers at most once a minute, so after an update the answer can take up to a minute to change.

Errors

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Response

Whether username-and-password trunks can be created

credentials_available
boolean
required
Example:

true