bandwidth-sdk 13.1.4 → 14.0.0

data/bandwidth.yml

@@ -230,8 +230,6 @@ paths:
         '500':
           $ref: '#/components/responses/messagingInternalServerError'
       callbacks:
-        inboundCallback:
-          $ref: '#/components/callbacks/inboundCallback'
         statusCallback:
           $ref: '#/components/callbacks/statusCallback'
     servers: *ref_0
@@ -1332,6 +1330,21 @@ paths:
     servers: *ref_3
 components:
   schemas:
+    callbackTypeEnum:
+      type: string
+      enum:
+        - message-received
+        - message-sending
+        - message-delivered
+        - message-failed
+      description: >
+        Indicates the type of the callback:
+
+        - `message-received` for inbound callbacks.
+
+        - One of `message-sending`, `message-delivered`, `message-failed` for
+        status callbacks.
+      example: message-delivered
     priorityEnum:
       type: string
       description: |-
@@ -1574,7 +1587,7 @@ components:
           type: string
           format: date-time
           description: The datetime stamp of the message in ISO 8601
-          example: 2022-09-14T18:20:16.000Z
+          example: 2024-12-02T20:15:57.278Z
         segmentCount:
           type: integer
           description: >-
@@ -1695,288 +1708,38 @@ components:
 
             Not supported on MMS.
           example: '2021-02-01T11:29:18-05:00'
-    inboundMessageCallback:
-      description: Inbound Message Callback
-      type: object
-      properties:
-        time:
-          type: string
-          format: date-time
-          example: 2016-09-14T18:20:16.000Z
-        type:
-          type: string
-          example: message-received
-        to:
-          type: string
-          example: '+15552223333'
-        description:
-          type: string
-          example: Incoming message received
-        message:
-          $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
-      properties:
-        time:
-          type: string
-          format: date-time
-          example: 2016-09-14T18:20:16.000Z
-        type:
-          type: string
-          example: message-sending
-        to:
-          type: string
-          example: '+15552223333'
-        description:
-          type: string
-          example: Message is sending to carrier
-        message:
-          $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
-    messageDeliveredCallback:
-      description: Message Delivered Callback
-      type: object
-      properties:
-        time:
-          type: string
-          format: date-time
-          example: 2016-09-14T18:20:16.000Z
-        type:
-          type: string
-          example: message-delivered
-        to:
-          type: string
-          example: '+15552223333'
-        description:
-          type: string
-          example: Message delivered to carrier.
-        message:
-          $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
+    messageCallback:
+      description: Message Callback Schema
       type: object
       properties:
         time:
           type: string
           format: date-time
-          example: 2016-09-14T18:20:16.000Z
+          example: 2024-12-02T20:15:57.278Z
         type:
-          type: string
-          example: message-failed
+          $ref: '#/components/schemas/callbackTypeEnum'
         to:
           type: string
           example: '+15552223333'
         description:
           type: string
+          description: A detailed description of the event described by the callback.
           example: rejected-unallocated-from-number
         message:
-          $ref: '#/components/schemas/messageFailedCallbackMessage'
+          $ref: '#/components/schemas/messageCallbackMessage'
         errorCode:
           type: integer
-          example: 9902
+          description: Optional error code, applicable only when type is `message-failed`.
+          nullable: true
+          example: 4405
       required:
         - time
         - type
         - to
         - description
         - message
-        - errorCode
-    messageFailedCallbackMessage:
-      description: Message Failed Callback Message Schema
+    messageCallbackMessage:
+      description: Message payload schema within a MessageCallback
       type: object
       properties:
         id:
@@ -1991,7 +1754,7 @@ components:
         time:
           type: string
           format: date-time
-          example: 2016-09-14T18:20:16.000Z
+          example: 2024-12-02T20:15:57.666Z
         segmentCount:
           type: integer
           example: 1
@@ -2015,6 +1778,8 @@ components:
           example: custom string
         media:
           type: array
+          description: Optional media, applicable only for mms
+          nullable: true
           items:
             type: string
             format: uri
@@ -2033,7 +1798,6 @@ components:
         - to
         - from
         - text
-        - tag
     callbackMethodEnum:
       type: string
       nullable: true
@@ -5463,34 +5227,345 @@ components:
         type: string
       description: The phone number lookup request ID from Bandwidth.
       example: 004223a0-8b17-41b1-bf81-20732adf5590
-  requestBodies:
-    createMessageRequest:
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/messageRequest'
-      required: true
-    uploadMediaRequest:
-      content:
-        application/json:
-          schema:
-            type: string
-            format: binary
-        application/ogg:
-          schema:
-            type: string
-            format: binary
-        application/pdf:
-          schema:
-            type: string
-            format: binary
-        application/rtf:
-          schema:
-            type: string
-            format: binary
-        application/zip:
-          schema:
-            type: string
+  examples:
+    smsMessageReceivedCallbackExample:
+      summary: An example of a sms message-received callback body.
+      value:
+        time: '2025-01-06T15:43:35.502180Z'
+        type: message-received
+        to: '+12345678902'
+        description: Incoming message received
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          owner: '+12345678902'
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          time: '2025-01-06T15:43:34.000000Z'
+          segmentCount: 1
+          direction: in
+          to:
+            - '+12345678902'
+          from: '+12345678901'
+          text: Hey, check out this SMS!
+    mmsMessageReceivedCallbackExample:
+      summary: An example of a mms message-received callback body.
+      value:
+        time: '2024-09-14T18:20:45.160744Z'
+        type: message-received
+        to: '+12345678902'
+        description: Incoming message received
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          owner: '+12345678902'
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          time: '2024-09-14T18:20:45.160744Z'
+          segmentCount: 1
+          direction: in
+          to:
+            - '+12345678902'
+            - '+12345678903'
+          from: '+12345678901'
+          text: Hey, check out the MMS!
+          media:
+            - >-
+              https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png
+    messageSendingCallbackExample:
+      summary: An example of a message-sending callback body.
+      value:
+        time: '2024-06-25T18:42:36.979456Z'
+        type: message-sending
+        to: '+15554443333'
+        description: Message is sending to carrier.
+        message:
+          id: 1593110555875xo7watq5px6rbe5d
+          owner: '+15552221111'
+          applicationId: cfd4fb83-7531-4acc-b471-42d0bb76a65c
+          time: '2024-06-25T18:42:35.876906Z'
+          segmentCount: 1
+          direction: out
+          to:
+            - '+15554443333'
+          from: '+15552221111'
+          text: ''
+          media:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+          tag: your tag here
+    smsMessageDeliveredCallbackExample:
+      summary: An example of a sms message-delivered callback body.
+      value:
+        type: message-delivered
+        time: '2024-09-14T18:20:11.160744Z'
+        description: Message delivered to carrier.
+        to: '+12345678902'
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          time: '2024-09-14T18:20:11.160744Z'
+          to:
+            - '+12345678902'
+          from: '+12345678901'
+          text: ''
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          owner: '+12345678902'
+          direction: out
+          segmentCount: 1
+    mmsMessageDeliveredCallbackExample:
+      summary: An example of a mms message-delivered callback body.
+      value:
+        type: message-delivered
+        time: '2024-09-14T18:20:24.160544Z'
+        description: Message delivered to carrier.
+        to: '+12345678902'
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          time: '2024-09-14T18:20:24.160544Z'
+          to:
+            - '+12345678902'
+          from: '+12345678901'
+          text: ''
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          owner: '+12345678902'
+          direction: out
+          segmentCount: 1
+          media:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+    groupMmsMessageDeliveredCallbackExample:
+      summary: An example of a group mms message-delivered callback body.
+      value:
+        type: message-delivered
+        time: '2024-09-14T18:20:17.160544Z'
+        description: Message delivered to carrier.
+        to: '+12345678902'
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          time: '2024-09-14T18:20:17.160544Z'
+          to:
+            - '+12345678902'
+            - '+12345678903'
+          from: '+12345678901'
+          text: ''
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          owner: '+12345678902'
+          direction: out
+          segmentCount: 1
+    messageFailedCallbackExample:
+      summary: An example of a message-failed callback body.
+      value:
+        type: message-failed
+        time: '2024-12-18T16:51:27.704450Z'
+        description: forbidden to country
+        to: '+52345678903'
+        errorCode: 4432
+        message:
+          id: 14762070468292kw2fuqty55yp2b2
+          time: '2024-12-18T16:51:27.704450Z'
+          to:
+            - '+12345678902'
+            - '+52345678903'
+          from: '+12345678901'
+          text: ''
+          applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
+          media:
+            - https://dev.bandwidth.com/images/bandwidth-logo.png
+          owner: '+12345678901'
+          direction: out
+          segmentCount: 1
+    createCallResponseExample:
+      summary: Example of a createCall Response
+      value:
+        applicationId: 04e88489-df02-4e34-a0ee-27a91849555f
+        accountId: '9900000'
+        callId: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+        to: '+19195551234'
+        from: '+19195554312'
+        enqueuedTime: '2022-06-16T13:15:07.160Z'
+        callUrl: >-
+          https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+        callTimeout: 30
+        callbackTimeout: 15
+        tag: My custom tag value
+        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
+        password: '*****'
+        fallbackUsername: mySecretUsername
+        fallbackPassword: '*****'
+        priority: 5
+    listConferencesResponseExample:
+      summary: Example of a listConferences Response
+      value:
+        - id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
+          name: my-conference-name
+          createdTime: '2022-06-17T22:19:40.375Z'
+          completedTime: '2022-06-17T22:20:00.000Z'
+          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.'
+    voiceUnauthorizedErrorExample:
+      summary: Example of an Unauthorized (401) Error
+      value:
+        type: validation
+        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.'
+    voiceNotFoundErrorExample:
+      summary: Example of a Not Found (404) Error
+      value:
+        type: validation
+        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.'
+    voiceConflictErrorExample:
+      summary: Example of a Conflict (409) Error
+      value:
+        type: validation
+        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.'
+    voiceTooManyRequestsErrorExample:
+      summary: Example of a Too Many Requests (429) Error
+      value:
+        type: validation
+        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.'
+    singleNumberRequestExample:
+      summary: Example Number Lookup Request for One Number
+      value:
+        tns:
+          - '+19195551234'
+    multipleNumberRequestExample:
+      summary: Example Number Lookup Request for Multiple Numbers
+      value:
+        tns:
+          - '+19195551234'
+          - '+19195554321'
+    lookupInProgressExample:
+      summary: Example Lookup In Progress Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: IN_PROGRESS
+    lookupFailedExample:
+      summary: Example Lookup Failed Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: FAILED
+        failedTelephoneNumbers:
+          - '+191955512345'
+    lookupSingleNumberCompleteExample:
+      summary: Example Single Number Lookup Complete Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: COMPLETE
+        result:
+          - Response Code: 0
+            Message: NOERROR
+            E.164 Format: '+19195551234'
+            Formatted: (919) 555-1234
+            Country: US
+            Line Type: Mobile
+            Line Provider: Verizon Wireless
+            Mobile Country Code: '310'
+            Mobile Network Code: '010'
+    lookupMultipleNumbersCompleteExample:
+      summary: Example Multiple Numbers Lookup Complete Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: COMPLETE
+        result:
+          - Response Code: 0
+            Message: NOERROR
+            E.164 Format: '+19195551234'
+            Formatted: (919) 555-1234
+            Country: US
+            Line Type: Mobile
+            Line Provider: Verizon Wireless
+            Mobile Country Code: '310'
+            Mobile Network Code: '010'
+          - Response Code: 0
+            Message: NOERROR
+            E.164 Format: '+19195554321'
+            Formatted: (919) 555-4321
+            Country: US
+            Line Type: Mobile
+            Line Provider: T-Mobile USA
+            Mobile Country Code: '310'
+            Mobile Network Code: '160'
+    lookupMultipleNumbersPartialCompleteExample:
+      summary: Example Multiple Numbers Lookup Partial Complete Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: PARTIAL_COMPLETE
+        result:
+          - Response Code: 0
+            Message: NOERROR
+            E.164 Format: '+19195551234'
+            Formatted: (919) 555-1234
+            Country: US
+            Line Type: Mobile
+            Line Provider: Verizon Wireless
+            Mobile Country Code: '310'
+            Mobile Network Code: '010'
+        failedTelephoneNumbers:
+          - '+191955512345'
+    lookupSingleNumberCompleteNoInfoExample:
+      summary: Example Single Number Lookup Complete with No Information Response
+      value:
+        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
+        status: COMPLETE
+        result:
+          - Response Code: 3
+            Message: NXDOMAIN
+            E.164 Format: '+19195550000'
+            Formatted: (919) 555-0000
+            Country: US
+  requestBodies:
+    createMessageRequest:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/messageRequest'
+      required: true
+    uploadMediaRequest:
+      content:
+        application/json:
+          schema:
+            type: string
+            format: binary
+        application/ogg:
+          schema:
+            type: string
+            format: binary
+        application/pdf:
+          schema:
+            type: string
+            format: binary
+        application/rtf:
+          schema:
+            type: string
+            format: binary
+        application/zip:
+          schema:
+            type: string
             format: binary
         application/x-tar:
           schema:
@@ -5560,6 +5635,14 @@ components:
           schema:
             type: string
             format: binary
+        image/heic:
+          schema:
+            type: string
+            format: binary
+        image/heif:
+          schema:
+            type: string
+            format: binary
         image/jpeg:
           schema:
             type: string
@@ -5600,6 +5683,10 @@ components:
           schema:
             type: string
             format: binary
+        text/html:
+          schema:
+            type: string
+            format: binary
         text/plain:
           schema:
             type: string
@@ -5648,6 +5735,10 @@ components:
           schema:
             type: string
             format: binary
+        video/x-flv:
+          schema:
+            type: string
+            format: binary
       required: true
     createCallRequest:
       description: JSON object containing information to create an outbound call
@@ -5770,11 +5861,22 @@ components:
         post:
           requestBody:
             required: true
-            description: Inbound Message Callback Payload
+            description: >
+              <p>This Inbound Message Webhook is an envelope containing a
+              received (MO) message to your message-enabled Bandwidth telephone
+              number. The payload type will always indicate "message-received".
+
+              </p><p>Please visit <a
+              href='/docs/messaging/webhooks/'>Webhooks</a></p>
             content:
               application/json:
                 schema:
-                  $ref: '#/components/schemas/inboundMessageCallback'
+                  $ref: '#/components/schemas/messageCallback'
+                examples:
+                  smsMessageReceivedCallback:
+                    $ref: '#/components/examples/smsMessageReceivedCallbackExample'
+                  mmsMessageReceivedCallback:
+                    $ref: '#/components/examples/mmsMessageReceivedCallbackExample'
           responses:
             '200':
               description: OK
@@ -5783,186 +5885,31 @@ components:
         post:
           requestBody:
             required: true
-            description: Status Callback Payload
+            description: >
+              <p>This Outbound Message Webhook is an envelope containing status
+              information regarding a message sent (MT) from your
+              message-enabled Bandwidth telephone number. The payload type will
+              be one of "message-sending", "message-delivered", or
+              "message-failed".
+
+              </p><p>Please visit <a
+              href='/docs/messaging/webhooks/'>Webhooks</a></p>
             content:
               application/json:
                 schema:
-                  type: object
-                  oneOf:
-                    - $ref: '#/components/schemas/messageSendingCallback'
-                    - $ref: '#/components/schemas/messageDeliveredCallback'
-                    - $ref: '#/components/schemas/messageFailedCallback'
+                  $ref: '#/components/schemas/messageCallback'
+                examples:
+                  messageSendingCallback:
+                    $ref: '#/components/examples/messageSendingCallbackExample'
+                  smsMessageDeliveredCallback:
+                    $ref: '#/components/examples/smsMessageDeliveredCallbackExample'
+                  mmsMessageDeliveredCallback:
+                    $ref: '#/components/examples/mmsMessageDeliveredCallbackExample'
+                  groupMmsMessageDeliveredCallback:
+                    $ref: >-
+                      #/components/examples/groupMmsMessageDeliveredCallbackExample
+                  messageFailedCallback:
+                    $ref: '#/components/examples/messageFailedCallbackExample'
           responses:
             '200':
               description: OK
-  examples:
-    createCallResponseExample:
-      summary: Example of a createCall Response
-      value:
-        applicationId: 04e88489-df02-4e34-a0ee-27a91849555f
-        accountId: '9900000'
-        callId: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
-        to: '+19195551234'
-        from: '+19195554312'
-        enqueuedTime: '2022-06-16T13:15:07.160Z'
-        callUrl: >-
-          https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
-        callTimeout: 30
-        callbackTimeout: 15
-        tag: My custom tag value
-        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
-        password: '*****'
-        fallbackUsername: mySecretUsername
-        fallbackPassword: '*****'
-        priority: 5
-    listConferencesResponseExample:
-      summary: Example of a listConferences Response
-      value:
-        - id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9
-          name: my-conference-name
-          createdTime: '2022-06-17T22:19:40.375Z'
-          completedTime: '2022-06-17T22:20:00.000Z'
-          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.'
-    voiceUnauthorizedErrorExample:
-      summary: Example of an Unauthorized (401) Error
-      value:
-        type: validation
-        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.'
-    voiceNotFoundErrorExample:
-      summary: Example of a Not Found (404) Error
-      value:
-        type: validation
-        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.'
-    voiceConflictErrorExample:
-      summary: Example of a Conflict (409) Error
-      value:
-        type: validation
-        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.'
-    voiceTooManyRequestsErrorExample:
-      summary: Example of a Too Many Requests (429) Error
-      value:
-        type: validation
-        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.'
-    singleNumberRequestExample:
-      summary: Example Number Lookup Request for One Number
-      value:
-        tns:
-          - '+19195551234'
-    multipleNumberRequestExample:
-      summary: Example Number Lookup Request for Multiple Numbers
-      value:
-        tns:
-          - '+19195551234'
-          - '+19195554321'
-    lookupInProgressExample:
-      summary: Example Lookup In Progress Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: IN_PROGRESS
-    lookupFailedExample:
-      summary: Example Lookup Failed Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: FAILED
-        failedTelephoneNumbers:
-          - '+191955512345'
-    lookupSingleNumberCompleteExample:
-      summary: Example Single Number Lookup Complete Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-    lookupMultipleNumbersCompleteExample:
-      summary: Example Multiple Numbers Lookup Complete Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195554321'
-            Formatted: (919) 555-4321
-            Country: US
-            Line Type: Mobile
-            Line Provider: T-Mobile USA
-            Mobile Country Code: '310'
-            Mobile Network Code: '160'
-    lookupMultipleNumbersPartialCompleteExample:
-      summary: Example Multiple Numbers Lookup Partial Complete Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: PARTIAL_COMPLETE
-        result:
-          - Response Code: 0
-            Message: NOERROR
-            E.164 Format: '+19195551234'
-            Formatted: (919) 555-1234
-            Country: US
-            Line Type: Mobile
-            Line Provider: Verizon Wireless
-            Mobile Country Code: '310'
-            Mobile Network Code: '010'
-        failedTelephoneNumbers:
-          - '+191955512345'
-    lookupSingleNumberCompleteNoInfoExample:
-      summary: Example Single Number Lookup Complete with No Information Response
-      value:
-        requestId: 004223a0-8b17-41b1-bf81-20732adf5590
-        status: COMPLETE
-        result:
-          - Response Code: 3
-            Message: NXDOMAIN
-            E.164 Format: '+19195550000'
-            Formatted: (919) 555-0000
-            Country: US