SWI-5508

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 <a
         href='/docs/voice/guides/machineDetection'>machine detection</a> 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

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] |

docs/BridgeCompleteCallback.md

@@ -12,7 +12,7 @@ If the target call leaves the <Bridge>, 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] |

docs/BridgeTargetCompleteCallback.md

@@ -12,7 +12,7 @@ If the originating call leaves the <Bridge>, 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] |

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] |

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] |
 
 

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] |

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] |

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`. |  |

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] |

docs/DtmfCallback.md

@@ -12,7 +12,7 @@ The DTMF event is sent for every digit detected after a <StartGather> 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 <StartGather> 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 &lt;Transfer&gt;, the call id of the original call leg that executed the &lt;Transfer&gt;. 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] |