Update a credential connection registration status

POST 
/credential_connections/:id/actions/check_registration_status

Updates the registration_status for a credential connection, this endpoint also updates the registration_status and registration_status_updated_at fields in the credential connection

Request

Path Parameters

id stringrequired

Identifies the resource.

Responses

200: Successful response with details about a credential connection registration status.

application/json

• Schema
• Example (from schema)

Schema

data

object

record_type string

Identifies the type of the resource.

status string

Possible values: [Not Applicable, Not Registered, Failed, Expired, Registered, Unregistered]

The current registration status of your SIP connection

sip_username string

The user name of the SIP connection

ip_address string

The ip used during the SIP connection

transport string

The protocol of the SIP connection

port integer

The port of the SIP connection

user_agent string

The user agent of the SIP connection

last_registration string

ISO 8601 formatted date indicating when the resource was last updated.

{
  "data": {
    "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",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
    }
  }
}

400: Bad request, the request was unacceptable, often due to missing a required parameter.

application/json

• Schema
• Example (from schema)
• missingParameter

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

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

401: Unauthorized

application/json

• Schema
• Example (from schema)
• Authentication Failed

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

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

403: The user doesn't have the required permissions to perform the requested action.

application/json

• Schema
• Example (from schema)
• notAuthorized

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "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": "/"
      }
    }
  ]
}

404: The requested resource doesn't exist.

application/json

• Schema
• Example (from schema)
• notFound

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "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": "/"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L -X POST 'https://api.telnyx.com/v2/credential_connections/:id/actions/check_registration_status' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 400
• 401
• 403
• 404

---

{
  "data": {
    "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",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
    }
  }
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}