bandwidth-sdk 11.0.0.pre.beta.1 → 11.0.0.pre.beta.2.0

data/bandwidth.yml

@@ -167,9 +167,11 @@ paths:
         - $ref: '#/components/parameters/errorCode'
         - $ref: '#/components/parameters/fromDateTime'
         - $ref: '#/components/parameters/toDateTime'
+        - $ref: '#/components/parameters/campaignId'
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/pageToken'
         - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/limitTotalCount'
       responses:
         '200':
           $ref: '#/components/responses/listMessagesResponse'
@@ -241,7 +243,7 @@ paths:
         approximately in order, but exact ordering is not guaranteed.
       operationId: createCall
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
       requestBody:
         $ref: '#/components/requestBodies/createCallRequest'
       responses:
@@ -282,7 +284,7 @@ paths:
         7 days, you will get an HTTP 404 response.
       operationId: getCallState
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
       responses:
         '200':
@@ -312,13 +314,13 @@ paths:
         BXML document.
       operationId: updateCall
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
       requestBody:
         $ref: '#/components/requestBodies/updateCallRequest'
       responses:
         '200':
-          description: Call Successfully Modified
+          description: Call was successfully modified.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -346,13 +348,13 @@ paths:
       description: Interrupts and replaces an active call's BXML document.
       operationId: updateCallBxml
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
       requestBody:
         $ref: '#/components/requestBodies/updateCallBxmlRequest'
       responses:
         '204':
-          description: Call BXML Successfully Replaced
+          description: Call BXML was successfully replaced.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -388,7 +390,7 @@ paths:
         of conference records.
       operationId: listConferences
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/name'
         - $ref: '#/components/parameters/minCreatedTime'
         - $ref: '#/components/parameters/maxCreatedTime'
@@ -422,7 +424,7 @@ paths:
       description: Returns information about the specified conference.
       operationId: getConference
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
       responses:
         '200':
@@ -450,13 +452,13 @@ paths:
       description: Update the conference state.
       operationId: updateConference
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
       requestBody:
         $ref: '#/components/requestBodies/updateConferenceRequest'
       responses:
         '204':
-          description: Conference successfully modified
+          description: Conference was successfully modified.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -482,13 +484,13 @@ paths:
       description: Update the conference BXML document.
       operationId: updateConferenceBxml
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
       requestBody:
         $ref: '#/components/requestBodies/updateConferenceBxmlRequest'
       responses:
         '204':
-          description: Conference successfully modified
+          description: Conference successfully modified.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -514,7 +516,7 @@ paths:
       description: Returns information about the specified conference member.
       operationId: getConferenceMember
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
         - $ref: '#/components/parameters/memberId'
       responses:
@@ -543,14 +545,14 @@ paths:
       description: Updates settings for a particular conference member.
       operationId: updateConferenceMember
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
         - $ref: '#/components/parameters/memberId'
       requestBody:
         $ref: '#/components/requestBodies/updateConferenceMemberRequest'
       responses:
         '204':
-          description: Conference member successfully modified
+          description: Conference member was successfully modified.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -578,7 +580,7 @@ paths:
         took place during the specified conference.
       operationId: listConferenceRecordings
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
       responses:
         '200':
@@ -608,7 +610,7 @@ paths:
       description: Returns metadata for the specified recording.
       operationId: getConferenceRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
         - $ref: '#/components/parameters/recordingId'
       responses:
@@ -639,7 +641,7 @@ paths:
       description: Downloads the specified recording file.
       operationId: downloadConferenceRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/conferenceId'
         - $ref: '#/components/parameters/recordingId'
       responses:
@@ -679,7 +681,7 @@ paths:
         empty if no recordings match the specified criteria.
       operationId: listAccountCallRecordings
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/to'
         - $ref: '#/components/parameters/from'
         - $ref: '#/components/parameters/minStartTime'
@@ -712,13 +714,13 @@ paths:
       description: Pause or resume a recording on an active phone call.
       operationId: updateCallRecordingState
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
       requestBody:
         $ref: '#/components/requestBodies/updateCallRecordingRequest'
       responses:
         '200':
-          description: Recording state successfully modified
+          description: Recording state was successfully modified.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -746,7 +748,7 @@ paths:
         that took place during the specified call.
       operationId: listCallRecordings
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
       responses:
         '200':
@@ -776,7 +778,7 @@ paths:
       description: Returns metadata for the specified recording.
       operationId: getCallRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
@@ -813,12 +815,12 @@ paths:
         irreversible, can take an additional 24 to 48 hours.
       operationId: deleteRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
         '204':
-          description: Recording Deleted
+          description: Recording was deleted.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -844,7 +846,7 @@ paths:
       description: Downloads the specified recording.
       operationId: downloadCallRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
@@ -873,12 +875,12 @@ paths:
       description: Deletes the specified recording's media.
       operationId: deleteRecordingMedia
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
         '204':
-          description: The recording media was successfully deleted
+          description: The recording media was successfully deleted.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -918,7 +920,7 @@ paths:
         item.
       operationId: getCallTranscription
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
@@ -953,14 +955,14 @@ paths:
         less than 4 hours.
       operationId: transcribeCallRecording
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       requestBody:
         $ref: '#/components/requestBodies/transcribeRecordingRequest'
       responses:
         '204':
-          description: Transcription successfully requested
+          description: Transcription was successfully requested.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -991,12 +993,12 @@ paths:
         can take an additional 24 to 48 hours.
       operationId: deleteCallTranscription
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/recordingId'
       responses:
         '204':
-          description: The transcription was successfully deleted
+          description: The transcription was successfully deleted.
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
         '401':
@@ -1022,7 +1024,7 @@ paths:
       description: Returns details about the current state of the account.
       operationId: getStatistics
       parameters:
-        - $ref: '#/components/parameters/accountId1'
+        - $ref: '#/components/parameters/accountId'
       responses:
         '200':
           $ref: '#/components/responses/getStatisticsResponse'
@@ -1051,7 +1053,7 @@ paths:
       description: Send an MFA Code via a phone call.
       operationId: generateVoiceCode
       parameters:
-        - $ref: '#/components/parameters/accountId2'
+        - $ref: '#/components/parameters/accountId'
       requestBody:
         $ref: '#/components/requestBodies/codeRequest'
       responses:
@@ -1076,7 +1078,7 @@ paths:
       description: Send an MFA code via text message (SMS).
       operationId: generateMessagingCode
       parameters:
-        - $ref: '#/components/parameters/accountId2'
+        - $ref: '#/components/parameters/accountId'
       requestBody:
         $ref: '#/components/requestBodies/codeRequest'
       responses:
@@ -1099,7 +1101,7 @@ paths:
       description: Verify a previously sent MFA code.
       operationId: verifyCode
       parameters:
-        - $ref: '#/components/parameters/accountId2'
+        - $ref: '#/components/parameters/accountId'
       requestBody:
         $ref: '#/components/requestBodies/codeVerify'
       responses:
@@ -1124,7 +1126,7 @@ paths:
       tags:
         - Phone Number Lookup
       parameters:
-        - $ref: '#/components/parameters/accountId3'
+        - $ref: '#/components/parameters/accountId'
       requestBody:
         $ref: '#/components/requestBodies/createLookupRequest'
       responses:
@@ -1153,7 +1155,7 @@ paths:
       tags:
         - Phone Number Lookup
       parameters:
-        - $ref: '#/components/parameters/accountId3'
+        - $ref: '#/components/parameters/accountId'
         - $ref: '#/components/parameters/requestId'
       responses:
         '200':
@@ -1175,7 +1177,10 @@ components:
   schemas:
     priorityEnum:
       type: string
-      description: The priority specified by the user.
+      description: |-
+        The priority specified by the user.
+
+        Not supported on MMS.
       enum:
         - default
         - high
@@ -1233,7 +1238,9 @@ components:
       properties:
         totalCount:
           type: integer
-          description: Total number of messages matched by the search.
+          description: >-
+            The total number of messages matched by the search. When the request
+            has limitTotalCount set to true this value is limited to 10,000.
           example: 100
         pageInfo:
           $ref: '#/components/schemas/pageInfo'
@@ -1277,6 +1284,7 @@ components:
           example: 9902
         receiveTime:
           type: string
+          format: date-time
           description: The ISO 8601 datetime of the message.
           example: 2020-04-07T14:03:07.000Z
         carrierName:
@@ -1310,6 +1318,11 @@ components:
           description: The campaign class of the message if it has one.
           nullable: true
           example: T
+        campaignId:
+          type: string
+          description: The campaign ID of the message if it has one.
+          nullable: true
+          example: CJEUMDK
     pageInfo:
       title: PageInfo
       type: object
@@ -1402,6 +1415,7 @@ components:
           example: 93de2206-9669-4e07-948d-329f4b722ee2
         time:
           type: string
+          format: date-time
           description: The datetime stamp of the message in ISO 8601
           example: 2022-09-14T18:20:16.000Z
         segmentCount:
@@ -1446,6 +1460,11 @@ components:
           example: custom tag
         priority:
           $ref: '#/components/schemas/priorityEnum'
+        expiration:
+          type: string
+          format: date-time
+          description: The expiration date-time set by the user.
+          example: '2021-02-01T11:29:18-05:00'
     messageRequest:
       title: MessageRequest
       type: object
@@ -1504,10 +1523,14 @@ components:
           $ref: '#/components/schemas/priorityEnum'
         expiration:
           type: string
+          format: date-time
           description: >-
             A string with the date/time value that the message will
             automatically expire by. This must be a valid RFC-3339 value, e.g.,
-            2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
+            2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a
+            date-time in the future.
+
+            Not supported on MMS.
           example: '2021-02-01T11:29:18-05:00'
     inboundMessageCallback:
       description: Inbound Message Callback
@@ -1527,68 +1550,71 @@ components:
           type: string
           example: Incoming message received
         message:
-          type: object
-          properties:
-            id:
-              type: string
-              example: 1661365814859loidf7mcwd4qacn7
-            owner:
-              type: string
-              example: '+15553332222'
-            applicationId:
-              type: string
-              example: 93de2206-9669-4e07-948d-329f4b722ee2
-            time:
-              type: string
-              format: date-time
-              example: 2016-09-14T18:20:16.000Z
-            segmentCount:
-              type: integer
-              example: 1
-            direction:
-              $ref: '#/components/schemas/messageDirectionEnum'
-            to:
-              uniqueItems: true
-              type: array
-              items:
-                type: string
-              example:
-                - '+15552223333'
-            from:
-              type: string
-              example: '+15553332222'
-            text:
-              type: string
-              example: Hello world
-            tag:
-              type: string
-              example: custom string
-            media:
-              type: array
-              items:
-                type: string
-                format: uri
-              example:
-                - https://dev.bandwidth.com/images/bandwidth-logo.png
-                - https://dev.bandwidth.com/images/github_logo.png
-            priority:
-              $ref: '#/components/schemas/priorityEnum'
-          required:
-            - id
-            - owner
-            - applicationId
-            - time
-            - segmentCount
-            - direction
-            - to
-            - from
-            - text
+          $ref: '#/components/schemas/inboundMessageCallbackMessage'
       required:
         - time
         - type
         - to
         - description
         - message
+    inboundMessageCallbackMessage:
+      description: Inbound Message Callback Message Schema
+      type: object
+      properties:
+        id:
+          type: string
+          example: 1661365814859loidf7mcwd4qacn7
+        owner:
+          type: string
+          example: '+15553332222'
+        applicationId:
+          type: string
+          example: 93de2206-9669-4e07-948d-329f4b722ee2
+        time:
+          type: string
+          format: date-time
+          example: 2016-09-14T18:20:16.000Z
+        segmentCount:
+          type: integer
+          example: 1
+        direction:
+          $ref: '#/components/schemas/messageDirectionEnum'
+        to:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+          example:
+            - '+15552223333'
+        from:
+          type: string
+          example: '+15553332222'
+        text:
+          type: string
+          example: Hello world
+        tag:
+          type: string
+          example: custom string
+        media:
+          type: array
+          items:
+            type: string
+            format: uri
+          example:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+            - https://dev.bandwidth.com/images/github_logo.png
+        priority:
+          $ref: '#/components/schemas/priorityEnum'
+      required:
+        - id
+        - owner
+        - applicationId
+        - time
+        - segmentCount
+        - direction
+        - to
+        - from
+        - text
     messageSendingCallback:
       type: object
       description: Message Sending Callback
@@ -1607,70 +1633,73 @@ components:
           type: string
           example: Message is sending to carrier
         message:
-          type: object
-          properties:
-            id:
-              type: string
-              example: 1661365814859loidf7mcwd4qacn7
-            owner:
-              type: string
-              example: '+15553332222'
-            applicationId:
-              type: string
-              example: 93de2206-9669-4e07-948d-329f4b722ee2
-            time:
-              type: string
-              format: date-time
-              example: 2016-09-14T18:20:16.000Z
-            segmentCount:
-              type: integer
-              example: 1
-            direction:
-              $ref: '#/components/schemas/messageDirectionEnum'
-            to:
-              uniqueItems: true
-              type: array
-              items:
-                type: string
-              example:
-                - '+15552223333'
-            from:
-              type: string
-              example: '+15553332222'
-            text:
-              type: string
-              example: ''
-            tag:
-              type: string
-              example: custom string
-            media:
-              type: array
-              items:
-                type: string
-                format: uri
-              example:
-                - https://dev.bandwidth.com/images/bandwidth-logo.png
-                - https://dev.bandwidth.com/images/github_logo.png
-            priority:
-              $ref: '#/components/schemas/priorityEnum'
-          required:
-            - id
-            - owner
-            - applicationId
-            - time
-            - segmentCount
-            - direction
-            - to
-            - from
-            - text
-            - media
-            - priority
+          $ref: '#/components/schemas/messageSendingCallbackMessage'
       required:
         - time
         - type
         - to
         - description
         - message
+    messageSendingCallbackMessage:
+      description: Message Sending Callback Message Schema
+      type: object
+      properties:
+        id:
+          type: string
+          example: 1661365814859loidf7mcwd4qacn7
+        owner:
+          type: string
+          example: '+15553332222'
+        applicationId:
+          type: string
+          example: 93de2206-9669-4e07-948d-329f4b722ee2
+        time:
+          type: string
+          format: date-time
+          example: 2016-09-14T18:20:16.000Z
+        segmentCount:
+          type: integer
+          example: 1
+        direction:
+          $ref: '#/components/schemas/messageDirectionEnum'
+        to:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+          example:
+            - '+15552223333'
+        from:
+          type: string
+          example: '+15553332222'
+        text:
+          type: string
+          example: Hello world
+        tag:
+          type: string
+          example: custom string
+        media:
+          type: array
+          items:
+            type: string
+            format: uri
+          example:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+            - https://dev.bandwidth.com/images/github_logo.png
+        priority:
+          $ref: '#/components/schemas/priorityEnum'
+      required:
+        - id
+        - owner
+        - applicationId
+        - time
+        - segmentCount
+        - direction
+        - to
+        - from
+        - text
+        - media
+        - priority
     messageDeliveredCallback:
       description: Message Delivered Callback
       type: object
@@ -1689,69 +1718,72 @@ components:
           type: string
           example: Message delivered to carrier.
         message:
-          type: object
-          properties:
-            id:
-              type: string
-              example: 1661365814859loidf7mcwd4qacn7
-            owner:
-              type: string
-              example: '+15553332222'
-            applicationId:
-              type: string
-              example: 93de2206-9669-4e07-948d-329f4b722ee2
-            time:
-              type: string
-              format: date-time
-              example: 2016-09-14T18:20:16.000Z
-            segmentCount:
-              type: integer
-              example: 1
-            direction:
-              $ref: '#/components/schemas/messageDirectionEnum'
-            to:
-              uniqueItems: true
-              type: array
-              items:
-                type: string
-              example:
-                - '+15552223333'
-            from:
-              type: string
-              example: '+15553332222'
-            text:
-              type: string
-              example: ''
-            tag:
-              type: string
-              example: custom string
-            media:
-              type: array
-              items:
-                type: string
-                format: uri
-              example:
-                - https://dev.bandwidth.com/images/bandwidth-logo.png
-                - https://dev.bandwidth.com/images/github_logo.png
-            priority:
-              $ref: '#/components/schemas/priorityEnum'
-          required:
-            - id
-            - owner
-            - applicationId
-            - time
-            - segmentCount
-            - direction
-            - to
-            - from
-            - text
-            - tag
+          $ref: '#/components/schemas/messageDeliveredCallbackMessage'
       required:
         - time
         - type
         - to
         - description
         - message
+    messageDeliveredCallbackMessage:
+      description: Message Delivered Callback Message Schema
+      type: object
+      properties:
+        id:
+          type: string
+          example: 1661365814859loidf7mcwd4qacn7
+        owner:
+          type: string
+          example: '+15553332222'
+        applicationId:
+          type: string
+          example: 93de2206-9669-4e07-948d-329f4b722ee2
+        time:
+          type: string
+          format: date-time
+          example: 2016-09-14T18:20:16.000Z
+        segmentCount:
+          type: integer
+          example: 1
+        direction:
+          $ref: '#/components/schemas/messageDirectionEnum'
+        to:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+          example:
+            - '+15552223333'
+        from:
+          type: string
+          example: '+15553332222'
+        text:
+          type: string
+          example: Hello world
+        tag:
+          type: string
+          example: custom string
+        media:
+          type: array
+          items:
+            type: string
+            format: uri
+          example:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+            - https://dev.bandwidth.com/images/github_logo.png
+        priority:
+          $ref: '#/components/schemas/priorityEnum'
+      required:
+        - id
+        - owner
+        - applicationId
+        - time
+        - segmentCount
+        - direction
+        - to
+        - from
+        - text
+        - tag
     messageFailedCallback:
       description: Message Failed Callback
       type: object
@@ -1770,64 +1802,7 @@ components:
           type: string
           example: rejected-unallocated-from-number
         message:
-          type: object
-          properties:
-            id:
-              type: string
-              example: 1661365814859loidf7mcwd4qacn7
-            owner:
-              type: string
-              example: '+15553332222'
-            applicationId:
-              type: string
-              example: 93de2206-9669-4e07-948d-329f4b722ee2
-            time:
-              type: string
-              format: date-time
-              example: 2016-09-14T18:20:16.000Z
-            segmentCount:
-              type: integer
-              example: 1
-            direction:
-              $ref: '#/components/schemas/messageDirectionEnum'
-            to:
-              uniqueItems: true
-              type: array
-              items:
-                type: string
-              example:
-                - '+15552223333'
-            from:
-              type: string
-              example: '+15553332222'
-            text:
-              type: string
-              example: ''
-            tag:
-              type: string
-              example: custom string
-            media:
-              type: array
-              items:
-                type: string
-                format: uri
-              example:
-                - https://dev.bandwidth.com/images/bandwidth-logo.png
-                - https://dev.bandwidth.com/images/github_logo.png
-            priority:
-              $ref: '#/components/schemas/priorityEnum'
-          required:
-            - id
-            - owner
-            - applicationId
-            - time
-            - segmentCount
-            - direction
-            - to
-            - from
-            - text
-            - tag
-            - priority
+          $ref: '#/components/schemas/messageFailedCallbackMessage'
         errorCode:
           type: integer
           example: 9902
@@ -1838,6 +1813,66 @@ components:
         - description
         - message
         - errorCode
+    messageFailedCallbackMessage:
+      description: Message Failed Callback Message Schema
+      type: object
+      properties:
+        id:
+          type: string
+          example: 1661365814859loidf7mcwd4qacn7
+        owner:
+          type: string
+          example: '+15553332222'
+        applicationId:
+          type: string
+          example: 93de2206-9669-4e07-948d-329f4b722ee2
+        time:
+          type: string
+          format: date-time
+          example: 2016-09-14T18:20:16.000Z
+        segmentCount:
+          type: integer
+          example: 1
+        direction:
+          $ref: '#/components/schemas/messageDirectionEnum'
+        to:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+          example:
+            - '+15552223333'
+        from:
+          type: string
+          example: '+15553332222'
+        text:
+          type: string
+          example: Hello world
+        tag:
+          type: string
+          example: custom string
+        media:
+          type: array
+          items:
+            type: string
+            format: uri
+          example:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+            - https://dev.bandwidth.com/images/github_logo.png
+        priority:
+          $ref: '#/components/schemas/priorityEnum'
+      required:
+        - id
+        - owner
+        - applicationId
+        - time
+        - segmentCount
+        - direction
+        - to
+        - from
+        - text
+        - tag
+        - priority
     callbackMethodEnum:
       type: string
       nullable: true
@@ -1860,7 +1895,7 @@ components:
         The HTTP method to use for the request to `redirectUrl`. GET
 
         or POST. Default value is POST.<br><br>Not allowed if `state` is
-        `completed`
+        `completed`.
       example: POST
     recordingStateEnum:
       type: string
@@ -1873,18 +1908,21 @@ components:
         `paused` to pause an active recording
 
         `recording` to resume a paused recording
+      example: paused
     callDirectionEnum:
       type: string
       enum:
         - inbound
         - outbound
       description: The direction of the call.
+      example: inbound
     fileFormatEnum:
       type: string
       enum:
         - mp3
         - wav
-      description: The format that the recording is stored in
+      description: The format that the recording is stored in.
+      example: wav
     callStateEnum:
       nullable: true
       type: string
@@ -1902,6 +1940,7 @@ components:
         unanswered
 
         inbound call
+      example: completed
     conferenceStateEnum:
       nullable: true
       type: string
@@ -1911,7 +1950,8 @@ components:
         - completed
       description: >-
         Setting the conference state to `completed` ends the conference and
-        ejects all members
+        ejects all members.
+      example: completed
     machineDetectionModeEnum:
       type: string
       default: async
@@ -1927,6 +1967,7 @@ components:
         complete
 
         and will include its result.
+      example: async
     createCall:
       type: object
       required:
@@ -1937,9 +1978,11 @@ components:
       properties:
         to:
           type: string
-          description: |-
+          description: >-
             The destination to call (must be an E.164 formatted number
-            (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.com`)).
+
+            (e.g. `+15555551212`) or a SIP URI (e.g.
+            `sip:user@server.example`)).
           example: '+19195551234'
         from:
           type: string
@@ -1955,7 +1998,7 @@ components:
           nullable: true
           type: string
           example: >-
-            eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ=;encoding=base64
+            eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding=jwt,aGVsbG8gd29ybGQ;encoding=base64
           description: >-
             A comma-separated list of 'User-To-User' headers to be sent
 
@@ -1989,9 +2032,9 @@ components:
             call.
 
 
-            Must use `https` if specifying `username` and `password`
+            Must use `https` if specifying `username` and `password`.
           maxLength: 2048
-          example: https://www.myCallbackServer.com/webhooks/answer
+          example: https://www.myCallbackServer.example/webhooks/answer
         answerMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
@@ -2017,9 +2060,9 @@ components:
 
 
             Must use `https` if specifying `fallbackUsername` and
-            `fallbackPassword`
+            `fallbackPassword`.
           maxLength: 2048
-          example: https://www.myFallbackServer.com/webhooks/answer
+          example: https://www.myFallbackServer.example/webhooks/answer
         answerFallbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         fallbackUsername:
@@ -2043,6 +2086,7 @@ components:
             href='/docs/voice/webhooks/disconnect'>Disconnect</a> event to when
             the call ends. This event does not expect a BXML response.
           maxLength: 2048
+          example: https://www.myCallbackServer.example/webhooks/disconnect
         disconnectMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         callTimeout:
@@ -2062,6 +2106,7 @@ components:
           minimum: 1
           maximum: 300
           default: 30
+          example: 30
         callbackTimeout:
           nullable: true
           type: number
@@ -2076,6 +2121,7 @@ components:
           minimum: 1
           maximum: 25
           default: 15
+          example: 15
         machineDetection:
           $ref: '#/components/schemas/machineDetectionConfiguration'
         priority:
@@ -2101,6 +2147,7 @@ components:
             takes
 
             precedence over a priority 2 call.
+          example: 5
         tag:
           nullable: true
           type: string
@@ -2117,7 +2164,8 @@ components:
 
 
             Max length 256 characters.
-          maximum: 256
+          maxLength: 256
+          example: arbitrary text here
     createCallResponse:
       type: object
       required:
@@ -2138,31 +2186,31 @@ components:
         accountId:
           type: string
           example: '9900000'
-          description: The bandwidth account ID associated with the call
+          description: The bandwidth account ID associated with the call.
         callId:
           type: string
           example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
-          description: Programmable Voice API Call ID
+          description: Programmable Voice API Call ID.
         to:
           type: string
           example: '+19195551234'
-          description: Recipient of the outgoing call
+          description: Recipient of the outgoing call.
         from:
           type: string
           example: '+19195554321'
-          description: Phone number that created the outbound call
+          description: Phone number that created the outbound call.
         enqueuedTime:
           nullable: true
           type: string
           format: date-time
-          description: Time the call was accepted into the queue
+          description: The time at which the call was accepted into the queue.
           example: '2022-06-16T13:15:07.160Z'
         callUrl:
           type: string
           format: uri
           example: >-
             https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
-          description: The URL to update call state
+          description: The URL to update this call's state.
         callTimeout:
           type: number
           format: double
@@ -2181,13 +2229,13 @@ components:
           nullable: true
           type: string
           example: My custom tag value
-          description: Custom tag value
+          description: Custom tag value.
         answerMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         answerUrl:
           type: string
           format: uri
-          example: https://myServer.com/bandwidth/webhooks/answer
+          example: https://myServer.example/bandwidth/webhooks/answer
           description: URL to deliver the `answer` event webhook.
         answerFallbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
@@ -2195,7 +2243,7 @@ components:
           nullable: true
           type: string
           format: uri
-          example: https://myFallbackServer.com/bandwidth/webhooks/answer
+          example: https://myFallbackServer.example/bandwidth/webhooks/answer
           description: Fallback URL to deliver the `answer` event webhook.
         disconnectMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
@@ -2203,7 +2251,7 @@ components:
           nullable: true
           type: string
           format: uri
-          example: https://myServer.com/bandwidth/webhooks/disconnect
+          example: https://myServer.example/bandwidth/webhooks/disconnect
           description: URL to deliver the `disconnect` event webhook.
         username:
           type: string
@@ -2231,8 +2279,7 @@ components:
           example: mySecretPassword1!
         priority:
           nullable: true
-          type: number
-          format: integer
+          type: integer
           example: 5
           description: The priority of this call over other calls from your account.
     callState:
@@ -2261,7 +2308,7 @@ components:
           type: string
           description: >-
             The phone number that received the call, in E.164 format (e.g.
-            +15555555555), or if the call was to a SIP URI, the SIP URI
+            +15555555555), or if the call was to a SIP URI, the SIP URI.
           example: '+19195551234'
         from:
           type: string
@@ -2316,7 +2363,7 @@ components:
 
 
             More information: [Understanding
-            STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken)
+            STIR/SHAKEN](https://www.bandwidth.com/regulations/stir-shaken).
           additionalProperties:
             type: string
           example:
@@ -2442,7 +2489,7 @@ components:
           nullable: true
           type: string
           format: uri
-          example: https://myServer.com/bandwidth/webhooks/redirect
+          example: https://myServer.example/bandwidth/webhooks/redirect
         redirectMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         username:
@@ -2463,8 +2510,8 @@ components:
           format: uri
           description: |-
             A fallback url which, if provided, will be used to retry the
-            redirect callback delivery in case `redirectUrl` fails to respond
-          example: https://myFallbackServer.com/bandwidth/webhooks/redirect
+            redirect callback delivery in case `redirectUrl` fails to respond.
+          example: https://myFallbackServer.example/bandwidth/webhooks/redirect
         redirectFallbackMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         fallbackUsername:
@@ -2498,7 +2545,7 @@ components:
 
 
             Not allowed if `state` is `completed`.
-          maximum: 256
+          maxLength: 256
           example: My Custom Tag
     updateCallRecording:
       type: object
@@ -2564,11 +2611,11 @@ components:
       properties:
         id:
           type: string
-          description: The Bandwidth-generated conference ID
+          description: The Bandwidth-generated conference ID.
           example: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
         name:
           type: string
-          description: The name of the conference, as specified by your application
+          description: The name of the conference, as specified by your application.
           example: my-conference-name
         createdTime:
           type: string
@@ -2586,7 +2633,7 @@ components:
           type: string
           format: uri
           description: The URL to send the conference-related events.
-          example: https://myServer.com/bandwidth/webhooks/conferenceEvent
+          example: https://myServer.example/bandwidth/webhooks/conferenceEvent
         conferenceEventMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         tag:
@@ -2605,7 +2652,7 @@ components:
             A list of active members of the conference. Omitted if this
 
             is a response to the [Get Conferences
-            endpoint](/apis/voice#tag/Conferences/operation/listConferences)
+            endpoint](/apis/voice#tag/Conferences/operation/listConferences).
     updateConference:
       type: object
       properties:
@@ -2622,8 +2669,8 @@ components:
             event which will provide new BXML. Not allowed if `state` is
             `completed`,
 
-            but required if `state` is `active`
-          example: https://myServer.com/bandwidth/webhooks/conferenceRedirect
+            but required if `state` is `active`.
+          example: https://myServer.example/bandwidth/webhooks/conferenceRedirect
         redirectMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         username:
@@ -2649,7 +2696,8 @@ components:
             respond.  Not
 
             allowed if `state` is `completed`.
-          example: https://myFallbackServer.com/bandwidth/webhooks/conferenceRedirect
+          example: >-
+            https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect
         redirectFallbackMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         fallbackUsername:
@@ -2892,7 +2940,7 @@ components:
           type: string
           format: uri
           maxLength: 2048
-          example: https://myServer.com/bandwidth/webhooks/machineDetectionComplete
+          example: https://myServer.example/bandwidth/webhooks/machineDetectionComplete
         callbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
@@ -2920,7 +2968,7 @@ components:
             to respond
           maxLength: 2048
           example: >-
-            https://myFallbackServer.com/bandwidth/webhooks/machineDetectionComplete
+            https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete
         fallbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         fallbackUsername:
@@ -2952,7 +3000,7 @@ components:
             and
 
             password fields for authorization.
-          example: https://myServer.com/bandwidth/webhooks/transcriptionAvailable
+          example: https://myServer.example/bandwidth/webhooks/transcriptionAvailable
         callbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
@@ -2984,6 +3032,16 @@ components:
 
             between 1 and 25.
           example: 5.5
+        detectLanguage:
+          type: boolean
+          nullable: true
+          description: >-
+            A boolean value to indicate that the recording may not be in
+            English, and the transcription service will need to detect the
+            dominant language the recording is in and transcribe accordingly.
+            Current supported languages are English, French, and Spanish.
+          default: false
+          example: true
     transcriptionList:
       type: object
       properties:
@@ -3807,10 +3865,12 @@ components:
       example: bridgeComplete
     eventTime:
       type: string
+      format: date-time
       description: >-
         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.
+      example: '2022-06-17T22:19:40.375Z'
     accountId:
       type: string
       description: The user account associated with the call.
@@ -3972,7 +4032,7 @@ components:
       example: 4642074b-7b58-478b-96e4-3a60955c6765
       nullable: true
     machineDetectionResult:
-      type: string
+      type: object
       description: >-
         (optional) if machine detection was requested in sync mode, the result
         will be specified here. Possible values are the same as the async
@@ -4546,7 +4606,7 @@ components:
       description: Too Many Requests
       headers:
         Retry-After:
-          description: When you should try your request again
+          description: When you should try your request again.
           schema:
             type: string
       content:
@@ -4863,6 +4923,14 @@ components:
       example: 2022-09-14T18:20:16.000Z
       schema:
         type: string
+    campaignId:
+      in: query
+      name: campaignId
+      required: false
+      description: The campaign ID of the message.
+      example: CJEUMDK
+      schema:
+        type: string
     sort:
       in: query
       name: sort
@@ -4891,21 +4959,26 @@ components:
       schema:
         type: integer
       example: 50
-    accountId1:
-      name: accountId
-      in: path
-      required: true
+    limitTotalCount:
+      in: query
+      name: limitTotalCount
+      required: false
+      description: >-
+        When set to true, the response's totalCount field will have a maximum
+        value of 10,000. When set to false, or excluded, this will give an
+        accurate totalCount of all messages that match the provided filters. If
+        you are experiencing latency, try using this parameter to limit your
+        results.
+      example: true
       schema:
-        type: string
-      description: Your Bandwidth Account ID
-      example: '9900000'
+        type: boolean
     callId:
       name: callId
       in: path
       required: true
       schema:
         type: string
-      description: Programmable Voice API Call ID
+      description: Programmable Voice API Call ID.
       example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
     recordingId:
       name: recordingId
@@ -4913,7 +4986,7 @@ components:
       required: true
       schema:
         type: string
-      description: Programmable Voice API Recording ID
+      description: Programmable Voice API Recording ID.
       example: r-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
     conferenceId:
       name: conferenceId
@@ -4921,7 +4994,7 @@ components:
       required: true
       schema:
         type: string
-      description: Programmable Voice API Conference ID
+      description: Programmable Voice API Conference ID.
       example: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
     memberId:
       name: memberId
@@ -4929,7 +5002,7 @@ components:
       required: true
       schema:
         type: string
-      description: Programmable Voice API Conference Member ID
+      description: Programmable Voice API Conference Member ID.
       example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
     to:
       name: to
@@ -5017,23 +5090,6 @@ components:
         Not intended for explicit use. To use pagination, follow the links in
         the `Link` header of the response, as indicated in the endpoint
         description.
-    accountId2:
-      name: accountId
-      description: Bandwidth Account ID with Voice service enabled.
-      in: path
-      required: true
-      style: simple
-      explode: false
-      schema:
-        type: string
-    accountId3:
-      name: accountId
-      in: path
-      required: true
-      schema:
-        type: string
-      description: The ID of the Bandwidth account that the user belongs to.
-      example: '9900000'
     requestId:
       name: requestId
       in: path
@@ -5264,7 +5320,7 @@ components:
               value: |-
                 <?xml version=\"1.0\" encoding=\"UTF-8\"?>
                 <Bxml>
-                  <Redirect redirectUrl="https://test.com" redirectMethod="GET"/>
+                  <Redirect redirectUrl="https://test.example" redirectMethod="GET"/>
                 </Bxml>
     updateCallRecordingRequest:
       required: true
@@ -5388,10 +5444,10 @@ components:
         callbackTimeout: 15
         tag: My custom tag value
         answerMethod: POST
-        answerUrl: https://myServer.com/bandwidth/webhooks/answer
+        answerUrl: https://myServer.example/bandwidth/webhooks/answer
         answerFallbackMethod: POST
         disconnectMethod: POST
-        disconnectUrl: https://myServer.com/bandwidth/webhooks/disconnect
+        disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect
         username: mySecretUsername
         password: '*****'
         fallbackUsername: mySecretUsername
@@ -5404,54 +5460,54 @@ components:
           name: my-conference-name
           createdTime: '2022-06-17T22:19:40.375Z'
           completedTime: '2022-06-17T22:20:00.000Z'
-          conferenceEventUrl: https://myServer.com/bandwidth/webhooks/conferenceEvent
+          conferenceEventUrl: https://myServer.example/bandwidth/webhooks/conferenceEvent
           conferenceEventMethod: POST
           tag: my custom tag
     voiceBadRequestErrorExample:
       summary: Example of a Bad Request (400) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceUnauthorizedErrorExample:
       summary: Example of an Unauthorized (401) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceForbiddenErrorExample:
       summary: Example of a Forbidden (403) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceNotFoundErrorExample:
       summary: Example of a Not Found (404) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceNotAllowedErrorExample:
       summary: Example of a Not Allowed (405) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceConflictErrorExample:
       summary: Example of a Conflict (409) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceUnsupportedMediaTypeErrorExample:
       summary: Example of an Unsupported Media Type (415) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceTooManyRequestsErrorExample:
       summary: Example of a Too Many Requests (429) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     voiceInternalServerErrorExample:
       summary: Example of an Internal Server (500) Error
       value:
         type: validation
-        description: 'Invalid answerUrl: only http and https are allowed'
+        description: 'Invalid answerUrl: only http and https are allowed.'
     singleNumberRequestExample:
       summary: Example Number Lookup Request for One Number
       value: