Update STIR/SHAKEN Settings

Update the STIR/SHAKEN settings.

Request URL

PUT {base_url}/uc-cconfig/api/v1/stirshaken/setting

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Body parameters
Parameter Required Type Description
certificate No Object<Certificate_Input> The signature certificate and private key to upload.
verificationSettings Yes Object<Verification_Input> The verification configuration to update.
Certificate_Input
Parameter Required Type Description
certPem Yes String The PEM-encoded signature certificate.
keyPem Yes String The PEM-encoded private key.
certName No String The filename of the signature certificate for display on NovoOne portal.
keyName No String The filename of the private key, for display on NovoOne portal.
Verification_Input
Parameter Required Type Description
signatureValidTime Yes Integer The valid period of the signature (unit: seconds).
Note: An integer from 1 to 300 is allowed.
certificateDownloadTimeout Yes Integer The maximum wait time for downloading the SHAKEN certificate (unit: seconds).
Note: An integer from 1 to 30 is allowed.
dropCallsWithVerificationStatus No Object<Verification_Status> The list of verification statuses on which the incoming call is rejected.
Verification_Status
Parameter Required Type Description
items No Array<String> The list of verification statuses on which the incoming call is rejected.
Note: An empty array clears the existing setting.

Valid value:

  • VERIFICATION_STATUS_UNSPECIFIED: The verification status is unspecified.
  • VERIFICATION_STATUS_UNSIGNED: The call is unsigned.
  • VERIFICATION_STATUS_INVALID: The call signature is invalid.
  • VERIFICATION_STATUS_ATTESTATION_C: The call carries an attestation of level C.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Stir_Shaken_Settings> The updated STIR/SHAKEN settings.
Stir_Shaken_Settings
Parameter Type Description
certificate Object<Certificate_Info> The signature certificate information for outbound call signaling.
Note: A value of null indicates that no certificate is uploaded.
verificationSettings Object<Verification_Settings> The configuration for inbound call verification.
Certificate_Info
Parameter Type Description
signatureValidTime Integer The valid period of the signature (unit: seconds).
certificateDownloadTimeout Integer The maximum wait time for downloading the SHAKEN certificate (unit: seconds).
dropCallsWithVerificationStatus Array<String> The list of verification statuses on which the incoming call is rejected.
  • VERIFICATION_STATUS_UNSPECIFIED: The verification status is unspecified.
  • VERIFICATION_STATUS_UNSIGNED: The call is unsigned.
  • VERIFICATION_STATUS_INVALID: The call signature is invalid.
  • VERIFICATION_STATUS_ATTESTATION_C: The call carries an attestation of level C.
Verification_Settings
Parameter Type Description
certName String The filename of the signature certificate.
keyName String The filename of the private key.
status String The certificate status.
  • VALID: The certificate is valid.
  • EXPIRED: The certificate has expired.
  • EXPIRING_SOON: The certificate will expire soon.
issuedTo String The entity to which the certificate is issued.
issuedBy String The certificate authority that issued the certificate.
issuedOn String The date when the certificate was issued.
expiresOn String The date when the certificate expires.

Example

Request example

PUT /uc-cconfig/api/v1/stirshaken/setting HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4ODc4Njc2MCwiaWF0IjoxNzg4NzY1MTYwLCJqdGkiOiJkZDZmMGEzYS05NTg0LTRhOGQtYTZmYi0wOGQ2ZTE0ODdmZmUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.1deRKiIDcYLXRg5CpWqCVFMN9a-YJT1sC3PcAHGCREP-Irc7vYOYkZT_OuV8KE2bQNRBb8P4krbM2bqXGMeen-X6cXFAVYRhcwHRgWJhZF3Xn8-uiHpESVhOAEPhEgoGS4rDmL-dzGomPQenp2C0D8l3Bwiw2cqRkHu8Y4ZxUtx7oOYvxyP84AhWPyLNX0Ge-C65ob18Lp3_m7_Z8j2EG0xnNbzk_C3IM-PozoDZJd_pccbfLI0bNWt_l5BUryRaAtz4MKHtHyPKjBH9EXxnLXwyZOC5PJ__bHTTh91MXsuiLUUHDbeTsTLQrYgPX2OGMnVwUPN8jho6YwL90rpW7g
Content-Type: application/json
{
  "verificationSettings": {
    "signatureValidTime": 15,
    "certificateDownloadTimeout": 2,
    "dropCallsWithVerificationStatus": {
      "items": [
        "VERIFICATION_STATUS_UNSIGNED"
      ]
    }
  }
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "32f1e8df02a9d08666beaa341590fb09",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "certificate": null,
    "verificationSettings": {
      "signatureValidTime": 15,
      "certificateDownloadTimeout": 2,
      "dropCallsWithVerificationStatus": [
        "VERIFICATION_STATUS_UNSIGNED"
      ]
    }
  }
}