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);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.credential_connections.actions.check_registration_status(
    "id",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.CredentialConnections.Actions.CheckRegistrationStatus(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.credentialconnections.actions.ActionCheckRegistrationStatusParams;
import com.telnyx.sdk.models.credentialconnections.actions.ActionCheckRegistrationStatusResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ActionCheckRegistrationStatusResponse response = client.credentialConnections().actions().checkRegistrationStatus("id");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.credential_connections.actions.check_registration_status("id")

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->credentialConnections->actions->checkRegistrationStatus(
    'id'
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx credential-connections:actions check-registration-status \
  --api-key 'My API Key' \
  --id id

curl --request POST \
  --url https://api.telnyx.com/v2/credential_connections/{id}/actions/check_registration_status \
  --header 'Authorization: Bearer <token>'

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"
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The request failed because it was not well-formed.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10010",
      "title": "Not authorized",
      "detail": "You are not authorized to access the requested resource.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

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"
}