diff --git a/api/openapi.yaml b/api/openapi.yaml index 85cfd74d..8ded836d 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -4004,7 +4004,7 @@ paths: description: |- Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). - Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. operationId: deleteRealTimeTranscription parameters: - description: Your Bandwidth Account ID. @@ -4035,7 +4035,7 @@ paths: type: string style: simple responses: - "204": + "200": description: Transcription data was deleted. "400": content: @@ -4687,6 +4687,7 @@ components: answerMethod: POST answerUrl: https://myServer.example/bandwidth/webhooks/answer answerFallbackMethod: POST + answerFallbackUrl: https://myServer.example/bandwidth/webhooks/answerFallback disconnectMethod: POST disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect username: mySecretUsername @@ -6875,14 +6876,20 @@ components: from: description: |- A Bandwidth phone number on your account the call should come - from (must be in E.164 format, like `+15555551212`, or be one of the following - strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). - example: "+19195554321" + from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. + example: "+15555551212" type: string + privacy: + description: Hide the calling number. The `displayName` field can be used + to customize the displayed name. + example: false + nullable: true + type: boolean displayName: description: "The caller display name to use when the call is created. \n\ May not exceed 256 characters nor contain control characters such as new\ - \ lines." + \ lines.\nIf `privacy` is true, only the following values are valid: `Restricted`,\ + \ `Anonymous`, `Private`, or `Unavailable`." example: John Doe maxLength: 256 nullable: true @@ -7172,7 +7179,7 @@ components: verstat: TN-Verification-Passed attestationIndicator: A originatingId: abc123 - from: "19195554321" + from: "+19195554321" startTime: 2022-06-16T13:15:07.16Z to: "+19195551234" state: disconnected @@ -7207,7 +7214,7 @@ components: from: description: "The phone number that made the call, in E.164 format (e.g.\ \ +15555555555)." - example: "19195554321" + example: "+19195554321" type: string direction: $ref: '#/components/schemas/callDirectionEnum' @@ -7415,9 +7422,9 @@ components: status: completed parentCallId: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d transferCallerId: "+15555555555" - transferTo: +15555555555) + transferTo: "+15555555555" duration: PT13.67S - accountId: "920012" + accountId: "9900000" channels: 1 from: "+15555555555" startTime: 2022-06-17T22:19:40.375Z @@ -7435,7 +7442,7 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string callId: description: The call id associated with the event. @@ -7457,21 +7464,19 @@ components: example: "+15555555555" type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string duration: description: The duration of the recording in ISO-8601 format @@ -7722,7 +7727,7 @@ components: conferenceRecordingMetadata: example: duration: PT13.67S - accountId: "920012" + accountId: "9900000" channels: 1 mediaUrl: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media conferenceId: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9 @@ -7735,7 +7740,7 @@ components: properties: accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string conferenceId: description: "The unique, Bandwidth-generated ID of the conference that\ @@ -7790,8 +7795,11 @@ components: type: string type: object machineDetectionConfiguration: - description: The machine detection request used to perform machine - detection on the call. + description: "The machine detection request used to perform machine\ + \ detection on the call. Currently, there is an issue where decimal values\ + \ are not getting processed correctly. Please use whole number values. We\ + \ are working to resolve this issue. Please contact Bandwidth Support if you\ + \ need more information." properties: mode: $ref: '#/components/schemas/machineDetectionModeEnum' @@ -8035,7 +8043,7 @@ components: - outbound example: inbound type: string - text: + transcript: description: The transcription itself. example: Hello World! This is an example. type: string @@ -8116,16 +8124,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8195,16 +8202,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8289,16 +8295,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8459,9 +8464,8 @@ components: example: my-conference-name type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8515,9 +8519,8 @@ components: example: my-conference-name type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8604,7 +8607,7 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string recordingId: description: The unique ID of this recording @@ -8676,16 +8679,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8773,16 +8775,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8830,14 +8831,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string tag: description: "(optional) The tag specified on call creation. If no tag was\ @@ -8868,16 +8868,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -8932,14 +8931,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string tag: description: "(optional) The tag specified on call creation. If no tag was\ @@ -8972,16 +8970,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9033,16 +9030,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9111,16 +9107,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9198,14 +9193,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string type: object recordingAvailableCallback: @@ -9230,16 +9224,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9320,14 +9313,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string type: object redirectCallback: @@ -9352,16 +9344,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9411,14 +9402,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string type: object transcriptionAvailableCallback: @@ -9443,16 +9433,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9520,14 +9509,13 @@ components: $ref: '#/components/schemas/transcription' transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string type: object transferAnswerCallback: @@ -9557,16 +9545,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9610,14 +9597,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string type: object transferCompleteCallback: @@ -9645,16 +9631,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9698,14 +9683,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string cause: description: "Reason the call failed - hangup, busy, timeout, cancel, rejected,\ @@ -9752,16 +9736,15 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. example: 04e88489-df02-4e34-a0ee-27a91849555f type: string from: - description: "The provided identifier of the caller: can be a phone number\ - \ in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number + in E.164 format (e.g. +15555555555). example: "+15555555555" type: string to: @@ -9816,14 +9799,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call,\ - \ in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous,\ - \ Private, or Unavailable." + \ in E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in\ \ E.164 format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string cause: description: "Reason the call failed - hangup, busy, timeout, cancel, rejected,\ @@ -9862,7 +9844,7 @@ components: type: string accountId: description: The user account associated with the call. - example: "920012" + example: "9900000" type: string applicationId: description: The id of the application associated with the call. @@ -9874,9 +9856,8 @@ components: example: "+15555555555" type: string from: - description: "The provided identifier of the caller: can be a phone number in\ - \ E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable,\ - \ or Anonymous." + description: The provided identifier of the caller. Must be a phone number in + E.164 format (e.g. +15555555555). example: "+15555555555" type: string conferenceId: @@ -9951,14 +9932,13 @@ components: type: string transferCallerId: description: "The phone number used as the from field of the B-leg call, in\ - \ E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private,\ - \ or Unavailable." + \ E.164 format (e.g. +15555555555)." example: "+15555555555" type: string transferTo: description: "The phone number used as the to field of the B-leg call, in E.164\ \ format (e.g. +15555555555)." - example: +15555555555) + example: "+15555555555" type: string mediaUrl: description: The URL that can be used to download the recording. Only present @@ -10151,11 +10131,11 @@ components: type: object messagingCodeResponse: example: - messageId: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 + messageId: 1589228074636lm4k2je7j7jklbn2 properties: messageId: description: Messaging API Message ID. - example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 + example: 1589228074636lm4k2je7j7jklbn2 type: string type: object verifyCodeRequest: diff --git a/bandwidth.yml b/bandwidth.yml index c2e932a8..96bfc9da 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -1173,7 +1173,7 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). - Note: After the deletion is requested and a `204` is returned, the + Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. @@ -1183,7 +1183,7 @@ paths: - $ref: '#/components/parameters/callId' - $ref: '#/components/parameters/transcriptionId' responses: - '204': + '200': $ref: '#/components/responses/deleteCallTranscriptionResponse' '400': $ref: '#/components/responses/voiceBadRequestError' @@ -2152,11 +2152,16 @@ components: description: >- A Bandwidth phone number on your account the call should come - from (must be in E.164 format, like `+15555551212`, or be one of the - following - - strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). - example: '+19195554321' + from (must be in E.164 format, like `+15555551212`) even if + `privacy` is set to true. + example: '+15555551212' + privacy: + nullable: true + type: boolean + description: >- + Hide the calling number. The `displayName` field can be used to + customize the displayed name. + example: false displayName: nullable: true type: string @@ -2165,6 +2170,9 @@ components: May not exceed 256 characters nor contain control characters such as new lines. + + If `privacy` is true, only the following values are valid: + `Restricted`, `Anonymous`, `Private`, or `Unavailable`. maxLength: 256 example: John Doe uui: @@ -2488,7 +2496,7 @@ components: description: >- The phone number that made the call, in E.164 format (e.g. +15555555555). - example: '19195554321' + example: '+19195554321' direction: $ref: '#/components/schemas/callDirectionEnum' state: @@ -3023,7 +3031,10 @@ components: description: >- The machine detection request used to perform machine detection on the - call. + call. Currently, there is an issue where decimal values are not getting + processed correctly. Please use whole number values. We are working to + resolve this issue. Please contact Bandwidth Support if you need more + information. properties: mode: $ref: '#/components/schemas/machineDetectionModeEnum' @@ -3290,7 +3301,7 @@ components: - outbound description: Which `track` this transcription is derived from. example: inbound - text: + transcript: type: string description: The transcription itself. example: Hello World! This is an example. @@ -4128,7 +4139,7 @@ components: accountId: type: string description: The user account associated with the call. - example: '920012' + example: '9900000' applicationId: type: string description: The id of the application associated with the call. @@ -4142,9 +4153,8 @@ components: from: type: string description: >- - The provided identifier of the caller: can be a phone number in E.164 - format (e.g. +15555555555) or one of Private, Restricted, Unavailable, - or Anonymous. + The provided identifier of the caller. Must be a phone number in E.164 + format (e.g. +15555555555). example: '+15555555555' conferenceId: type: string @@ -4223,15 +4233,14 @@ components: type: string description: >- The phone number used as the from field of the B-leg call, in E.164 - format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or - Unavailable. + format (e.g. +15555555555). example: '+15555555555' transferTo: type: string description: >- The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - example: +15555555555) + example: '+15555555555' mediaUrl: nullable: true type: string @@ -4442,7 +4451,7 @@ components: messageId: type: string description: Messaging API Message ID. - example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 + example: 1589228074636lm4k2je7j7jklbn2 verifyCodeRequest: type: object properties: @@ -5778,6 +5787,7 @@ components: answerMethod: POST answerUrl: https://myServer.example/bandwidth/webhooks/answer answerFallbackMethod: POST + answerFallbackUrl: https://myServer.example/bandwidth/webhooks/answerFallback disconnectMethod: POST disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect username: mySecretUsername diff --git a/docs/AnswerCallback.md b/docs/AnswerCallback.md index 41155d7a..c162a641 100644 --- a/docs/AnswerCallback.md +++ b/docs/AnswerCallback.md @@ -12,7 +12,7 @@ The Answer event is sent to the answerUrl specified in the createCall request wh |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | diff --git a/docs/BridgeCompleteCallback.md b/docs/BridgeCompleteCallback.md index d0267f32..1a72f0f0 100644 --- a/docs/BridgeCompleteCallback.md +++ b/docs/BridgeCompleteCallback.md @@ -12,7 +12,7 @@ If the target call leaves the , then this callback is sent to the bridge |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | diff --git a/docs/BridgeTargetCompleteCallback.md b/docs/BridgeTargetCompleteCallback.md index ffd524af..3daa0f55 100644 --- a/docs/BridgeTargetCompleteCallback.md +++ b/docs/BridgeTargetCompleteCallback.md @@ -12,7 +12,7 @@ If the originating call leaves the , then this callback is sent to the b |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | diff --git a/docs/CallRecordingMetadata.md b/docs/CallRecordingMetadata.md index eab93928..dc35c4ee 100644 --- a/docs/CallRecordingMetadata.md +++ b/docs/CallRecordingMetadata.md @@ -13,8 +13,8 @@ |**parentCallId** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] | |**recordingId** | **String** | The unique ID of this recording | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**duration** | **String** | The duration of the recording in ISO-8601 format | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | diff --git a/docs/CallTranscription.md b/docs/CallTranscription.md index 966ff1b8..1ac3f77d 100644 --- a/docs/CallTranscription.md +++ b/docs/CallTranscription.md @@ -9,7 +9,7 @@ |------------ | ------------- | ------------- | -------------| |**detectedLanguage** | [**DetectedLanguageEnum**](#DetectedLanguageEnum) | The detected language for this transcription. | [optional] | |**track** | [**TrackEnum**](#TrackEnum) | Which `track` this transcription is derived from. | [optional] | -|**text** | **String** | The transcription itself. | [optional] | +|**transcript** | **String** | The transcription itself. | [optional] | |**confidence** | **Double** | How confident the transcription engine was in transcribing the associated audio (from `0` to `1`). | [optional] | diff --git a/docs/ConferenceMemberExitCallback.md b/docs/ConferenceMemberExitCallback.md index 1ae4cf2a..1a912f28 100644 --- a/docs/ConferenceMemberExitCallback.md +++ b/docs/ConferenceMemberExitCallback.md @@ -12,7 +12,7 @@ The Conference Member Exit event is fired whenever a caller exits a conference t |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] | |**name** | **String** | The user-specified name of the conference that was recorded | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | diff --git a/docs/ConferenceMemberJoinCallback.md b/docs/ConferenceMemberJoinCallback.md index 73c91088..c8dec63d 100644 --- a/docs/ConferenceMemberJoinCallback.md +++ b/docs/ConferenceMemberJoinCallback.md @@ -12,7 +12,7 @@ The Conference Member Join event is fired whenever a caller joins a conference t |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**conferenceId** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] | |**name** | **String** | The user-specified name of the conference that was recorded | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | diff --git a/docs/CreateCall.md b/docs/CreateCall.md index a838dc3b..90cf7ad7 100644 --- a/docs/CreateCall.md +++ b/docs/CreateCall.md @@ -8,8 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**to** | **String** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | | -|**from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`, or be one of the following strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). | | -|**displayName** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. | [optional] | +|**from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | | +|**privacy** | **Boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] | +|**displayName** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] | |**uui** | **String** | A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433'>RFC 7433</a>. Only 'jwt' and 'base64' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] | |**applicationId** | **String** | The id of the application associated with the `from` number. | | |**answerUrl** | **URI** | The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | | diff --git a/docs/DisconnectCallback.md b/docs/DisconnectCallback.md index 60c6b869..e71b272f 100644 --- a/docs/DisconnectCallback.md +++ b/docs/DisconnectCallback.md @@ -12,7 +12,7 @@ The Disconnect event is fired when a call ends, for any reason. |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | diff --git a/docs/DtmfCallback.md b/docs/DtmfCallback.md index 3fe2b647..afa98eeb 100644 --- a/docs/DtmfCallback.md +++ b/docs/DtmfCallback.md @@ -12,7 +12,7 @@ The DTMF event is sent for every digit detected after a verb is ex |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | @@ -22,7 +22,7 @@ The DTMF event is sent for every digit detected after a verb is ex |**startTime** | **OffsetDateTime** | Time the call was started, in ISO 8601 format. | [optional] | |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**parentCallId** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | diff --git a/docs/GatherCallback.md b/docs/GatherCallback.md index b8514738..d0b6d029 100644 --- a/docs/GatherCallback.md +++ b/docs/GatherCallback.md @@ -12,7 +12,7 @@ The gather event is sent after a verb is executed. Its purpose is to re |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -23,7 +23,7 @@ The gather event is sent after a verb is executed. Its purpose is to re |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**parentCallId** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] | |**terminatingDigit** | **String** | (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | diff --git a/docs/InitiateCallback.md b/docs/InitiateCallback.md index fa56508d..67e7e7c1 100644 --- a/docs/InitiateCallback.md +++ b/docs/InitiateCallback.md @@ -12,7 +12,7 @@ The Initiate event is fired when an inbound call is received for a Telephone Num |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | diff --git a/docs/MachineDetectionCompleteCallback.md b/docs/MachineDetectionCompleteCallback.md index 64c54e62..937fce67 100644 --- a/docs/MachineDetectionCompleteCallback.md +++ b/docs/MachineDetectionCompleteCallback.md @@ -12,7 +12,7 @@ This event is sent to the url informed when requesting a machine detection opera |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | diff --git a/docs/MachineDetectionConfiguration.md b/docs/MachineDetectionConfiguration.md index a910e092..a3f6de4c 100644 --- a/docs/MachineDetectionConfiguration.md +++ b/docs/MachineDetectionConfiguration.md @@ -2,7 +2,7 @@ # MachineDetectionConfiguration -The machine detection request used to perform machine detection on the call. +The machine detection request used to perform machine detection on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information. ## Properties diff --git a/docs/RecordingAvailableCallback.md b/docs/RecordingAvailableCallback.md index 793b51db..c0937ffe 100644 --- a/docs/RecordingAvailableCallback.md +++ b/docs/RecordingAvailableCallback.md @@ -12,7 +12,7 @@ The Recording Available event is sent after a recording has been processed. It i |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -28,7 +28,7 @@ The Recording Available event is sent after a recording has been processed. It i |**channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | |**status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | diff --git a/docs/RecordingCompleteCallback.md b/docs/RecordingCompleteCallback.md index 6292e92f..e0d07e79 100644 --- a/docs/RecordingCompleteCallback.md +++ b/docs/RecordingCompleteCallback.md @@ -12,7 +12,7 @@ The Record Complete event is sent after a verb has executed if the call |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -28,7 +28,7 @@ The Record Complete event is sent after a verb has executed if the call |**fileFormat** | **FileFormatEnum** | | [optional] | |**channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | diff --git a/docs/RedirectCallback.md b/docs/RedirectCallback.md index adaecd0e..003cdb41 100644 --- a/docs/RedirectCallback.md +++ b/docs/RedirectCallback.md @@ -12,7 +12,7 @@ The Redirect event is fired when a verb is executed. Its purpose is t |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -22,7 +22,7 @@ The Redirect event is fired when a verb is executed. Its purpose is t |**startTime** | **OffsetDateTime** | Time the call was started, in ISO 8601 format. | [optional] | |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | diff --git a/docs/TranscriptionAvailableCallback.md b/docs/TranscriptionAvailableCallback.md index d560cae6..fafada17 100644 --- a/docs/TranscriptionAvailableCallback.md +++ b/docs/TranscriptionAvailableCallback.md @@ -12,7 +12,7 @@ The Transcription Available event is sent when the recording transcription is av |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -27,7 +27,7 @@ The Transcription Available event is sent when the recording transcription is av |**fileFormat** | **FileFormatEnum** | | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | |**transcription** | [**Transcription**](Transcription.md) | | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | diff --git a/docs/TranscriptionsApi.md b/docs/TranscriptionsApi.md index 7ec2dadf..cf9d6c9f 100644 --- a/docs/TranscriptionsApi.md +++ b/docs/TranscriptionsApi.md @@ -15,7 +15,7 @@ All URIs are relative to *http://localhost* Delete a specific transcription -Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. +Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. ### Example ```java @@ -78,7 +78,7 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **204** | Transcription data was deleted. | - | +| **200** | Transcription data was deleted. | - | | **400** | Bad Request | - | | **401** | Unauthorized | - | | **403** | Forbidden | - | diff --git a/docs/TransferAnswerCallback.md b/docs/TransferAnswerCallback.md index a8fdeeb2..c0974c0b 100644 --- a/docs/TransferAnswerCallback.md +++ b/docs/TransferAnswerCallback.md @@ -12,7 +12,7 @@ When processing a verb, this event is sent when a called party (B-leg |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -21,7 +21,7 @@ When processing a verb, this event is sent when a called party (B-leg |**startTime** | **OffsetDateTime** | Time the call was started, in ISO 8601 format. | [optional] | |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | diff --git a/docs/TransferCompleteCallback.md b/docs/TransferCompleteCallback.md index 97845e7e..52799431 100644 --- a/docs/TransferCompleteCallback.md +++ b/docs/TransferCompleteCallback.md @@ -12,7 +12,7 @@ This event is sent to the transferCompleteUrl of the A-leg's verb whe |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -21,7 +21,7 @@ This event is sent to the transferCompleteUrl of the A-leg's verb whe |**startTime** | **OffsetDateTime** | Time the call was started, in ISO 8601 format. | [optional] | |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**cause** | **String** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] | |**errorMessage** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] | diff --git a/docs/TransferDisconnectCallback.md b/docs/TransferDisconnectCallback.md index 3e7f4c7a..38a1f960 100644 --- a/docs/TransferDisconnectCallback.md +++ b/docs/TransferDisconnectCallback.md @@ -12,7 +12,7 @@ This event is sent to the transferDisconnectUrl of each tag when i |**eventTime** | **OffsetDateTime** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] | |**accountId** | **String** | The user account associated with the call. | [optional] | |**applicationId** | **String** | The id of the application associated with the call. | [optional] | -|**from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] | +|**from** | **String** | The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). | [optional] | |**to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] | |**direction** | **CallDirectionEnum** | | [optional] | |**callId** | **String** | The call id associated with the event. | [optional] | @@ -23,7 +23,7 @@ This event is sent to the transferDisconnectUrl of each tag when i |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. | [optional] | |**endTime** | **OffsetDateTime** | The time that the recording ended in ISO-8601 format | [optional] | |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] | -|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] | +|**transferCallerId** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**transferTo** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] | |**cause** | **String** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] | |**errorMessage** | **String** | Text explaining the reason that caused the call to fail in case of errors. | [optional] | diff --git a/src/main/java/com/bandwidth/sdk/api/TranscriptionsApi.java b/src/main/java/com/bandwidth/sdk/api/TranscriptionsApi.java index cbb52776..1dbd3cc3 100644 --- a/src/main/java/com/bandwidth/sdk/api/TranscriptionsApi.java +++ b/src/main/java/com/bandwidth/sdk/api/TranscriptionsApi.java @@ -85,7 +85,7 @@ public void setCustomBaseUrl(String customBaseUrl) { * @http.response.details - + @@ -166,7 +166,7 @@ private okhttp3.Call deleteRealTimeTranscriptionValidateBeforeCall(String accoun /** * Delete a specific transcription - * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @param accountId Your Bandwidth Account ID. (required) * @param callId Programmable Voice API Call ID. (required) * @param transcriptionId Programmable Voice API Transcription ID. (required) @@ -174,7 +174,7 @@ private okhttp3.Call deleteRealTimeTranscriptionValidateBeforeCall(String accoun * @http.response.details
Status Code Description Response Headers
204 Transcription data was deleted. -
200 Transcription data was deleted. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
- + @@ -191,7 +191,7 @@ public void deleteRealTimeTranscription(String accountId, String callId, String /** * Delete a specific transcription - * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @param accountId Your Bandwidth Account ID. (required) * @param callId Programmable Voice API Call ID. (required) * @param transcriptionId Programmable Voice API Transcription ID. (required) @@ -200,7 +200,7 @@ public void deleteRealTimeTranscription(String accountId, String callId, String * @http.response.details
Status Code Description Response Headers
204 Transcription data was deleted. -
200 Transcription data was deleted. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
- + @@ -218,7 +218,7 @@ public ApiResponse deleteRealTimeTranscriptionWithHttpInfo(String accountI /** * Delete a specific transcription (asynchronously) - * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. + * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours. * @param accountId Your Bandwidth Account ID. (required) * @param callId Programmable Voice API Call ID. (required) * @param transcriptionId Programmable Voice API Transcription ID. (required) @@ -228,7 +228,7 @@ public ApiResponse deleteRealTimeTranscriptionWithHttpInfo(String accountI * @http.response.details
Status Code Description Response Headers
204 Transcription data was deleted. -
200 Transcription data was deleted. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
- + diff --git a/src/main/java/com/bandwidth/sdk/model/AnswerCallback.java b/src/main/java/com/bandwidth/sdk/model/AnswerCallback.java index df58335f..2dfc3428 100644 --- a/src/main/java/com/bandwidth/sdk/model/AnswerCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/AnswerCallback.java @@ -196,7 +196,7 @@ public AnswerCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java b/src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java index b7d7a166..c297c96f 100644 --- a/src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/BridgeCompleteCallback.java @@ -203,7 +203,7 @@ public BridgeCompleteCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java b/src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java index f0328fcd..5b6fde22 100644 --- a/src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/BridgeTargetCompleteCallback.java @@ -191,7 +191,7 @@ public BridgeTargetCompleteCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java b/src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java index 0ab021a3..108fc81a 100644 --- a/src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java +++ b/src/main/java/com/bandwidth/sdk/model/CallRecordingMetadata.java @@ -252,7 +252,7 @@ public CallRecordingMetadata from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -271,7 +271,7 @@ public CallRecordingMetadata transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/CallTranscription.java b/src/main/java/com/bandwidth/sdk/model/CallTranscription.java index cd778a8c..ed340fe2 100644 --- a/src/main/java/com/bandwidth/sdk/model/CallTranscription.java +++ b/src/main/java/com/bandwidth/sdk/model/CallTranscription.java @@ -165,9 +165,9 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti @SerializedName(SERIALIZED_NAME_TRACK) private TrackEnum track; - public static final String SERIALIZED_NAME_TEXT = "text"; - @SerializedName(SERIALIZED_NAME_TEXT) - private String text; + public static final String SERIALIZED_NAME_TRANSCRIPT = "transcript"; + @SerializedName(SERIALIZED_NAME_TRANSCRIPT) + private String transcript; public static final String SERIALIZED_NAME_CONFIDENCE = "confidence"; @SerializedName(SERIALIZED_NAME_CONFIDENCE) @@ -214,22 +214,22 @@ public void setTrack(TrackEnum track) { } - public CallTranscription text(String text) { - this.text = text; + public CallTranscription transcript(String transcript) { + this.transcript = transcript; return this; } /** * The transcription itself. - * @return text + * @return transcript **/ @javax.annotation.Nullable - public String getText() { - return text; + public String getTranscript() { + return transcript; } - public void setText(String text) { - this.text = text; + public void setTranscript(String transcript) { + this.transcript = transcript; } @@ -310,14 +310,14 @@ public boolean equals(Object o) { CallTranscription callTranscription = (CallTranscription) o; return Objects.equals(this.detectedLanguage, callTranscription.detectedLanguage) && Objects.equals(this.track, callTranscription.track) && - Objects.equals(this.text, callTranscription.text) && + Objects.equals(this.transcript, callTranscription.transcript) && Objects.equals(this.confidence, callTranscription.confidence)&& Objects.equals(this.additionalProperties, callTranscription.additionalProperties); } @Override public int hashCode() { - return Objects.hash(detectedLanguage, track, text, confidence, additionalProperties); + return Objects.hash(detectedLanguage, track, transcript, confidence, additionalProperties); } @Override @@ -326,7 +326,7 @@ public String toString() { sb.append("class CallTranscription {\n"); sb.append(" detectedLanguage: ").append(toIndentedString(detectedLanguage)).append("\n"); sb.append(" track: ").append(toIndentedString(track)).append("\n"); - sb.append(" text: ").append(toIndentedString(text)).append("\n"); + sb.append(" transcript: ").append(toIndentedString(transcript)).append("\n"); sb.append(" confidence: ").append(toIndentedString(confidence)).append("\n"); sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); sb.append("}"); @@ -353,7 +353,7 @@ private String toIndentedString(Object o) { openapiFields = new HashSet(); openapiFields.add("detectedLanguage"); openapiFields.add("track"); - openapiFields.add("text"); + openapiFields.add("transcript"); openapiFields.add("confidence"); // a set of required properties/fields (JSON key names) @@ -387,8 +387,8 @@ public static void validateJsonElement(JsonElement jsonElement) throws IOExcepti if (jsonObj.get("track") != null && !jsonObj.get("track").isJsonNull()) { TrackEnum.validateJsonElement(jsonObj.get("track")); } - if ((jsonObj.get("text") != null && !jsonObj.get("text").isJsonNull()) && !jsonObj.get("text").isJsonPrimitive()) { - throw new IllegalArgumentException(String.format("Expected the field `text` to be a primitive type in the JSON string but got `%s`", jsonObj.get("text").toString())); + if ((jsonObj.get("transcript") != null && !jsonObj.get("transcript").isJsonNull()) && !jsonObj.get("transcript").isJsonPrimitive()) { + throw new IllegalArgumentException(String.format("Expected the field `transcript` to be a primitive type in the JSON string but got `%s`", jsonObj.get("transcript").toString())); } } diff --git a/src/main/java/com/bandwidth/sdk/model/ConferenceMemberExitCallback.java b/src/main/java/com/bandwidth/sdk/model/ConferenceMemberExitCallback.java index 662408af..ce9ca9f6 100644 --- a/src/main/java/com/bandwidth/sdk/model/ConferenceMemberExitCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/ConferenceMemberExitCallback.java @@ -170,7 +170,7 @@ public ConferenceMemberExitCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/ConferenceMemberJoinCallback.java b/src/main/java/com/bandwidth/sdk/model/ConferenceMemberJoinCallback.java index 349fa9a2..0aeecc46 100644 --- a/src/main/java/com/bandwidth/sdk/model/ConferenceMemberJoinCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/ConferenceMemberJoinCallback.java @@ -170,7 +170,7 @@ public ConferenceMemberJoinCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/CreateCall.java b/src/main/java/com/bandwidth/sdk/model/CreateCall.java index 101308ca..b232eccb 100644 --- a/src/main/java/com/bandwidth/sdk/model/CreateCall.java +++ b/src/main/java/com/bandwidth/sdk/model/CreateCall.java @@ -63,6 +63,10 @@ public class CreateCall { @SerializedName(SERIALIZED_NAME_FROM) private String from; + public static final String SERIALIZED_NAME_PRIVACY = "privacy"; + @SerializedName(SERIALIZED_NAME_PRIVACY) + private Boolean privacy; + public static final String SERIALIZED_NAME_DISPLAY_NAME = "displayName"; @SerializedName(SERIALIZED_NAME_DISPLAY_NAME) private String displayName; @@ -163,7 +167,7 @@ public CreateCall from(String from) { } /** - * A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`, or be one of the following strings: `Restricted`, `Anonymous`, `Private`, or `Unavailable`). + * A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. * @return from **/ @javax.annotation.Nonnull @@ -176,13 +180,32 @@ public void setFrom(String from) { } + public CreateCall privacy(Boolean privacy) { + this.privacy = privacy; + return this; + } + + /** + * Hide the calling number. The `displayName` field can be used to customize the displayed name. + * @return privacy + **/ + @javax.annotation.Nullable + public Boolean getPrivacy() { + return privacy; + } + + public void setPrivacy(Boolean privacy) { + this.privacy = privacy; + } + + public CreateCall displayName(String displayName) { this.displayName = displayName; return this; } /** - * The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. + * The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. * @return displayName **/ @javax.annotation.Nullable @@ -580,6 +603,7 @@ public boolean equals(Object o) { CreateCall createCall = (CreateCall) o; return Objects.equals(this.to, createCall.to) && Objects.equals(this.from, createCall.from) && + Objects.equals(this.privacy, createCall.privacy) && Objects.equals(this.displayName, createCall.displayName) && Objects.equals(this.uui, createCall.uui) && Objects.equals(this.applicationId, createCall.applicationId) && @@ -607,7 +631,7 @@ private static boolean equalsNullable(JsonNullable a, JsonNullable b) @Override public int hashCode() { - return Objects.hash(to, from, displayName, uui, applicationId, answerUrl, answerMethod, username, password, answerFallbackUrl, answerFallbackMethod, fallbackUsername, fallbackPassword, disconnectUrl, disconnectMethod, callTimeout, callbackTimeout, machineDetection, priority, tag, additionalProperties); + return Objects.hash(to, from, privacy, displayName, uui, applicationId, answerUrl, answerMethod, username, password, answerFallbackUrl, answerFallbackMethod, fallbackUsername, fallbackPassword, disconnectUrl, disconnectMethod, callTimeout, callbackTimeout, machineDetection, priority, tag, additionalProperties); } private static int hashCodeNullable(JsonNullable a) { @@ -623,6 +647,7 @@ public String toString() { sb.append("class CreateCall {\n"); sb.append(" to: ").append(toIndentedString(to)).append("\n"); sb.append(" from: ").append(toIndentedString(from)).append("\n"); + sb.append(" privacy: ").append(toIndentedString(privacy)).append("\n"); sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n"); sb.append(" uui: ").append(toIndentedString(uui)).append("\n"); sb.append(" applicationId: ").append(toIndentedString(applicationId)).append("\n"); @@ -666,6 +691,7 @@ private String toIndentedString(Object o) { openapiFields = new HashSet(); openapiFields.add("to"); openapiFields.add("from"); + openapiFields.add("privacy"); openapiFields.add("displayName"); openapiFields.add("uui"); openapiFields.add("applicationId"); diff --git a/src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java b/src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java index d8877d64..29f7fd01 100644 --- a/src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/DisconnectCallback.java @@ -207,7 +207,7 @@ public DisconnectCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/DtmfCallback.java b/src/main/java/com/bandwidth/sdk/model/DtmfCallback.java index 15a899d9..67912c33 100644 --- a/src/main/java/com/bandwidth/sdk/model/DtmfCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/DtmfCallback.java @@ -207,7 +207,7 @@ public DtmfCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -397,7 +397,7 @@ public DtmfCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/GatherCallback.java b/src/main/java/com/bandwidth/sdk/model/GatherCallback.java index d25d9193..e635fd05 100644 --- a/src/main/java/com/bandwidth/sdk/model/GatherCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/GatherCallback.java @@ -211,7 +211,7 @@ public GatherCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -420,7 +420,7 @@ public GatherCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/InitiateCallback.java b/src/main/java/com/bandwidth/sdk/model/InitiateCallback.java index e1e271ef..52b0ef46 100644 --- a/src/main/java/com/bandwidth/sdk/model/InitiateCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/InitiateCallback.java @@ -188,7 +188,7 @@ public InitiateCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/MachineDetectionCompleteCallback.java b/src/main/java/com/bandwidth/sdk/model/MachineDetectionCompleteCallback.java index ab17c1b3..e3e46763 100644 --- a/src/main/java/com/bandwidth/sdk/model/MachineDetectionCompleteCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/MachineDetectionCompleteCallback.java @@ -196,7 +196,7 @@ public MachineDetectionCompleteCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/MachineDetectionConfiguration.java b/src/main/java/com/bandwidth/sdk/model/MachineDetectionConfiguration.java index 57d22b12..86785f36 100644 --- a/src/main/java/com/bandwidth/sdk/model/MachineDetectionConfiguration.java +++ b/src/main/java/com/bandwidth/sdk/model/MachineDetectionConfiguration.java @@ -51,7 +51,7 @@ import com.bandwidth.sdk.JSON; /** - * The machine detection request used to perform <a href='/docs/voice/guides/machineDetection'>machine detection</a> on the call. + * The machine detection request used to perform <a href='/docs/voice/guides/machineDetection'>machine detection</a> on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information. */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0") public class MachineDetectionConfiguration { diff --git a/src/main/java/com/bandwidth/sdk/model/RecordingAvailableCallback.java b/src/main/java/com/bandwidth/sdk/model/RecordingAvailableCallback.java index d34978ed..7921781a 100644 --- a/src/main/java/com/bandwidth/sdk/model/RecordingAvailableCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/RecordingAvailableCallback.java @@ -229,7 +229,7 @@ public RecordingAvailableCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -533,7 +533,7 @@ public RecordingAvailableCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/RecordingCompleteCallback.java b/src/main/java/com/bandwidth/sdk/model/RecordingCompleteCallback.java index 3253834b..0f7ea796 100644 --- a/src/main/java/com/bandwidth/sdk/model/RecordingCompleteCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/RecordingCompleteCallback.java @@ -229,7 +229,7 @@ public RecordingCompleteCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -533,7 +533,7 @@ public RecordingCompleteCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/RedirectCallback.java b/src/main/java/com/bandwidth/sdk/model/RedirectCallback.java index ea4f7ca3..352bf6d1 100644 --- a/src/main/java/com/bandwidth/sdk/model/RedirectCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/RedirectCallback.java @@ -203,7 +203,7 @@ public RedirectCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -393,7 +393,7 @@ public RedirectCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/TranscriptionAvailableCallback.java b/src/main/java/com/bandwidth/sdk/model/TranscriptionAvailableCallback.java index cc7873e6..a40236f0 100644 --- a/src/main/java/com/bandwidth/sdk/model/TranscriptionAvailableCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/TranscriptionAvailableCallback.java @@ -226,7 +226,7 @@ public TranscriptionAvailableCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -511,7 +511,7 @@ public TranscriptionAvailableCallback transferCallerId(String transferCallerId) } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/TransferAnswerCallback.java b/src/main/java/com/bandwidth/sdk/model/TransferAnswerCallback.java index 1861f4a1..64ecfeda 100644 --- a/src/main/java/com/bandwidth/sdk/model/TransferAnswerCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/TransferAnswerCallback.java @@ -199,7 +199,7 @@ public TransferAnswerCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -370,7 +370,7 @@ public TransferAnswerCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/TransferCompleteCallback.java b/src/main/java/com/bandwidth/sdk/model/TransferCompleteCallback.java index 26df82fe..57410ffc 100644 --- a/src/main/java/com/bandwidth/sdk/model/TransferCompleteCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/TransferCompleteCallback.java @@ -211,7 +211,7 @@ public TransferCompleteCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -382,7 +382,7 @@ public TransferCompleteCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable diff --git a/src/main/java/com/bandwidth/sdk/model/TransferDisconnectCallback.java b/src/main/java/com/bandwidth/sdk/model/TransferDisconnectCallback.java index 4d8bf17b..594a9730 100644 --- a/src/main/java/com/bandwidth/sdk/model/TransferDisconnectCallback.java +++ b/src/main/java/com/bandwidth/sdk/model/TransferDisconnectCallback.java @@ -219,7 +219,7 @@ public TransferDisconnectCallback from(String from) { } /** - * The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. + * The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). * @return from **/ @javax.annotation.Nullable @@ -428,7 +428,7 @@ public TransferDisconnectCallback transferCallerId(String transferCallerId) { } /** - * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. + * The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). * @return transferCallerId **/ @javax.annotation.Nullable
Status Code Description Response Headers
204 Transcription data was deleted. -
200 Transcription data was deleted. -
400 Bad Request -
401 Unauthorized -
403 Forbidden -