Skip to main content
POST
Digest auth-hook for customer BYO-PBX SIP trunks

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
method
string

SIP method being authenticated (INVITE or REGISTER).

realm
string

SIP realm from the digest challenge.

username
string

Digest username claim (chosen by the customer PBX).

uri
string

SIP URI from the Authorization header.

nonce
string

Challenge nonce.

response
string

Digest response computed by the PBX.

source_ip
string

Source IP of the PBX, as observed by jambonz.

Response

200 - application/json

Authentication verdict. On success returns status: ok with the trunk's digest password for jambonz to verify the claim (plus an optional lifted expires floor for REGISTER); an unknown or misconfigured trunk returns status: fail with a message.

status
string

ok when the trunk is accepted, fail otherwise.

password
string

The trunk's decrypted digest password (present on success).

message
string

Human-readable reason on failure.