Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3357,7 +3357,7 @@ components:

| verstat | (optional) The verification status indicating whether
the verification was successful or not. Possible values are
`TN-Verification-Passed` or `TN-Verification-Failed`. |
`TN-Validation-Passed` or `TN-Validation-Failed`. |

| attestationIndicator | (optional) The attestation level verified
by Bandwidth. Possible values are `A` (full), `B` (partial) or `C`
Expand All @@ -3375,7 +3375,7 @@ components:
additionalProperties:
type: string
example:
verstat: TN-Verification-Passed
verstat: TN-Validation-Passed
attestationIndicator: A
originatingId: abc123
identity:
Expand Down Expand Up @@ -5211,8 +5211,8 @@ components:
description: >-
(optional) The verification status indicating whether the
verification was successful or not. Possible values are
TN-Verification-Passed and TN-Verification-Failed.
example: Tn-Verification-Passed
TN-Validation-Passed and TN-Validation-Failed.
example: Tn-Validation-Passed
attestationIndicator:
type: string
description: >-
Expand Down
2 changes: 1 addition & 1 deletion docs/CallState.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
**from** | **string** | The phone number that made the call, in E.164 format (e.g. +15555555555). | [optional] [default to undefined]
**direction** | [**CallDirectionEnum**](CallDirectionEnum.md) | | [optional] [default to undefined]
**state** | **string** | The current state of the call. Current possible values are `queued`, `initiated`, `answered` and `disconnected`. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] [default to undefined]
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] [default to undefined]
**stirShaken** | **{ [key: string]: string; }** | For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken). | [optional] [default to undefined]
**identity** | **string** | The value of the `Identity` header from the inbound invite request. Only present for inbound calls and if the account is configured to forward this header. | [optional] [default to undefined]
**enqueuedTime** | **string** | The time this call was placed in queue. | [optional] [default to undefined]
**startTime** | **string** | The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. | [optional] [default to undefined]
Expand Down
2 changes: 1 addition & 1 deletion docs/StirShaken.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed. | [optional] [default to undefined]
**verstat** | **string** | (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed. | [optional] [default to undefined]
**attestationIndicator** | **string** | (optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway). | [optional] [default to undefined]
**originatingId** | **string** | (optional) A unique origination identifier. | [optional] [default to undefined]

Expand Down
2 changes: 1 addition & 1 deletion models/call-state.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export interface CallState {
*/
'state'?: string;
/**
* For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Verification-Passed` or `TN-Verification-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
* For inbound calls, the Bandwidth STIR/SHAKEN implementation will verify the information provided in the inbound invite request `Identity` header. The verification status is stored in the call state `stirShaken` property as follows. | Property | Description | |:------------------|:------------| | verstat | (optional) The verification status indicating whether the verification was successful or not. Possible values are `TN-Validation-Passed` or `TN-Validation-Failed`. | | attestationIndicator | (optional) The attestation level verified by Bandwidth. Possible values are `A` (full), `B` (partial) or `C` (gateway). | | originatingId | (optional) A unique origination identifier. | Note that these are common properties but that the `stirShaken` object is free form and can contain other key-value pairs. More information: [Understanding STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
* @type {{ [key: string]: string; }}
* @memberof CallState
*/
Expand Down
2 changes: 1 addition & 1 deletion models/stir-shaken.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*/
export interface StirShaken {
/**
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Verification-Passed and TN-Verification-Failed.
* (optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.
* @type {string}
* @memberof StirShaken
*/
Expand Down