Merge remote-tracking branch 'origin/VAPI-3164' into VAPI-3164

Author: stampercasey

.bandwidth/component.yaml

@@ -6,6 +6,7 @@ metadata:
   description: Bandwidth Java SDK
   annotations:
     github.com/project-slug: Bandwidth/java-sdk
+    bandwidth.com/languages: Java
     organization: BW
     costCenter: Development - Software Infra
 spec:

.github/workflows/deploy.yml

@@ -34,7 +34,9 @@ jobs:
 
     steps:
       - name: Set Release Version
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/v}" >> $GITHUB_ENV
+        run: echo "RELEASE_VERSION=${TAG#v}" >> $GITHUB_ENV
+        env:
+          TAG: ${{ github.event.release.tag_name }}
 
       - name: Checkout
         uses: actions/checkout@v6

api/openapi.yaml

@@ -6498,6 +6498,8 @@ components:
                 examples:
                   messageSendingCallback:
                     $ref: "#/components/examples/messageSendingCallbackExample"
+                  messageSentCallback:
+                    $ref: "#/components/examples/messageSentCallbackExample"
                   smsMessageDeliveredCallback:
                     $ref: "#/components/examples/smsMessageDeliveredCallbackExample"
                   mmsMessageDeliveredCallback:
@@ -6511,7 +6513,7 @@ components:
             description: |-
               <p>This Outbound Message Webhook is an envelope containing status information regarding a message sent (MT)
               from your message-enabled Bandwidth telephone number.
-               <p>The payload type will be one of <code>message-sending</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
+               <p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
                <p>Note that <code>message-read</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
               </p><p>Please visit <a href='/docs/messaging/webhooks/'>Webhooks</a></p>
             required: true
@@ -6691,12 +6693,33 @@ components:
           media:
           - https://dev.bandwidth.com/images/bandwidth-logo.png
           tag: your tag here
+    messageSentCallbackExample:
+      summary: An example of a message-sent callback body.
+      value:
+        time: 2024-06-25T18:42:36.979456Z
+        type: message-sent
+        to: "+15554443333"
+        description: Message sent 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: v2 lab
     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.
+        description: Message delivered to handset.
         to: "+12345678902"
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -6714,7 +6737,7 @@ components:
       value:
         type: message-delivered
         time: 2024-09-14T18:20:24.160544Z
-        description: Message delivered to carrier.
+        description: Message delivered to handset.
         to: "+12345678902"
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -6734,7 +6757,7 @@ components:
       value:
         type: message-delivered
         time: 2024-09-14T18:20:17.160544Z
-        description: Message delivered to carrier.
+        description: Message delivered to handset.
         to: "+12345678902"
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -10704,7 +10727,7 @@ components:
           type: string
         description:
           description: A detailed description of the event described by the callback.
-          example: Message delivered to carrier.
+          example: Message delivered to handset.
           type: string
         message:
           $ref: "#/components/schemas/statusCallbackMessage"
@@ -10765,11 +10788,13 @@ components:
       description: |-
         The possible status callbacks when sending an MT SMS or MMS or RBM message:
         - `message-sending` indicates that Bandwidth is sending the message to the upstream provider.
-        - `message-delivered` indicates that the message was successfully sent.
+        - `message-sent` indicates that the message has left the Bandwidth network and is in transit to the provider.
+        - `message-delivered` indicates that the message was successfully delivered to handset.
         - `message-failed` indicates that the message could not be sent to the intended recipient.
         - `message-read` indicates that the RBM message was read by the recipient.
       enum:
       - message-sending
+      - message-sent
       - message-delivered
       - message-failed
       - message-read
@@ -12354,6 +12379,13 @@ components:
           type: string
         machineDetectionResult:
           $ref: "#/components/schemas/machineDetectionResult"
+        sipCallId:
+          description: "(optional) The SIP Call-ID of the call's current SIP dialog\
+            \ with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present\
+            \ on any call, inbound or outbound, once that dialog has been established;\
+            \ may be absent very early in a call before the dialog exists."
+          example: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
+          type: string
       type: object
     bridgeCompleteCallback:
       description: "If the target call leaves the <Bridge>, then this callback is\
@@ -12933,6 +12965,19 @@ components:
           example: exampleTag
           nullable: true
           type: string
+        sipCallId:
+          description: "(optional) The SIP Call-ID of the call's current SIP dialog\
+            \ with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present\
+            \ on any call, inbound or outbound, once that dialog has been established;\
+            \ may be absent very early in a call before the dialog exists."
+          example: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
+          type: string
+        sipResponseCode:
+          description: "(optional) The SIP status code returned by Bandwidth's SBC\
+            \ when it rejected an outbound call's INVITE (e.g. 486 for busy, 603 for\
+            \ decline). Present only when an outbound call was rejected by the SBC."
+          example: 486
+          type: integer
       type: object
     dtmfCallback:
       description: The DTMF event is sent for every digit detected after a <StartGather>
@@ -13197,6 +13242,27 @@ components:
           example: bXktdXVp
           maxLength: 256
           type: string
+        sipCallId:
+          description: "(optional) The SIP Call-ID of the call's current SIP dialog\
+            \ with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present\
+            \ on any call, inbound or outbound, once that dialog has been established;\
+            \ may be absent very early in a call before the dialog exists."
+          example: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
+          type: string
+        sipHeaders:
+          additionalProperties:
+            type: string
+          description: "(optional) Map of customer-supplied X-* headers from the original\
+            \ INVITE. Keys are lowercase (SIP headers are case-insensitive). Present\
+            \ only for inbound SIP URI calls with custom headers. Note - keys preserve\
+            \ the original SIP header name in lowercase rather than Bandwidth's usual\
+            \ camelCase JSON convention, since these are passthrough values from the\
+            \ caller's SIP INVITE, not Bandwidth-defined fields. If the same header\
+            \ name is sent more than once in the INVITE, only the last value is kept."
+          example:
+            x-custom-header: customer-value
+            x-session-id: sess-12345
+          type: object
       type: object
     machineDetectionCompleteCallback:
       description: "This event is sent to the url informed when requesting a machine\
@@ -14284,6 +14350,33 @@ components:
       example: bXktdXVp
       maxLength: 256
       type: string
+    sipCallId:
+      description: "(optional) The SIP Call-ID of the call's current SIP dialog with\
+        \ Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any\
+        \ call, inbound or outbound, once that dialog has been established; may be\
+        \ absent very early in a call before the dialog exists."
+      example: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
+      type: string
+    sipHeaders:
+      additionalProperties:
+        type: string
+      description: "(optional) Map of customer-supplied X-* headers from the original\
+        \ INVITE. Keys are lowercase (SIP headers are case-insensitive). Present only\
+        \ for inbound SIP URI calls with custom headers. Note - keys preserve the\
+        \ original SIP header name in lowercase rather than Bandwidth's usual camelCase\
+        \ JSON convention, since these are passthrough values from the caller's SIP\
+        \ INVITE, not Bandwidth-defined fields. If the same header name is sent more\
+        \ than once in the INVITE, only the last value is kept."
+      example:
+        x-custom-header: customer-value
+        x-session-id: sess-12345
+      type: object
+    sipResponseCode:
+      description: "(optional) The SIP status code returned by Bandwidth's SBC when\
+        \ it rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline).\
+        \ Present only when an outbound call was rejected by the SBC."
+      example: 486
+      type: integer
     codeRequest:
       properties:
         to:

bandwidth.yml

@@ -2962,7 +2962,7 @@ components:
         description:
           type: string
           description: A detailed description of the event described by the callback.
-          example: Message delivered to carrier.
+          example: Message delivered to handset.
         message:
           $ref: '#/components/schemas/statusCallbackMessage'
         errorCode:
@@ -3018,7 +3018,11 @@ components:
         - `message-sending` indicates that Bandwidth is sending the message to
         the upstream provider.
 
-        - `message-delivered` indicates that the message was successfully sent.
+        - `message-sent` indicates that the message has left the Bandwidth
+        network and is in transit to the provider.
+
+        - `message-delivered` indicates that the message was successfully
+        delivered to handset.
 
         - `message-failed` indicates that the message could not be sent to the
         intended recipient.
@@ -3027,6 +3031,7 @@ components:
         recipient.
       enum:
         - message-sending
+        - message-sent
         - message-delivered
         - message-failed
         - message-read
@@ -4563,6 +4568,8 @@ components:
           $ref: '#/components/schemas/tag1'
         machineDetectionResult:
           $ref: '#/components/schemas/machineDetectionResult'
+        sipCallId:
+          $ref: '#/components/schemas/sipCallId'
     bridgeCompleteCallback:
       type: object
       description: >-
@@ -4827,6 +4834,10 @@ components:
           $ref: '#/components/schemas/errorId'
         tag:
           $ref: '#/components/schemas/tag1'
+        sipCallId:
+          $ref: '#/components/schemas/sipCallId'
+        sipResponseCode:
+          $ref: '#/components/schemas/sipResponseCode'
     dtmfCallback:
       type: object
       description: >-
@@ -4943,6 +4954,10 @@ components:
           $ref: '#/components/schemas/stirShaken'
         uui:
           $ref: '#/components/schemas/uui'
+        sipCallId:
+          $ref: '#/components/schemas/sipCallId'
+        sipHeaders:
+          $ref: '#/components/schemas/sipHeaders'
     machineDetectionCompleteCallback:
       type: object
       description: >-
@@ -5590,6 +5605,36 @@ components:
         value, including the encoding specifier, may not exceed 256 characters.
       example: bXktdXVp
       maxLength: 256
+    sipCallId:
+      type: string
+      description: >-
+        (optional) The SIP Call-ID of the call's current SIP dialog with
+        Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on
+        any call, inbound or outbound, once that dialog has been established;
+        may be absent very early in a call before the dialog exists.
+      example: c95ac8d6e1a31c52eb38f419893c151633ec68f8d@sbc.bandwidth.com
+    sipHeaders:
+      type: object
+      additionalProperties:
+        type: string
+      description: >-
+        (optional) Map of customer-supplied X-* headers from the original
+        INVITE. Keys are lowercase (SIP headers are case-insensitive). Present
+        only for inbound SIP URI calls with custom headers. Note - keys preserve
+        the original SIP header name in lowercase rather than Bandwidth's usual
+        camelCase JSON convention, since these are passthrough values from the
+        caller's SIP INVITE, not Bandwidth-defined fields. If the same header
+        name is sent more than once in the INVITE, only the last value is kept.
+      example:
+        x-custom-header: customer-value
+        x-session-id: sess-12345
+    sipResponseCode:
+      type: integer
+      description: >-
+        (optional) The SIP status code returned by Bandwidth's SBC when it
+        rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline).
+        Present only when an outbound call was rejected by the SBC.
+      example: 486
     codeRequest:
       type: object
       properties:
@@ -8712,12 +8757,33 @@ components:
           media:
             - https://dev.bandwidth.com/images/bandwidth-logo.png
           tag: your tag here
+    messageSentCallbackExample:
+      summary: An example of a message-sent callback body.
+      value:
+        time: '2024-06-25T18:42:36.979456Z'
+        type: message-sent
+        to: '+15554443333'
+        description: Message sent 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: v2 lab
     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.
+        description: Message delivered to handset.
         to: '+12345678902'
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -8735,7 +8801,7 @@ components:
       value:
         type: message-delivered
         time: '2024-09-14T18:20:24.160544Z'
-        description: Message delivered to carrier.
+        description: Message delivered to handset.
         to: '+12345678902'
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -8755,7 +8821,7 @@ components:
       value:
         type: message-delivered
         time: '2024-09-14T18:20:17.160544Z'
-        description: Message delivered to carrier.
+        description: Message delivered to handset.
         to: '+12345678902'
         message:
           id: 14762070468292kw2fuqty55yp2b2
@@ -9787,7 +9853,7 @@ components:
               information regarding a message sent (MT)
 
               from your message-enabled Bandwidth telephone number.
-               <p>The payload type will be one of <code>message-sending</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
+               <p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
                <p>Note that <code>message-read</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
               </p><p>Please visit <a
               href='/docs/messaging/webhooks/'>Webhooks</a></p>
@@ -9798,6 +9864,8 @@ components:
                 examples:
                   messageSendingCallback:
                     $ref: '#/components/examples/messageSendingCallbackExample'
+                  messageSentCallback:
+                    $ref: '#/components/examples/messageSentCallbackExample'
                   smsMessageDeliveredCallback:
                     $ref: '#/components/examples/smsMessageDeliveredCallbackExample'
                   mmsMessageDeliveredCallback:

docs/AnswerCallback.md

@@ -22,6 +22,7 @@ The Answer event is sent to the answerUrl specified in the createCall request wh
 |**answerTime** | **OffsetDateTime** | Time the call was answered, in ISO 8601 format. |  [optional] |
 |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. |  [optional] |
 |**machineDetectionResult** | [**MachineDetectionResult**](MachineDetectionResult.md) |  |  [optional] |
+|**sipCallId** | **String** | (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. |  [optional] |
 
 
 

docs/DisconnectCallback.md

@@ -25,6 +25,8 @@ The Disconnect event is fired when a call ends, for any reason.
 |**errorMessage** | **String** | Text explaining the reason that caused the call to fail in case of errors. |  [optional] |
 |**errorId** | **String** | Bandwidth's internal id that references the error event. |  [optional] |
 |**tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. |  [optional] |
+|**sipCallId** | **String** | (optional) The SIP Call-ID of the call's current SIP dialog with Bandwidth's SBC. Used to correlate dialogs and trace calls. Present on any call, inbound or outbound, once that dialog has been established; may be absent very early in a call before the dialog exists. |  [optional] |
+|**sipResponseCode** | **Integer** | (optional) The SIP status code returned by Bandwidth's SBC when it rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline). Present only when an outbound call was rejected by the SBC. |  [optional] |