bandwidth-sdk 14.1.2 → 15.0.0

data/bandwidth.yml

@@ -12,6 +12,7 @@ security:
 tags:
   - name: Messages
   - name: Media
+  - name: Multi-Channel
   - name: Calls
   - name: Conferences
   - name: Recordings
@@ -234,6 +235,43 @@ paths:
         statusCallback:
           $ref: '#/components/callbacks/statusCallback'
     servers: *ref_0
+  /users/{accountId}/messages/multiChannel:
+    post:
+      summary: Create Multi-Channel Message
+      description: Endpoint for sending Multi-Channel messages.
+      operationId: createMultiChannelMessage
+      parameters:
+        - $ref: '#/components/parameters/accountId'
+      tags:
+        - Multi-Channel
+      requestBody:
+        $ref: '#/components/requestBodies/createMultiChannelMessageRequest'
+      responses:
+        '202':
+          $ref: '#/components/responses/createMultiChannelMessageResponse'
+        '400':
+          $ref: '#/components/responses/createMessageBadRequestError'
+        '401':
+          $ref: '#/components/responses/messagingUnauthorizedError'
+        '403':
+          $ref: '#/components/responses/messagingForbiddenError'
+        '404':
+          $ref: '#/components/responses/messagingNotFoundError'
+        '406':
+          $ref: '#/components/responses/messagingNotAcceptableError'
+        '415':
+          $ref: '#/components/responses/messagingInvalidMediaTypeError'
+        '429':
+          $ref: '#/components/responses/messagingTooManyRequestsError'
+        '500':
+          $ref: '#/components/responses/messagingInternalServerError'
+      callbacks:
+        multiChannelCallback:
+          $ref: '#/components/callbacks/multiChannelMessageCallback'
+      x-badges:
+        - name: Beta
+          color: '#076EA8'
+    servers: *ref_0
   /accounts/{accountId}/calls:
     post:
       tags:
@@ -1595,6 +1633,12 @@ paths:
     servers: *ref_4
 components:
   schemas:
+    applicationId:
+      type: string
+      description: >-
+        The ID of the Application your from number or senderId is associated
+        with in the Bandwidth Phone Number Dashboard.
+      example: 93de2206-9669-4e07-948d-329f4b722ee2
     callbackTypeEnum:
       type: string
       enum:
@@ -1612,10 +1656,7 @@ components:
       example: message-delivered
     priorityEnum:
       type: string
-      description: |-
-        The priority specified by the user.
-
-        Not supported on MMS.
+      description: The priority specified by the user.
       enum:
         - default
         - high
@@ -1641,12 +1682,14 @@ components:
       enum:
         - INBOUND
         - OUTBOUND
+      example: INBOUND
     messageDirectionEnum:
       type: string
       description: The direction of the message. One of in out.
       enum:
         - in
         - out
+      example: in
     messageTypeEnum:
       type: string
       description: The type of message. Either SMS or MMS.
@@ -1806,6 +1849,10 @@ components:
       required:
         - type
         - description
+    messageId:
+      type: string
+      description: The ID of the message.
+      example: 1589228074636lm4k2je7j7jklbn2
     media:
       title: Media
       type: object
@@ -1818,12 +1865,11 @@ components:
           type: string
     tag:
       title: Tag
-      type: object
-      properties:
-        key:
-          type: string
-        value:
-          type: string
+      type: string
+      description: >-
+        A custom string that will be included in callback events of the message.
+        Max 1024 characters.
+      example: custom string
     deferredResult:
       title: DeferredResult
       type: object
@@ -1832,6 +1878,15 @@ components:
           type: object
         setOrExpired:
           type: boolean
+    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. Must be a date-time
+        in the future.
+      example: '2021-02-01T11:29:18-05:00'
     message:
       title: Message
       type: object
@@ -1896,10 +1951,7 @@ components:
         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'
+          $ref: '#/components/schemas/expiration'
     messageRequest:
       title: MessageRequest
       type: object
@@ -1935,44 +1987,489 @@ components:
             plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must
             contain at least one letter.
           example: '+15551113333'
+        text:
+          $ref: '#/components/schemas/messageText'
+        media:
+          $ref: '#/components/schemas/messageMedia'
+        tag:
+          $ref: '#/components/schemas/tag'
+        priority:
+          $ref: '#/components/schemas/priorityEnum'
+        expiration:
+          $ref: '#/components/schemas/expiration'
+    messageText:
+      type: string
+      description: The contents of the text message. Must be 2048 characters or less.
+      maxLength: 2048
+      example: Hello world
+    messageMedia:
+      type: array
+      items:
+        type: string
+        format: uri
+        maxLength: 4096
+      description: |-
+        A list of URLs to include as media attachments as part of the message.
+        Each URL can be at most 4096 characters.
+      example:
+        - https://dev.bandwidth.com/images/bandwidth-logo.png
+        - https://dev.bandwidth.com/images/github_logo.png
+    createMultiChannelMessageResponse:
+      type: object
+      properties:
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/link'
+        data:
+          $ref: '#/components/schemas/multiChannelMessageData'
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/errorObject'
+    multiChannelMessageChannelEnum:
+      description: The channel of the multi-channel message.
+      type: string
+      enum:
+        - RBM
+        - SMS
+        - MMS
+      example: RBM
+    multiChannelMessageDirectionEnum:
+      type: string
+      enum:
+        - INBOUND
+        - OUTBOUND
+      example: OUTBOUND
+    multiChannelSenderId:
+      type: string
+      description: The sender ID of the message. This could be an alphanumeric sender ID.
+      example: BandwidthRBM
+    multiChannelDestination:
+      type: string
+      description: The phone number the message should be sent to in E164 format.
+      example: '+15552223333'
+    rbmMessageContentText:
+      title: RBM Text
+      type: object
+      properties:
         text:
           type: string
-          description: The contents of the text message. Must be 2048 characters or less.
-          maxLength: 2048
+          description: >-
+            The text associated with the message. Must be 3270 characters or
+            less
+          maxLength: 3270
           example: Hello world
+        suggestions:
+          $ref: '#/components/schemas/multiChannelFullActions'
+      required:
+        - text
+    rbmMediaHeightEnum:
+      type: string
+      description: The height of the media.
+      enum:
+        - SHORT
+        - MEDIUM
+        - TALL
+      example: SHORT
+    rbmMessageContentFile:
+      title: RBM Rich Media File
+      type: object
+      properties:
+        fileUrl:
+          type: string
+          format: uri
+          description: The URL of the media file. 100MB is the maximum file size.
+          example: https://dev.bandwidth.com/images/bandwidth-logo.png
+          maxLength: 1000
+        thumbnailUrl:
+          type: string
+          format: uri
+          description: The URL of the thumbnail image. Applies only to video file media.
+          example: https://dev.bandwidth.com/images/bandwidth-logo.png
+          maxLength: 1000
+      required:
+        - fileUrl
+    rbmMessageMedia:
+      title: RBM Media
+      type: object
+      properties:
         media:
+          $ref: '#/components/schemas/rbmMessageContentFile'
+        suggestions:
+          $ref: '#/components/schemas/multiChannelFullActions'
+      required:
+        - media
+    rbmCardContent:
+      type: object
+      properties:
+        title:
+          type: string
+          description: The title of the card. Must be 200 characters or less.
+          maxLength: 200
+          example: Bandwidth
+        description:
+          type: string
+          description: The description of the card. Must be 2000 characters or less.
+          maxLength: 2000
+          example: Bandwidth is a communications platform as a service (CPaaS) company.
+        media:
+          allOf:
+            - $ref: '#/components/schemas/rbmMessageContentFile'
+            - type: object
+              properties:
+                height:
+                  $ref: '#/components/schemas/rbmMediaHeightEnum'
+          required:
+            - height
+        suggestions:
+          description: >-
+            An array of suggested actions for the recipient that will be
+            displayed on the rich card.
           type: array
           items:
-            type: string
-            format: uri
-            maxLength: 4096
+            $ref: '#/components/schemas/multiChannelAction'
+          maxItems: 4
+    rbmStandaloneCard:
+      title: Standalone Card
+      type: object
+      properties:
+        orientation:
+          $ref: '#/components/schemas/standaloneCardOrientationEnum'
+        thumbnailImageAlignment:
+          $ref: '#/components/schemas/thumbnailAlignmentEnum'
+        cardContent:
+          $ref: '#/components/schemas/rbmCardContent'
+        suggestions:
+          $ref: '#/components/schemas/multiChannelFullActions'
+      required:
+        - orientation
+        - thumbnailImageAlignment
+        - cardContent
+    standaloneCardOrientationEnum:
+      type: string
+      enum:
+        - HORIZONTAL
+        - VERTICAL
+      example: VERTICAL
+    thumbnailAlignmentEnum:
+      type: string
+      description: >-
+        The alignment of the thumbnail image in the card. Only applicable if the
+        card using horizontal orientation.
+      enum:
+        - LEFT
+        - RIGHT
+      example: LEFT
+    rbmMessageCarouselCard:
+      title: Carousel
+      type: object
+      properties:
+        cardWidth:
+          $ref: '#/components/schemas/cardWidthEnum'
+        cardContents:
+          type: array
+          items:
+            $ref: '#/components/schemas/rbmCardContent'
+          maxItems: 10
+        suggestions:
+          $ref: '#/components/schemas/multiChannelFullActions'
+      required:
+        - cardContents
+        - cardWidth
+    cardWidthEnum:
+      type: string
+      enum:
+        - SMALL
+        - MEDIUM
+      example: SMALL
+    smsMessageContent:
+      title: SMS Text
+      type: object
+      properties:
+        text:
+          $ref: '#/components/schemas/messageText'
+      required:
+        - text
+    mmsMessageContent:
+      title: MMS Message
+      type: object
+      properties:
+        text:
+          $ref: '#/components/schemas/messageText'
+        media:
+          $ref: '#/components/schemas/messageMedia'
+    rbmMessageContentRichCard:
+      title: RBM Rich Card
+      oneOf:
+        - $ref: '#/components/schemas/rbmStandaloneCard'
+        - $ref: '#/components/schemas/rbmMessageCarouselCard'
+    rbmActionTypeEnum:
+      type: string
+      enum:
+        - REPLY
+        - DIAL_PHONE
+        - SHOW_LOCATION
+        - CREATE_CALENDAR_EVENT
+        - OPEN_URL
+        - REQUEST_LOCATION
+      example: REPLY
+    rbmActionText:
+      title: Text
+      type: string
+      description: Displayed text for user to click
+      maxLength: 25
+      example: Hello world
+    rbmActionPostBackData:
+      title: Post Back Data
+      type: string
+      format: byte
+      description: Base64 payload the customer receives when the reply is clicked.
+      maxLength: 2048
+      example: SGVsbG8gd29ybGQ=
+    rbmActionBase:
+      type: object
+      properties:
+        type:
+          $ref: '#/components/schemas/rbmActionTypeEnum'
+        text:
+          $ref: '#/components/schemas/rbmActionText'
+        postBackData:
+          $ref: '#/components/schemas/rbmActionPostBackData'
+      required:
+        - text
+        - postBackData
+        - type
+    rbmActionDial:
+      allOf:
+        - $ref: '#/components/schemas/rbmActionBase'
+        - title: Dial Phone
+          type: object
+          properties:
+            phoneNumber:
+              type: string
+              description: The phone number to dial. Must be E164 format.
+              example: '+15552223333'
+          required:
+            - phoneNumber
+    rbmActionViewLocation:
+      allOf:
+        - $ref: '#/components/schemas/rbmActionBase'
+        - title: Show Location
+          type: object
+          properties:
+            latitude:
+              type: string
+              format: double
+              description: The latitude of the location.
+              example: '37.7749'
+            longitude:
+              type: string
+              format: double
+              description: The longitude of the location.
+              example: '-122.4194'
+            label:
+              type: string
+              description: The label of the location.
+              example: San Francisco
+              maxLength: 100
+          required:
+            - latitude
+            - longitude
+    multiChannelActionCalendarEvent:
+      allOf:
+        - $ref: '#/components/schemas/rbmActionBase'
+        - title: Calendar Event
+          type: object
+          properties:
+            title:
+              type: string
+              description: The title of the event.
+              example: Meeting with John
+              maxLength: 100
+            startTime:
+              type: string
+              format: date-time
+              description: The start time of the event.
+              example: 2022-09-14T18:20:16.000Z
+            endTime:
+              type: string
+              format: date-time
+              description: The end time of the event.
+              example: 2022-09-14T18:20:16.000Z
+            description:
+              type: string
+              description: The description of the event.
+              example: Discuss the new project
+              maxLength: 500
+          required:
+            - title
+            - startTime
+            - endTime
+    rbmActionOpenUrl:
+      allOf:
+        - $ref: '#/components/schemas/rbmActionBase'
+        - title: Open URL
+          type: object
+          properties:
+            url:
+              type: string
+              format: uri
+              description: The URL to open in browser.
+              example: https://dev.bandwidth.com
+              maxLength: 2048
+          required:
+            - url
+    multiChannelFullActions:
+      type: array
+      description: An array of suggested actions for the recipient.
+      items:
+        $ref: '#/components/schemas/multiChannelAction'
+      maxItems: 11
+    multiChannelAction:
+      oneOf:
+        - $ref: '#/components/schemas/rbmActionBase'
+        - $ref: '#/components/schemas/rbmActionDial'
+        - $ref: '#/components/schemas/rbmActionViewLocation'
+        - $ref: '#/components/schemas/multiChannelActionCalendarEvent'
+        - $ref: '#/components/schemas/rbmActionOpenUrl'
+      discriminator:
+        propertyName: type
+        mapping:
+          REPLY: '#/components/schemas/rbmActionBase'
+          DIAL_PHONE: '#/components/schemas/rbmActionDial'
+          SHOW_LOCATION: '#/components/schemas/rbmActionViewLocation'
+          CREATE_CALENDAR_EVENT: '#/components/schemas/multiChannelActionCalendarEvent'
+          OPEN_URL: '#/components/schemas/rbmActionOpenUrl'
+          REQUEST_LOCATION: '#/components/schemas/rbmActionBase'
+    multiChannelStatusEnum:
+      type: string
+      enum:
+        - QUEUED
+        - SENDING
+        - DELIVERED
+        - FAILED
+      example: DELIVERED
+    multiChannelChannelListObject:
+      type: object
+      properties:
+        from:
+          $ref: '#/components/schemas/multiChannelSenderId'
+        applicationId:
+          $ref: '#/components/schemas/applicationId'
+        channel:
+          $ref: '#/components/schemas/multiChannelMessageChannelEnum'
+        content:
+          description: The content of the message.
+          oneOf:
+            - $ref: '#/components/schemas/rbmMessageContentText'
+            - $ref: '#/components/schemas/rbmMessageMedia'
+            - $ref: '#/components/schemas/rbmMessageContentRichCard'
+            - $ref: '#/components/schemas/smsMessageContent'
+            - $ref: '#/components/schemas/mmsMessageContent'
+      required:
+        - from
+        - applicationId
+        - channel
+        - content
+    multiChannelMessageRequest:
+      description: Multi-Channel Message Request
+      type: object
+      properties:
+        to:
+          $ref: '#/components/schemas/multiChannelDestination'
+        channelList:
+          type: array
           description: >-
-            A list of URLs to include as media attachments as part of the
-            message.
-
-            Each URL can be at most 4096 characters.
-          example:
-            - https://dev.bandwidth.com/images/bandwidth-logo.png
-            - https://dev.bandwidth.com/images/github_logo.png
+            A list of message bodies. The messages will be attempted in the
+            order they are listed. Once a message sends successfully, the others
+            will be ignored.
+          items:
+            $ref: '#/components/schemas/multiChannelChannelListObject'
+          maxItems: 4
         tag:
-          type: string
-          description: >-
-            A custom string that will be included in callback events of the
-            message. Max 1024 characters.
-          example: custom string
+          $ref: '#/components/schemas/tag'
         priority:
           $ref: '#/components/schemas/priorityEnum'
         expiration:
+          $ref: '#/components/schemas/expiration'
+      required:
+        - to
+        - channelList
+    multiChannelMessageCallbackData:
+      type: object
+      properties:
+        messageId:
+          $ref: '#/components/schemas/messageId'
+        status:
+          $ref: '#/components/schemas/multiChannelStatusEnum'
+        direction:
+          $ref: '#/components/schemas/multiChannelMessageDirectionEnum'
+        from:
+          $ref: '#/components/schemas/multiChannelSenderId'
+        to:
+          $ref: '#/components/schemas/multiChannelDestination'
+        applicationId:
+          $ref: '#/components/schemas/applicationId'
+        channel:
+          $ref: '#/components/schemas/multiChannelMessageChannelEnum'
+        tag:
+          $ref: '#/components/schemas/tag'
+    multiChannelMessageData:
+      type: object
+      properties:
+        messageId:
+          $ref: '#/components/schemas/messageId'
+        status:
+          $ref: '#/components/schemas/multiChannelStatusEnum'
+        time:
+          description: The time the message was received by the Bandwidth API.
           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. Must be a
-            date-time in the future.
-
-            Not supported on MMS.
-          example: '2021-02-01T11:29:18-05:00'
+          example: 2025-01-01T18:20:16.000Z
+        direction:
+          $ref: '#/components/schemas/multiChannelMessageDirectionEnum'
+        from:
+          $ref: '#/components/schemas/multiChannelSenderId'
+        to:
+          $ref: '#/components/schemas/multiChannelDestination'
+        applicationId:
+          $ref: '#/components/schemas/applicationId'
+        channel:
+          $ref: '#/components/schemas/multiChannelMessageChannelEnum'
+        tag:
+          $ref: '#/components/schemas/tag'
+    multiChannelCallbackData:
+      type: object
+      properties:
+        time:
+          description: The time of the callback event.
+          type: string
+          format: date-time
+          example: 2025-01-01T18:20:16.000Z
+        type:
+          $ref: '#/components/schemas/multiChannelStatusEnum'
+        to:
+          $ref: '#/components/schemas/multiChannelDestination'
+        description:
+          type: string
+          example: Incoming message received
+        message:
+          $ref: '#/components/schemas/multiChannelMessageCallbackData'
+    link:
+      type: object
+      properties:
+        rel:
+          type: string
+        href:
+          type: string
+    errorObject:
+      type: object
+      properties:
+        code:
+          type: string
+        message:
+          type: string
     messageCallback:
       description: Message Callback Schema
       type: object
@@ -1997,6 +2494,14 @@ components:
           description: Optional error code, applicable only when type is `message-failed`.
           nullable: true
           example: 4405
+        carrierName:
+          type: string
+          description: >-
+            The name of the Authorized Message Provider (AMP) that handled this
+            message. In the US, this is the carrier that the message was sent
+            to.
+          nullable: true
+          example: AT&T
       required:
         - time
         - type
@@ -2794,7 +3299,7 @@ components:
       type: object
       properties:
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         accountId:
           $ref: '#/components/schemas/accountId'
         callId:
@@ -3402,7 +3907,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3439,7 +3944,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3479,7 +3984,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3660,7 +4165,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3700,7 +4205,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3740,7 +4245,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3784,7 +4289,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3818,7 +4323,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3854,7 +4359,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3904,7 +4409,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3954,7 +4459,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -3992,7 +4497,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -4045,7 +4550,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -4084,7 +4589,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -4130,7 +4635,7 @@ components:
         accountId:
           $ref: '#/components/schemas/accountId'
         applicationId:
-          $ref: '#/components/schemas/applicationId'
+          $ref: '#/components/schemas/applicationId1'
         from:
           $ref: '#/components/schemas/from'
         to:
@@ -4186,7 +4691,7 @@ components:
       type: string
       description: The user account associated with the call.
       example: '9900000'
-    applicationId:
+    applicationId1:
       type: string
       description: The id of the application associated with the call.
       example: 04e88489-df02-4e34-a0ee-27a91849555f
@@ -4731,6 +5236,35 @@ components:
         PUT.
       example: true
       type: boolean
+    blocked:
+      description: >-
+        Whether a Toll-Free Verification is blocked. This attribute will only be
+        defined when the number is blocked. (Not Available Until 5/28/2025)
+      example: true
+      type: boolean
+    blockedReason:
+      description: >-
+        The reason why the Toll-Free Verification is blocked. This attribute
+        will only be defined when the number is blocked. (Not Available Until
+        5/28/2025)
+      example: Toll-free number was used to send spam messages
+      type: string
+    privacyPolicyUrl:
+      description: >-
+        The Toll-Free Verification request privacy policy URL. (Not Available
+        Until 5/28/2025)
+      example: http://your-company.com/privacyPolicyUrl.pdf
+      type: string
+    termsAndConditionsUrl:
+      description: >-
+        The Toll-Free Verification request terms and conditions policy URL. (Not
+        Available Until 5/28/2025)
+      example: http://your-company.com/termsAndConditionsUrl.pdf
+      type: string
+    businessDBA:
+      description: The company 'Doing Business As'. (Not Available Until 5/28/2025)
+      example: SecondCompany Name
+      type: string
     additionalDenialReason:
       properties:
         statusCode:
@@ -4797,17 +5331,9 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 1
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 1
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
@@ -4816,8 +5342,15 @@ components:
           minLength: 0
           maxLength: 500
           nullable: true
+          example: Any additional information
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     verificationUpdateRequest:
       type: object
       required:
@@ -4842,36 +5375,32 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 0
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 0
-          maxLength: 500
-          nullable: false
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
-          type: string
-          description: Any additional information.
-          minLength: 0
-          maxLength: 500
-          nullable: true
+          $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     tfvBasicAuthentication:
       type: object
       properties:
         username:
           type: string
           maxLength: 100
+          example: username
         password:
           type: string
           maxLength: 200
+          example: password
       required:
         - username
         - password
@@ -4939,6 +5468,10 @@ components:
           $ref: '#/components/schemas/resubmitAllowed'
         status:
           $ref: '#/components/schemas/tfvUnverifiedStatus'
+        blocked:
+          $ref: '#/components/schemas/blocked'
+        blockedReason:
+          $ref: '#/components/schemas/blockedReason'
     verificationWebhook:
       type: object
       properties:
@@ -4986,6 +5519,7 @@ components:
           minLength: 0
           maxLength: 500
           nullable: true
+          example: 2230 Bandmate Way
         city:
           type: string
           description: The city of the business using the toll-free number.
@@ -5014,6 +5548,13 @@ components:
           maxLength: 500
           nullable: false
           example: https://www.example.com/path/to/resource
+    additionalInformation:
+      type: string
+      description: Any additional information.
+      minLength: 0
+      maxLength: 500
+      nullable: true
+      example: Any additional information
     optInWorkflow:
       type: object
       nullable: false
@@ -5101,6 +5642,20 @@ components:
       minLength: 0
       maxLength: 500
       example: 2FA
+    useCaseSummary:
+      type: string
+      description: A general idea of the use case and customer.
+      minLength: 0
+      maxLength: 500
+      nullable: false
+      example: Text summarizing the use case for the toll-free number
+    productionMessageContent:
+      type: string
+      description: Example of message content.
+      minLength: 0
+      maxLength: 500
+      nullable: false
+      example: Production message content
     webhookSubscriptionsListBody:
       description: >-
         A list of all webhook subscriptions registered for this account ID for
@@ -5261,6 +5816,10 @@ components:
           example: '2021-06-08T06:45:13.0Z'
         submission:
           $ref: '#/components/schemas/tfvSubmissionInfo'
+        blocked:
+          $ref: '#/components/schemas/blocked'
+        blockedReason:
+          $ref: '#/components/schemas/blockedReason'
     tfvSubmissionInfo:
       type: object
       properties:
@@ -5277,38 +5836,27 @@ components:
         useCase:
           $ref: '#/components/schemas/useCase'
         useCaseSummary:
-          type: string
-          description: A general idea of the use case and customer.
-          minLength: 0
-          maxLength: 500
-          nullable: false
-          example: Text summarizing the use case for the toll-free number
+          $ref: '#/components/schemas/useCaseSummary'
         productionMessageContent:
-          type: string
-          description: Example of message content.
-          minLength: 0
-          maxLength: 500
-          nullable: false
-          example: Production message content
+          $ref: '#/components/schemas/productionMessageContent'
         optInWorkflow:
           $ref: '#/components/schemas/optInWorkflow'
         additionalInformation:
-          type: string
-          description: Any additional information.
-          minLength: 0
-          maxLength: 500
-          nullable: true
-          example: Any additional information
+          $ref: '#/components/schemas/additionalInformation'
         isvReseller:
           $ref: '#/components/schemas/isvReseller'
+        privacyPolicyUrl:
+          $ref: '#/components/schemas/privacyPolicyUrl'
+        termsAndConditionsUrl:
+          $ref: '#/components/schemas/termsAndConditionsUrl'
+        businessDBA:
+          $ref: '#/components/schemas/businessDBA'
     tfvStatusEnum:
       type: string
       enum:
         - VERIFIED
         - UNVERIFIED
         - PENDING
-        - PARTIALLY_VERIFIED
-        - INVALID_STATUS
       example: VERIFIED
     sharedSecretKey:
       description: >-
@@ -5327,6 +5875,12 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/message'
+    createMultiChannelMessageResponse:
+      description: Accepted
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/createMultiChannelMessageResponse'
     listMessagesResponse:
       description: OK
       content:
@@ -6235,6 +6789,7 @@ 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.
+      example: eyJwYWdlVG9rZW4iOiJ0b2tlbiJ9
     disconnectCause:
       name: disconnectCause
       in: query
@@ -6585,6 +7140,12 @@ components:
           schema:
             $ref: '#/components/schemas/messageRequest'
       required: true
+    createMultiChannelMessageRequest:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/multiChannelMessageRequest'
+      required: true
     uploadMediaRequest:
       content:
         application/json:
@@ -6986,6 +7547,19 @@ components:
           responses:
             '200':
               description: OK
+    multiChannelMessageCallback:
+      '{multiChannelMessageCallbackUrl}':
+        post:
+          requestBody:
+            required: true
+            description: Status Callback Payload
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/multiChannelCallbackData'
+          responses:
+            '204':
+              description: No Content
     tfVerificationStatus:
       your_url.com/webhookService:
         post: