Skip to main content
POST
SIP REGISTER digest auth-hook for softphone credentials

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
username
string

Digest username from the REGISTER Authorization header.

realm
string

Realm jambonz used to compute the digest; must match the configured SIP realm or the SIP-edge host.

algorithm
string

Digest algorithm jambonz challenged with (MD5 or SHA-256).

source_ip
string

Source IP of the registering endpoint.

user_agent
string

User-Agent header of the registering endpoint.

Response

200 - application/json

Authentication verdict. On success returns status: ok with the A1 digest hash (or the trunk password) jambonz uses to verify the challenge; a rejected credential returns HTTP 401 with status: fail and a machine-readable reason.

status
string

ok when the credential is accepted, fail otherwise.

a1_hash
string

Digest A1 hash for the challenged algorithm (present for softphone credentials).