Skip to main content

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.

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.

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

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

401: Unauthorized

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

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

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

404: The requested resource doesn't exist.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

Loading...