Check a Credential Connection Registration Status

Checks the registration_status for a credential connection, (registration_status) as well as the timestamp for the last SIP registration event (registration_status_updated_at)

POST /credential_connections/{id}/actions/check_registration_status

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.credentialConnections.actions.checkRegistrationStatus('id');

console.log(response.data);

200

{
  "data": {
    "record_type": "registration_status",
    "status": "Expired",
    "sip_username": "rogerp",
    "ip_address": "190.106.106.121",
    "transport": "UDP",
    "port": 37223,
    "user_agent": "Z 5.4.12 v2.10.13.2-mod",
    "last_registration": "2021-09-28T15:11:02"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Identifies the resource.

Response

200

application/json

Successful response with details about a credential connection registration status.

data · Registration Status · object

Show child attributes

Example:

{
  "record_type": "registration_status",
  "status": "Expired",
  "sip_username": "rogerp",
  "ip_address": "190.106.106.121",
  "transport": "UDP",
  "port": 37223,
  "user_agent": "Z 5.4.12 v2.10.13.2-mod",
  "last_registration": "2021-09-28T15:11:02"
}