VAPI-3163

Author: atelegu

api/openapi.yaml

@@ -13481,30 +13481,23 @@ components:
           example: exampleTag
           nullable: true
           type: string
-        sipResponseCode:
-          description: "The SIP response code from the REFER request, indicating the\
-            \ outcome of the operation (e.g., 200 for success, 404 for not found)."
-          example: 200
+        referCallStatus:
+          description: "The outcome of the REFER operation. Either \"success\" or\
+            \ \"failure\"."
+          example: success
+          type: string
+        referSipResponseCode:
+          description: "The SIP response code returned for the REFER request itself\
+            \ (e.g. 202, 405, 603)."
+          example: 202
           nullable: true
           type: integer
-        cause:
-          description: "Reason the call failed - hangup, busy, timeout, cancel, rejected,\
-            \ callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded,\
-            \ error, or unknown."
-          example: busy
-          type: string
-        errorMessage:
-          description: Text explaining the reason that caused the call to fail in
-            case of errors.
-          example: Call c-2a913f94-6a486f3a-3cae-4034-bcc3-f0c9fa77ca2f is already
-            bridged with another call
-          nullable: true
-          type: string
-        errorId:
-          description: Bandwidth's internal id that references the error event.
-          example: 4642074b-7b58-478b-96e4-3a60955c6765
+        notifySipResponseCode:
+          description: "The final SIP response code reported via NOTIFY. Present only\
+            \ when the caller's endpoint sent a final NOTIFY."
+          example: 200
           nullable: true
-          type: string
+          type: integer
       type: object
     transcriptionAvailableCallback:
       description: The Transcription Available event is sent when the recording transcription
@@ -14089,12 +14082,6 @@ components:
       example: 4642074b-7b58-478b-96e4-3a60955c6765
       nullable: true
       type: string
-    sipResponseCode:
-      description: "The SIP response code from the REFER request, indicating the outcome\
-        \ of the operation (e.g., 200 for success, 404 for not found)."
-      example: 200
-      nullable: true
-      type: integer
     machineDetectionResult:
       description: "(optional) if machine detection was requested in sync mode, the\
         \ result will be specified here. Possible values are the same as the async\

bandwidth.yml

@@ -5080,14 +5080,12 @@ components:
           $ref: '#/components/schemas/answerTime'
         tag:
           $ref: '#/components/schemas/tag1'
-        sipResponseCode:
-          $ref: '#/components/schemas/sipResponseCode'
-        cause:
-          $ref: '#/components/schemas/cause'
-        errorMessage:
-          $ref: '#/components/schemas/errorMessage'
-        errorId:
-          $ref: '#/components/schemas/errorId'
+        referCallStatus:
+          $ref: '#/components/schemas/referCallStatus'
+        referSipResponseCode:
+          $ref: '#/components/schemas/referSipResponseCode'
+        notifySipResponseCode:
+          $ref: '#/components/schemas/notifySipResponseCode'
     transcriptionAvailableCallback:
       type: object
       description: >-
@@ -5433,6 +5431,24 @@ components:
         or it was previously cleared, this field will not be present.
       example: exampleTag
       nullable: true
+    referCallStatus:
+      type: string
+      description: The outcome of the REFER operation. Either "success" or "failure".
+      example: success
+    referSipResponseCode:
+      type: integer
+      description: >-
+        The SIP response code returned for the REFER request itself (e.g. 202,
+        405, 603).
+      example: 202
+      nullable: true
+    notifySipResponseCode:
+      type: integer
+      description: >-
+        The final SIP response code reported via NOTIFY. Present only when the
+        caller's endpoint sent a final NOTIFY.
+      example: 200
+      nullable: true
     cause:
       type: string
       description: >-
@@ -5454,13 +5470,6 @@ components:
       description: Bandwidth's internal id that references the error event.
       example: 4642074b-7b58-478b-96e4-3a60955c6765
       nullable: true
-    sipResponseCode:
-      type: integer
-      description: >-
-        The SIP response code from the REFER request, indicating the outcome
-        of the operation (e.g., 200 for success, 404 for not found).
-      example: 200
-      nullable: true
     machineDetectionResult:
       type: object
       description: >-

docs/ReferCompleteCallback.md

@@ -18,10 +18,9 @@ Name | Type | Description | Notes
 **StartTime** | **DateTime** | Time the call was started, in ISO 8601 format. | [optional] 
 **AnswerTime** | **DateTime?** | 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] 
-**SipResponseCode** | **int?** | The SIP response code from the REFER request, indicating the outcome of the operation (e.g., 200 for success, 404 for not found). | [optional] 
-**Cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] 
-**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] 
+**ReferCallStatus** | **string** | The outcome of the REFER operation. Either "success" or "failure". | [optional] 
+**ReferSipResponseCode** | **int?** | The SIP response code returned for the REFER request itself (e.g. 202, 405, 603). | [optional] 
+**NotifySipResponseCode** | **int?** | The final SIP response code reported via NOTIFY. Present only when the caller's endpoint sent a final NOTIFY. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)