About

SIP trunk registration status can be retrieved using either an account-level or property-level request.

Resource URI

You can retrieve the registration status of a SIP trunk using one of the following URIs:

GET
/v2/Accounts/{AccountSid}/SipTrunk/{SipTrunkSid}/RegistrationStatus
or
/v2/Properties/{PropertySid}/SipTrunk/{SipTrunkSid}/RegistrationStatus

Request

URI Parameters

Parameter Type Description
AccountSid string Account secure identification to retrieve SIP trunk's registration status.
PropertySid string Property secure identification to retrieve SIP trunk's registration status.
SipTrunkSid string The secure identifier of the SIP trunk.

Response

200 – OK

Our service will respond with JSON formatted data containing the registration status of the specified SIP trunk.

Response Parameters

Parameter Type Description
ExternalReference string External reference associated with the SIP trunk.
RegistrationActive boolean Indicates whether the SIP trunk is currently registered.
DigestUser string Digest user used by the SIP trunk.
DigestRealm string Digest realm used by the SIP trunk.
Expires
(Unix timestamp) 		unsigned integer Expiration time of the current registration.
LastReg
(Unix timestamp) 		unsigned integer Timestamp of the last successful registration.
UserAgent string User agent used by the SIP trunk.
IpClient string Client IP address used by the SIP trunk.
IpServer string Server IP address used by the SIP trunk.

Example: An example response.

{
  "ExternalReference": "56789",
  "RegistrationActive": true,
  "DigestUser": "user",
  "DigestRealm": "realm",
  "Expires": 1700003600,
  "LastReg": 1700000000,
  "UserAgent": "agent",
  "IpClient": "1.2.3.4",
  "IpServer": "5.6.7.8"
}

400 – Error

For error codes and messages, please refer to the REST API Error Codes page.