diff --git a/bandwidth.yml b/bandwidth.yml index e7ad640e..6b44f54f 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -32,27 +32,27 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/continuationToken" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/continuationToken' responses: - "200": - $ref: "#/components/responses/listMediaResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "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" + '200': + $ref: '#/components/responses/listMediaResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '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' servers: &ref_0 - url: https://messaging.bandwidth.com/api/v2 description: Production @@ -64,36 +64,35 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' responses: - "200": - $ref: "#/components/responses/getMediaResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "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" + '200': + $ref: '#/components/responses/getMediaResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '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' put: summary: Upload Media description: >- - Upload a file. You may add headers to the request in order to provide - some control to your media file. + Upload a file. - If a file is uploaded with the same name as a file that already exists - under this account, the previous file will be overwritten. + Filename should always be unique. Reusing filenames may result in the + wrong media being sent. A list of supported media types can be found at [Bandwidth @@ -102,31 +101,31 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" - - $ref: "#/components/parameters/contentType" - - $ref: "#/components/parameters/cacheControl" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' + - $ref: '#/components/parameters/contentType' + - $ref: '#/components/parameters/cacheControl' requestBody: - $ref: "#/components/requestBodies/uploadMediaRequest" + $ref: '#/components/requestBodies/uploadMediaRequest' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/messagingBadRequestError" - "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" + '400': + $ref: '#/components/responses/messagingBadRequestError' + '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' delete: summary: Delete Media description: |- @@ -139,27 +138,27 @@ paths: tags: - Media parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/mediaId" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/mediaId' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/messagingBadRequestError" - "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" + '400': + $ref: '#/components/responses/messagingBadRequestError' + '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' servers: *ref_0 /users/{accountId}/messages: get: @@ -175,53 +174,53 @@ paths: tags: - Messages parameters: - - $ref: "#/components/parameters/accountId" - - $ref: "#/components/parameters/messageId" - - $ref: "#/components/parameters/sourceTn" - - $ref: "#/components/parameters/destinationTn" - - $ref: "#/components/parameters/messageStatus" - - $ref: "#/components/parameters/messageDirection" - - $ref: "#/components/parameters/carrierName" - - $ref: "#/components/parameters/messageType" - - $ref: "#/components/parameters/errorCode" - - $ref: "#/components/parameters/fromDateTime" - - $ref: "#/components/parameters/toDateTime" - - $ref: "#/components/parameters/campaignId" - - $ref: "#/components/parameters/fromBwLatency" - - $ref: "#/components/parameters/bwQueued" - - $ref: "#/components/parameters/product" - - $ref: "#/components/parameters/location" - - $ref: "#/components/parameters/carrierQueued" - - $ref: "#/components/parameters/fromCarrierLatency" - - $ref: "#/components/parameters/callingNumberCountryA3" - - $ref: "#/components/parameters/calledNumberCountryA3" - - $ref: "#/components/parameters/fromSegmentCount" - - $ref: "#/components/parameters/toSegmentCount" - - $ref: "#/components/parameters/fromMessageSize" - - $ref: "#/components/parameters/toMessageSize" - - $ref: "#/components/parameters/sort" - - $ref: "#/components/parameters/pageToken" - - $ref: "#/components/parameters/limit" - - $ref: "#/components/parameters/limitTotalCount" + - $ref: '#/components/parameters/accountId' + - $ref: '#/components/parameters/messageId' + - $ref: '#/components/parameters/sourceTn' + - $ref: '#/components/parameters/destinationTn' + - $ref: '#/components/parameters/messageStatus' + - $ref: '#/components/parameters/messageDirection' + - $ref: '#/components/parameters/carrierName' + - $ref: '#/components/parameters/messageType' + - $ref: '#/components/parameters/errorCode' + - $ref: '#/components/parameters/fromDateTime' + - $ref: '#/components/parameters/toDateTime' + - $ref: '#/components/parameters/campaignId' + - $ref: '#/components/parameters/fromBwLatency' + - $ref: '#/components/parameters/bwQueued' + - $ref: '#/components/parameters/product' + - $ref: '#/components/parameters/location' + - $ref: '#/components/parameters/carrierQueued' + - $ref: '#/components/parameters/fromCarrierLatency' + - $ref: '#/components/parameters/callingNumberCountryA3' + - $ref: '#/components/parameters/calledNumberCountryA3' + - $ref: '#/components/parameters/fromSegmentCount' + - $ref: '#/components/parameters/toSegmentCount' + - $ref: '#/components/parameters/fromMessageSize' + - $ref: '#/components/parameters/toMessageSize' + - $ref: '#/components/parameters/sort' + - $ref: '#/components/parameters/pageToken' + - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/limitTotalCount' responses: - "200": - $ref: "#/components/responses/listMessagesResponse" - "400": - $ref: "#/components/responses/messagingBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "405": - $ref: "#/components/responses/messagingMethodNotAllowedError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/listMessagesTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '200': + $ref: '#/components/responses/listMessagesResponse' + '400': + $ref: '#/components/responses/messagingBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '405': + $ref: '#/components/responses/messagingMethodNotAllowedError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/listMessagesTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' post: summary: Create Message description: >- @@ -231,33 +230,33 @@ paths: tags: - Messages parameters: - - $ref: "#/components/parameters/accountId" + - $ref: '#/components/parameters/accountId' requestBody: - $ref: "#/components/requestBodies/createMessageRequest" + $ref: '#/components/requestBodies/createMessageRequest' responses: - "202": - $ref: "#/components/responses/createMessageResponse" - "400": - $ref: "#/components/responses/createMessageBadRequestError" - "401": - $ref: "#/components/responses/messagingUnauthorizedError" - "403": - $ref: "#/components/responses/messagingForbiddenError" - "404": - $ref: "#/components/responses/messagingNotFoundError" - "405": - $ref: "#/components/responses/messagingMethodNotAllowedError" - "406": - $ref: "#/components/responses/messagingNotAcceptableError" - "415": - $ref: "#/components/responses/messagingInvalidMediaTypeError" - "429": - $ref: "#/components/responses/messagingTooManyRequestsError" - "500": - $ref: "#/components/responses/messagingInternalServerError" + '202': + $ref: '#/components/responses/createMessageResponse' + '400': + $ref: '#/components/responses/createMessageBadRequestError' + '401': + $ref: '#/components/responses/messagingUnauthorizedError' + '403': + $ref: '#/components/responses/messagingForbiddenError' + '404': + $ref: '#/components/responses/messagingNotFoundError' + '405': + $ref: '#/components/responses/messagingMethodNotAllowedError' + '406': + $ref: '#/components/responses/messagingNotAcceptableError' + '415': + $ref: '#/components/responses/messagingInvalidMediaTypeError' + '429': + $ref: '#/components/responses/messagingTooManyRequestsError' + '500': + $ref: '#/components/responses/messagingInternalServerError' callbacks: statusCallback: - $ref: "#/components/callbacks/statusCallback" + $ref: '#/components/callbacks/statusCallback' servers: *ref_0 /users/{accountId}/messages/multiChannel: post: @@ -265,38 +264,38 @@ paths: description: Endpoint for sending Multi-Channel messages. operationId: createMultiChannelMessage parameters: - - $ref: "#/components/parameters/accountId" + - $ref: '#/components/parameters/accountId' tags: - Multi-Channel requestBody: - $ref: "#/components/requestBodies/createMultiChannelMessageRequest" + $ref: '#/components/requestBodies/createMultiChannelMessageRequest' responses: - "202": - $ref: "#/components/responses/createMultiChannelMessageResponse" - "400": - $ref: "#/components/responses/multiChannelBadRequestError" - "401": - $ref: "#/components/responses/multiChannelUnauthorizedError" - "403": - $ref: "#/components/responses/multiChannelForbiddenError" - "404": - $ref: "#/components/responses/multiChannelNotFoundError" - "405": - $ref: "#/components/responses/multiChannelMethodNotAllowedError" - "406": - $ref: "#/components/responses/multiChannelNotAcceptableError" - "415": - $ref: "#/components/responses/multiChannelInvalidMediaTypeError" - "429": - $ref: "#/components/responses/multiChannelTooManyRequestsError" - "500": - $ref: "#/components/responses/multiChannelInternalServerError" + '202': + $ref: '#/components/responses/createMultiChannelMessageResponse' + '400': + $ref: '#/components/responses/multiChannelBadRequestError' + '401': + $ref: '#/components/responses/multiChannelUnauthorizedError' + '403': + $ref: '#/components/responses/multiChannelForbiddenError' + '404': + $ref: '#/components/responses/multiChannelNotFoundError' + '405': + $ref: '#/components/responses/multiChannelMethodNotAllowedError' + '406': + $ref: '#/components/responses/multiChannelNotAcceptableError' + '415': + $ref: '#/components/responses/multiChannelInvalidMediaTypeError' + '429': + $ref: '#/components/responses/multiChannelTooManyRequestsError' + '500': + $ref: '#/components/responses/multiChannelInternalServerError' callbacks: statusCallback: - $ref: "#/components/callbacks/statusCallback" + $ref: '#/components/callbacks/statusCallback' x-badges: - name: Beta - color: "#076EA8" + color: '#076EA8' servers: *ref_0 /accounts/{accountId}/calls: post: @@ -317,28 +316,28 @@ paths: approximately in order, but exact ordering is not guaranteed. operationId: createCall parameters: - - $ref: "#/components/parameters/accountId1" + - $ref: '#/components/parameters/accountId1' requestBody: - $ref: "#/components/requestBodies/createCallRequest" + $ref: '#/components/requestBodies/createCallRequest' responses: - "201": - $ref: "#/components/responses/createCallResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '201': + $ref: '#/components/responses/createCallResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' get: tags: - Calls @@ -358,33 +357,33 @@ paths: days, you will get an empty array [] in response. operationId: listCalls parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/to" - - $ref: "#/components/parameters/from" - - $ref: "#/components/parameters/minStartTimeCalls" - - $ref: "#/components/parameters/maxStartTimeCalls" - - $ref: "#/components/parameters/disconnectCause" - - $ref: "#/components/parameters/pageSizeCalls" - - $ref: "#/components/parameters/pageToken1" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/to' + - $ref: '#/components/parameters/from' + - $ref: '#/components/parameters/minStartTimeCalls' + - $ref: '#/components/parameters/maxStartTimeCalls' + - $ref: '#/components/parameters/disconnectCause' + - $ref: '#/components/parameters/pageSizeCalls' + - $ref: '#/components/parameters/pageToken1' responses: - "200": - $ref: "#/components/responses/listCallsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: &ref_1 - url: https://voice.bandwidth.com/api/v2 description: Production @@ -404,27 +403,27 @@ paths: 7 days, you will get an HTTP 404 response. operationId: getCallState parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/getCallStateResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallStateResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Calls @@ -434,31 +433,31 @@ paths: BXML document. operationId: updateCall parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallRequest" + $ref: '#/components/requestBodies/updateCallRequest' responses: - "200": - $ref: "#/components/responses/updateCallResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "409": - $ref: "#/components/responses/voiceConflictError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/updateCallResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '409': + $ref: '#/components/responses/voiceConflictError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/bxml: put: @@ -468,31 +467,31 @@ paths: description: Interrupts and replaces an active call's BXML document. operationId: updateCallBxml parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallBxmlRequest" + $ref: '#/components/requestBodies/updateCallBxmlRequest' responses: - "204": + '204': description: Call BXML was successfully replaced. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "409": - $ref: "#/components/responses/voiceConflictError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '409': + $ref: '#/components/responses/voiceConflictError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences: get: @@ -510,31 +509,31 @@ paths: of conference records. operationId: listConferences parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/name" - - $ref: "#/components/parameters/minCreatedTime" - - $ref: "#/components/parameters/maxCreatedTime" - - $ref: "#/components/parameters/pageSize" - - $ref: "#/components/parameters/pageToken1" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/name' + - $ref: '#/components/parameters/minCreatedTime' + - $ref: '#/components/parameters/maxCreatedTime' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/pageToken1' responses: - "200": - $ref: "#/components/responses/listConferencesResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listConferencesResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}: get: @@ -544,27 +543,27 @@ paths: description: Returns information about the specified conference. operationId: getConference parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' responses: - "200": - $ref: "#/components/responses/getConferenceResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Conferences @@ -572,29 +571,29 @@ paths: description: Update the conference state. operationId: updateConference parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' requestBody: - $ref: "#/components/requestBodies/updateConferenceRequest" + $ref: '#/components/requestBodies/updateConferenceRequest' responses: - "204": + '204': description: Conference was successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/bxml: put: @@ -604,29 +603,29 @@ paths: description: Update the conference BXML document. operationId: updateConferenceBxml parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' requestBody: - $ref: "#/components/requestBodies/updateConferenceBxmlRequest" + $ref: '#/components/requestBodies/updateConferenceBxmlRequest' responses: - "204": + '204': description: Conference successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/members/{memberId}: get: @@ -636,28 +635,28 @@ paths: description: Returns information about the specified conference member. operationId: getConferenceMember parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/memberId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/memberId' responses: - "200": - $ref: "#/components/responses/getConferenceMemberResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceMemberResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' put: tags: - Conferences @@ -665,30 +664,30 @@ paths: description: Updates settings for a particular conference member. operationId: updateConferenceMember parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/memberId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/memberId' requestBody: - $ref: "#/components/requestBodies/updateConferenceMemberRequest" + $ref: '#/components/requestBodies/updateConferenceMemberRequest' responses: - "204": + '204': description: Conference member was successfully modified. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings: get: @@ -700,27 +699,27 @@ paths: took place during the specified conference. operationId: listConferenceRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' responses: - "200": - $ref: "#/components/responses/listConferenceRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listConferenceRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}: get: @@ -730,28 +729,28 @@ paths: description: Returns metadata for the specified recording. operationId: getConferenceRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getConferenceRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getConferenceRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/conferences/{conferenceId}/recordings/{recordingId}/media: get: @@ -761,28 +760,28 @@ paths: description: Downloads the specified recording file. operationId: downloadConferenceRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/conferenceId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/conferenceId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/downloadRecordingMediaResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/downloadRecordingMediaResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/recordings: get: @@ -801,30 +800,30 @@ paths: empty if no recordings match the specified criteria. operationId: listAccountCallRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/to" - - $ref: "#/components/parameters/from" - - $ref: "#/components/parameters/minStartTime" - - $ref: "#/components/parameters/maxStartTime" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/to' + - $ref: '#/components/parameters/from' + - $ref: '#/components/parameters/minStartTime' + - $ref: '#/components/parameters/maxStartTime' responses: - "200": - $ref: "#/components/responses/listCallRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recording: put: @@ -834,29 +833,29 @@ paths: description: Pause or resume a recording on an active phone call. operationId: updateCallRecordingState parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' requestBody: - $ref: "#/components/requestBodies/updateCallRecordingRequest" + $ref: '#/components/requestBodies/updateCallRecordingRequest' responses: - "200": - $ref: "#/components/responses/updateRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/updateRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings: get: @@ -868,27 +867,27 @@ paths: that took place during the specified call. operationId: listCallRecordings parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/listCallRecordingsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listCallRecordingsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}: get: @@ -898,28 +897,28 @@ paths: description: Returns metadata for the specified recording. operationId: getCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getCallRecordingResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallRecordingResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -935,28 +934,28 @@ paths: irreversible, can take an additional 24 to 48 hours. operationId: deleteRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: Recording was deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media: get: @@ -966,28 +965,28 @@ paths: description: Downloads the specified recording. operationId: downloadCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/downloadRecordingMediaResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/downloadRecordingMediaResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -995,28 +994,28 @@ paths: description: Deletes the specified recording's media. operationId: deleteRecordingMedia parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: The recording media was successfully deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/recordings/{recordingId}/transcription: get: @@ -1038,28 +1037,28 @@ paths: item. operationId: getRecordingTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "200": - $ref: "#/components/responses/getRecordingTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getRecordingTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' post: tags: - Recordings @@ -1073,30 +1072,30 @@ paths: less than 4 hours. operationId: transcribeCallRecording parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' requestBody: - $ref: "#/components/requestBodies/transcribeRecordingRequest" + $ref: '#/components/requestBodies/transcribeRecordingRequest' responses: - "204": + '204': description: Transcription was successfully requested. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Recordings @@ -1111,28 +1110,28 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRecordingTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/recordingId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/recordingId' responses: - "204": + '204': description: The transcription was successfully deleted. - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/statistics: get: @@ -1142,26 +1141,26 @@ paths: description: Returns details about the current state of the account. operationId: getStatistics parameters: - - $ref: "#/components/parameters/accountId1" + - $ref: '#/components/parameters/accountId1' responses: - "200": - $ref: "#/components/responses/getStatisticsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getStatisticsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/transcriptions: get: @@ -1173,27 +1172,27 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: listRealTimeTranscriptions parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' responses: - "200": - $ref: "#/components/responses/listTranscriptionsResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/listTranscriptionsResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId}: get: @@ -1205,28 +1204,28 @@ paths: [startTranscription](/docs/voice/bxml/startTranscription). operationId: getRealTimeTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/transcriptionId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/transcriptionId' responses: - "200": - $ref: "#/components/responses/getCallTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/getCallTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' delete: tags: - Transcriptions @@ -1242,28 +1241,28 @@ paths: can take an additional 24 to 48 hours. operationId: deleteRealTimeTranscription parameters: - - $ref: "#/components/parameters/accountId1" - - $ref: "#/components/parameters/callId" - - $ref: "#/components/parameters/transcriptionId" + - $ref: '#/components/parameters/accountId1' + - $ref: '#/components/parameters/callId' + - $ref: '#/components/parameters/transcriptionId' responses: - "200": - $ref: "#/components/responses/deleteCallTranscriptionResponse" - "400": - $ref: "#/components/responses/voiceBadRequestError" - "401": - $ref: "#/components/responses/voiceUnauthorizedError" - "403": - $ref: "#/components/responses/voiceForbiddenError" - "404": - $ref: "#/components/responses/voiceNotFoundError" - "405": - $ref: "#/components/responses/voiceNotAllowedError" - "415": - $ref: "#/components/responses/voiceUnsupportedMediaTypeError" - "429": - $ref: "#/components/responses/voiceTooManyRequestsError" - "500": - $ref: "#/components/responses/voiceInternalServerError" + '200': + $ref: '#/components/responses/deleteCallTranscriptionResponse' + '400': + $ref: '#/components/responses/voiceBadRequestError' + '401': + $ref: '#/components/responses/voiceUnauthorizedError' + '403': + $ref: '#/components/responses/voiceForbiddenError' + '404': + $ref: '#/components/responses/voiceNotFoundError' + '405': + $ref: '#/components/responses/voiceNotAllowedError' + '415': + $ref: '#/components/responses/voiceUnsupportedMediaTypeError' + '429': + $ref: '#/components/responses/voiceTooManyRequestsError' + '500': + $ref: '#/components/responses/voiceInternalServerError' servers: *ref_1 /accounts/{accountId}/code/voice: post: @@ -1273,20 +1272,20 @@ paths: description: Send an MFA Code via a phone call. operationId: generateVoiceCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeRequest" + $ref: '#/components/requestBodies/codeRequest' responses: - "200": - $ref: "#/components/responses/voiceCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/voiceCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: &ref_2 - url: https://mfa.bandwidth.com/api/v1 description: Production @@ -1298,20 +1297,20 @@ paths: description: Send an MFA code via text message (SMS). operationId: generateMessagingCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeRequest" + $ref: '#/components/requestBodies/codeRequest' responses: - "200": - $ref: "#/components/responses/messagingCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/messagingCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: *ref_2 /accounts/{accountId}/code/verify: post: @@ -1321,22 +1320,22 @@ paths: description: Verify a previously sent MFA code. operationId: verifyCode parameters: - - $ref: "#/components/parameters/accountId2" + - $ref: '#/components/parameters/accountId2' requestBody: - $ref: "#/components/requestBodies/codeVerify" + $ref: '#/components/requestBodies/codeVerify' responses: - "200": - $ref: "#/components/responses/verifyCodeResponse" - "400": - $ref: "#/components/responses/mfaBadRequestError" - "401": - $ref: "#/components/responses/mfaUnauthorizedError" - "403": - $ref: "#/components/responses/mfaForbiddenError" - "429": - $ref: "#/components/responses/mfaTooManyRequestsError" - "500": - $ref: "#/components/responses/mfaInternalServerError" + '200': + $ref: '#/components/responses/verifyCodeResponse' + '400': + $ref: '#/components/responses/mfaBadRequestError' + '401': + $ref: '#/components/responses/mfaUnauthorizedError' + '403': + $ref: '#/components/responses/mfaForbiddenError' + '429': + $ref: '#/components/responses/mfaTooManyRequestsError' + '500': + $ref: '#/components/responses/mfaInternalServerError' servers: *ref_2 /accounts/{accountId}/phoneNumberLookup: post: @@ -1348,14 +1347,14 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" + - $ref: '#/components/parameters/accountId3' requestBody: - $ref: "#/components/requestBodies/createSyncLookupRequest" + $ref: '#/components/requestBodies/createSyncLookupRequest' responses: - "200": - $ref: "#/components/responses/createSyncLookupResponse" + '200': + $ref: '#/components/responses/createSyncLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: &ref_3 - url: https://api.bandwidth.com/v2 description: Production @@ -1371,14 +1370,14 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" + - $ref: '#/components/parameters/accountId3' requestBody: - $ref: "#/components/requestBodies/createAsyncBulkLookupRequest" + $ref: '#/components/requestBodies/createAsyncBulkLookupRequest' responses: - "202": - $ref: "#/components/responses/createAsyncBulkLookupResponse" + '202': + $ref: '#/components/responses/createAsyncBulkLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: *ref_3 /accounts/{accountId}/phoneNumberLookup/bulk/{requestId}: get: @@ -1391,45 +1390,59 @@ paths: tags: - Phone Number Lookup parameters: - - $ref: "#/components/parameters/accountId3" - - $ref: "#/components/parameters/requestId" + - $ref: '#/components/parameters/accountId3' + - $ref: '#/components/parameters/requestId' responses: - "200": - $ref: "#/components/responses/getAsyncBulkLookupResponse" + '200': + $ref: '#/components/responses/getAsyncBulkLookupResponse' default: - $ref: "#/components/responses/tnLookupDefaultResponse" + $ref: '#/components/responses/tnLookupDefaultResponse' servers: *ref_3 /accounts/{accountId}/tollFreeVerification: post: tags: - Toll-Free Verification summary: Request Toll-Free Verification - description: Submit a request for verification of a toll-free phone number. + description: >- + Submit a request for verification of a toll-free phone number. + + + **Upcoming change (effective January 2027):** If any phone number in the + request already has a verification in progress, the request will be + rejected with a `409 Conflict`. + + This check is all-or-nothing: if a single phone number conflicts, the + entire request is rejected and **none** of the phone numbers in the + request are submitted. + + Today, these requests are accepted with a `202`. operationId: requestTollFreeVerification parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' requestBody: - $ref: "#/components/requestBodies/requestTollFreeVerificationRequest" + $ref: '#/components/requestBodies/requestTollFreeVerificationRequest' responses: - "202": + '202': description: Accepted - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' callbacks: tfVerificationStatus: - $ref: "#/components/callbacks/tfVerificationStatus" + $ref: '#/components/callbacks/tfVerificationStatus' servers: &ref_4 - url: https://api.bandwidth.com/api/v2 description: Production @@ -1446,27 +1459,27 @@ paths: available. operationId: getTollFreeVerificationStatus parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: - "200": - $ref: "#/components/responses/getTollFreeVerificationStatusResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/getTollFreeVerificationStatusResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' put: tags: - Toll-Free Verification @@ -1477,57 +1490,75 @@ paths: Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). + + Returns a `404` if no verification request exists for the phone number, + and a `400` if the existing request is not eligible for resubmission. + + + **Upcoming change (effective January 2027):** If a verification for the + phone number is in progress, the update will be rejected with a `409 + Conflict`. operationId: updateTollFreeVerificationRequest parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' requestBody: - $ref: "#/components/requestBodies/updateTollFreeVerificationRequestRequest" + $ref: '#/components/requestBodies/updateTollFreeVerificationRequestRequest' responses: - "202": - $ref: "#/components/responses/verifyPutResponse" - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '202': + $ref: '#/components/responses/verifyPutResponse' + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '409': + $ref: '#/components/responses/tfvConflictResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' callbacks: tfVerificationStatus: - $ref: "#/components/callbacks/tfVerificationStatus" + $ref: '#/components/callbacks/tfVerificationStatus' delete: - description: Delete a toll-free verification submission for a toll-free number. + description: >- + Delete a toll-free verification submission for a toll-free number. + + + **Upcoming change (effective January 2027):** If a verification for the + phone number is in progress, it will be cancelled and the submission + will then be deleted asynchronously. operationId: deleteVerificationRequest parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/tfPhoneNumberPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/tfPhoneNumberPathParam' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' summary: Delete a Toll-Free Verification Submission tags: - Toll-Free Verification @@ -1546,24 +1577,24 @@ paths: object will be null). operationId: listWebhookSubscriptions parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' responses: - "200": - $ref: "#/components/responses/listWebhookSubscriptionsResponse" - "400": - $ref: "#/components/responses/tfvPostBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/listWebhookSubscriptionsResponse' + '400': + $ref: '#/components/responses/tfvPostBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' post: tags: - Toll-Free Verification @@ -1579,28 +1610,28 @@ paths: modify or delete the subscription at a later time. operationId: createWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" + - $ref: '#/components/parameters/accountId4' requestBody: - $ref: "#/components/requestBodies/webhookSubscriptionRequest" + $ref: '#/components/requestBodies/webhookSubscriptionRequest' responses: - "201": - $ref: "#/components/responses/createWebhookSubscriptionResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '201': + $ref: '#/components/responses/createWebhookSubscriptionResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id}: delete: @@ -1610,27 +1641,27 @@ paths: description: Delete a webhook subscription by ID. operationId: deleteWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/webhookSubscriptionIdPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' put: tags: - Toll-Free Verification @@ -1640,29 +1671,29 @@ paths: `basicAuthentication` can be updated). operationId: updateWebhookSubscription parameters: - - $ref: "#/components/parameters/accountId4" - - $ref: "#/components/parameters/webhookSubscriptionIdPathParam" + - $ref: '#/components/parameters/accountId4' + - $ref: '#/components/parameters/webhookSubscriptionIdPathParam' requestBody: - $ref: "#/components/requestBodies/webhookSubscriptionRequest" + $ref: '#/components/requestBodies/webhookSubscriptionRequest' responses: - "200": - $ref: "#/components/responses/updateWebhookSubscriptionResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/updateWebhookSubscriptionResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /tollFreeVerification/useCases: get: @@ -1672,24 +1703,24 @@ paths: description: Lists valid toll-free use cases. operationId: listTollFreeUseCases responses: - "200": - $ref: "#/components/responses/listTollFreeUseCasesResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '200': + $ref: '#/components/responses/listTollFreeUseCasesResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' servers: *ref_4 /accounts/{accountId}/endpoints: get: @@ -1699,30 +1730,30 @@ paths: description: Returns a list of endpoints associated with the specified account. operationId: listEndpoints parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointType" - - $ref: "#/components/parameters/endpointStatus" - - $ref: "#/components/parameters/afterCursor" - - $ref: "#/components/parameters/limit1" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointType' + - $ref: '#/components/parameters/endpointStatus' + - $ref: '#/components/parameters/afterCursor' + - $ref: '#/components/parameters/limit1' responses: - "200": - $ref: "#/components/responses/listEndpointsResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '200': + $ref: '#/components/responses/listEndpointsResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' post: tags: - Endpoints @@ -1730,31 +1761,31 @@ paths: description: Creates a new Endpoint for the specified account. operationId: createEndpoint parameters: - - $ref: "#/components/parameters/accountId5" + - $ref: '#/components/parameters/accountId5' requestBody: - $ref: "#/components/requestBodies/createEndpointRequest" + $ref: '#/components/requestBodies/createEndpointRequest' responses: - "201": - $ref: "#/components/responses/createEndpointResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '201': + $ref: '#/components/responses/createEndpointResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' callbacks: endpointEventCallback: - $ref: "#/components/callbacks/endpointEvent" + $ref: '#/components/callbacks/endpointEvent' servers: &ref_5 - url: https://api.bandwidth.com/v2 description: Production @@ -1766,27 +1797,27 @@ paths: description: Returns information about the specified endpoint. operationId: getEndpoint parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' responses: - "200": - $ref: "#/components/responses/getEndpointResponse" - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '200': + $ref: '#/components/responses/getEndpointResponse' + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' delete: tags: - Endpoints @@ -1796,27 +1827,27 @@ paths: media, the media stream will be terminated. operationId: deleteEndpoint parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' servers: *ref_5 /accounts/{accountId}/endpoints/{endpointId}/bxml: put: @@ -1826,29 +1857,29 @@ paths: description: Updates the BXML for the specified endpoint. operationId: updateEndpointBxml parameters: - - $ref: "#/components/parameters/accountId5" - - $ref: "#/components/parameters/endpointId" + - $ref: '#/components/parameters/accountId5' + - $ref: '#/components/parameters/endpointId' requestBody: - $ref: "#/components/requestBodies/updateEndpointBxmlRequest" + $ref: '#/components/requestBodies/updateEndpointBxmlRequest' responses: - "204": + '204': description: No Content - "400": - $ref: "#/components/responses/badRequestErrorResponse" - "401": - $ref: "#/components/responses/unauthorizedErrorResponse" - "403": - $ref: "#/components/responses/forbiddenErrorResponse" - "404": - $ref: "#/components/responses/notFoundErrorResponse" - "405": - $ref: "#/components/responses/methodNotAllowedErrorResponse" - "415": - $ref: "#/components/responses/unsupportedMediaTypeErrorResponse" - "429": - $ref: "#/components/responses/tooManyRequestsErrorResponse" - "500": - $ref: "#/components/responses/serviceUnavailableErrorResponse" + '400': + $ref: '#/components/responses/badRequestErrorResponse' + '401': + $ref: '#/components/responses/unauthorizedErrorResponse' + '403': + $ref: '#/components/responses/forbiddenErrorResponse' + '404': + $ref: '#/components/responses/notFoundErrorResponse' + '405': + $ref: '#/components/responses/methodNotAllowedErrorResponse' + '415': + $ref: '#/components/responses/unsupportedMediaTypeErrorResponse' + '429': + $ref: '#/components/responses/tooManyRequestsErrorResponse' + '500': + $ref: '#/components/responses/serviceUnavailableErrorResponse' servers: *ref_5 components: schemas: @@ -1943,11 +1974,11 @@ components: has limitTotalCount set to true this value is limited to 10,000. example: 100 pageInfo: - $ref: "#/components/schemas/pageInfo" + $ref: '#/components/schemas/pageInfo' messages: type: array items: - $ref: "#/components/schemas/listMessageItem" + $ref: '#/components/schemas/listMessageItem' listMessageItem: title: listMessageItem type: object @@ -1959,23 +1990,23 @@ components: accountId: type: string description: The account id associated with this message. - example: "9900000" + example: '9900000' sourceTn: type: string description: The source phone number of the message. - example: "+15554443333" + example: '+15554443333' destinationTn: type: string description: The recipient phone number of the message. - example: "+15554442222" + example: '+15554442222' messageStatus: - $ref: "#/components/schemas/messageStatusEnum" + $ref: '#/components/schemas/messageStatusEnum' messageDirection: - $ref: "#/components/schemas/listMessageDirectionEnum" + $ref: '#/components/schemas/listMessageDirectionEnum' messageType: - $ref: "#/components/schemas/messageTypeEnum" + $ref: '#/components/schemas/messageTypeEnum' segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' errorCode: type: integer description: The numeric error code of the message. @@ -2100,7 +2131,7 @@ components: fieldErrors: type: array items: - $ref: "#/components/schemas/fieldError" + $ref: '#/components/schemas/fieldError' required: - type - description @@ -2141,7 +2172,7 @@ components: 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" + example: '2021-02-01T11:29:18-05:00' carrierName: type: string description: >- @@ -2163,18 +2194,18 @@ components: owner: type: string description: The Bandwidth phone number associated with the message. - example: "+15554443333" + example: '+15554443333' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' time: type: string format: date-time description: The datetime stamp of the message in ISO 8601 example: 2024-12-02T20:15:57.278Z segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: uniqueItems: true type: array @@ -2182,11 +2213,11 @@ components: type: string description: The phone number recipients of the message. example: - - "+15552223333" + - '+15552223333' from: type: string description: The phone number the message was sent from. - example: "+15553332222" + example: '+15553332222' media: uniqueItems: true type: array @@ -2204,11 +2235,11 @@ components: description: The contents of the message. example: Hello world tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' messageRequest: title: MessageRequest type: object @@ -2218,14 +2249,14 @@ components: - from properties: applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' to: uniqueItems: true type: array description: The phone number(s) the message should be sent to in E164 format. example: - - "+15554443333" - - "+15552223333" + - '+15554443333' + - '+15552223333' items: type: string from: @@ -2239,17 +2270,17 @@ components: letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. - example: "+15551113333" + example: '+15551113333' text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' media: - $ref: "#/components/schemas/messageMedia" + $ref: '#/components/schemas/messageMedia' tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' messageText: type: string description: The contents of the text message. Must be 2048 characters or less. @@ -2273,14 +2304,14 @@ components: links: type: array items: - $ref: "#/components/schemas/link" + $ref: '#/components/schemas/link' example: [] data: - $ref: "#/components/schemas/multiChannelMessageResponseData" + $ref: '#/components/schemas/multiChannelMessageResponseData' errors: type: array items: - $ref: "#/components/schemas/errorObject" + $ref: '#/components/schemas/errorObject' example: [] multiChannelError: type: object @@ -2288,7 +2319,7 @@ components: links: type: array items: - $ref: "#/components/schemas/link" + $ref: '#/components/schemas/link' example: [] data: type: object @@ -2297,7 +2328,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/errorObject" + $ref: '#/components/schemas/errorObject' link: type: object properties: @@ -2315,7 +2346,7 @@ components: description: A detailed explanation of the error. type: string source: - $ref: "#/components/schemas/errorSource" + $ref: '#/components/schemas/errorSource' required: - type - description @@ -2352,13 +2383,13 @@ components: multiChannelDestination: type: string description: The phone number the message should be sent to in E164 format. - example: "+15552223333" + example: '+15552223333' multiChannelDestinations: uniqueItems: true type: array description: The destination phone number(s) of the message, in E164 format. example: - - "+15554443333" + - '+15554443333' items: type: string rbmMessageContentText: @@ -2373,7 +2404,7 @@ components: maxLength: 3270 example: Hello world suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - text rbmMediaHeightEnum: @@ -2429,9 +2460,9 @@ components: media: type: array items: - $ref: "#/components/schemas/rbmMessageContentFile" + $ref: '#/components/schemas/rbmMessageContentFile' suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - media rbmCardContent: @@ -2450,11 +2481,11 @@ components: example: Bandwidth is a communications platform as a service (CPaaS) company. media: allOf: - - $ref: "#/components/schemas/rbmMessageContentFile" + - $ref: '#/components/schemas/rbmMessageContentFile' - type: object properties: height: - $ref: "#/components/schemas/rbmMediaHeightEnum" + $ref: '#/components/schemas/rbmMediaHeightEnum' required: - height suggestions: @@ -2463,20 +2494,20 @@ components: displayed on the rich card. type: array items: - $ref: "#/components/schemas/multiChannelAction" + $ref: '#/components/schemas/multiChannelAction' maxItems: 4 rbmStandaloneCard: title: Standalone Card type: object properties: orientation: - $ref: "#/components/schemas/standaloneCardOrientationEnum" + $ref: '#/components/schemas/standaloneCardOrientationEnum' thumbnailImageAlignment: - $ref: "#/components/schemas/thumbnailAlignmentEnum" + $ref: '#/components/schemas/thumbnailAlignmentEnum' cardContent: - $ref: "#/components/schemas/rbmCardContent" + $ref: '#/components/schemas/rbmCardContent' suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - orientation - cardContent @@ -2500,15 +2531,15 @@ components: type: object properties: cardWidth: - $ref: "#/components/schemas/cardWidthEnum" + $ref: '#/components/schemas/cardWidthEnum' cardContents: type: array items: - $ref: "#/components/schemas/rbmCardContent" + $ref: '#/components/schemas/rbmCardContent' minItems: 2 maxItems: 10 suggestions: - $ref: "#/components/schemas/multiChannelFullActions" + $ref: '#/components/schemas/multiChannelFullActions' required: - cardContents - cardWidth @@ -2523,7 +2554,7 @@ components: type: object properties: text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' required: - text mmsMessageContent: @@ -2531,16 +2562,16 @@ components: type: object properties: text: - $ref: "#/components/schemas/messageText" + $ref: '#/components/schemas/messageText' media: type: array items: - $ref: "#/components/schemas/mmsMessageContentFile" + $ref: '#/components/schemas/mmsMessageContentFile' rbmMessageContentRichCard: title: RBM Rich Card oneOf: - - $ref: "#/components/schemas/rbmStandaloneCard" - - $ref: "#/components/schemas/rbmMessageCarouselCard" + - $ref: '#/components/schemas/rbmStandaloneCard' + - $ref: '#/components/schemas/rbmMessageCarouselCard' rbmActionTypeEnum: type: string enum: @@ -2601,30 +2632,30 @@ components: type: object properties: type: - $ref: "#/components/schemas/rbmActionTypeEnum" + $ref: '#/components/schemas/rbmActionTypeEnum' text: - $ref: "#/components/schemas/rbmActionText" + $ref: '#/components/schemas/rbmActionText' postbackData: - $ref: "#/components/schemas/rbmActionPostbackData" + $ref: '#/components/schemas/rbmActionPostbackData' required: - text - postbackData - type rbmActionDial: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $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" + example: '+15552223333' required: - phoneNumber rbmActionViewLocation: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Show Location type: object properties: @@ -2634,14 +2665,14 @@ components: description: >- The latitude of the location. Must be in range [-90.000000, 90.000000]. - example: "37.7749" + example: '37.7749' longitude: type: string format: double description: >- The longitude of the location. Must be in range [-180.000000, 180.000000]. - example: "-122.4194" + example: '-122.4194' label: type: string description: The label of the location. @@ -2652,7 +2683,7 @@ components: - longitude multiChannelActionCalendarEvent: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Calendar Event type: object properties: @@ -2686,7 +2717,7 @@ components: - endTime rbmActionOpenUrl: allOf: - - $ref: "#/components/schemas/rbmActionBase" + - $ref: '#/components/schemas/rbmActionBase' - title: Open URL type: object properties: @@ -2697,100 +2728,100 @@ components: example: https://dev.bandwidth.com maxLength: 2048 application: - $ref: "#/components/schemas/rbmOpenUrlEnum" + $ref: '#/components/schemas/rbmOpenUrlEnum' webviewViewMode: - $ref: "#/components/schemas/rbmWebViewEnum" + $ref: '#/components/schemas/rbmWebViewEnum' required: - url multiChannelFullActions: type: array description: An array of suggested actions for the recipient. items: - $ref: "#/components/schemas/multiChannelAction" + $ref: '#/components/schemas/multiChannelAction' maxItems: 11 multiChannelAction: anyOf: - - $ref: "#/components/schemas/rbmActionBase" - - $ref: "#/components/schemas/rbmActionDial" - - $ref: "#/components/schemas/rbmActionViewLocation" - - $ref: "#/components/schemas/multiChannelActionCalendarEvent" - - $ref: "#/components/schemas/rbmActionOpenUrl" + - $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" + 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' multiChannelChannelListObjectBase: type: object properties: from: - $ref: "#/components/schemas/multiChannelSenderId" + $ref: '#/components/schemas/multiChannelSenderId' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' channel: - $ref: "#/components/schemas/multiChannelMessageChannelEnum" + $ref: '#/components/schemas/multiChannelMessageChannelEnum' required: - from - applicationId - channel multiChannelChannelListRBMObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: description: The content of the message. oneOf: - - $ref: "#/components/schemas/rbmMessageContentText" - - $ref: "#/components/schemas/rbmMessageMedia" - - $ref: "#/components/schemas/rbmMessageContentRichCard" + - $ref: '#/components/schemas/rbmMessageContentText' + - $ref: '#/components/schemas/rbmMessageMedia' + - $ref: '#/components/schemas/rbmMessageContentRichCard' required: - content multiChannelChannelListSMSObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: - $ref: "#/components/schemas/smsMessageContent" + $ref: '#/components/schemas/smsMessageContent' required: - content multiChannelChannelListMMSObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListObjectBase" + - $ref: '#/components/schemas/multiChannelChannelListObjectBase' - type: object properties: content: - $ref: "#/components/schemas/mmsMessageContent" + $ref: '#/components/schemas/mmsMessageContent' required: - content multiChannelChannelListRBMResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListSMSResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListSMSObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListSMSObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListMMSResponseObject: allOf: - - $ref: "#/components/schemas/multiChannelChannelListMMSObject" - - $ref: "#/components/schemas/multiChannelChannelListOwnerObject" + - $ref: '#/components/schemas/multiChannelChannelListMMSObject' + - $ref: '#/components/schemas/multiChannelChannelListOwnerObject' multiChannelChannelListRequestObject: anyOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMObject" - - $ref: "#/components/schemas/multiChannelChannelListSMSObject" - - $ref: "#/components/schemas/multiChannelChannelListMMSObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMObject' + - $ref: '#/components/schemas/multiChannelChannelListSMSObject' + - $ref: '#/components/schemas/multiChannelChannelListMMSObject' discriminator: propertyName: channel mapping: - RBM: "#/components/schemas/multiChannelChannelListRBMObject" - SMS: "#/components/schemas/multiChannelChannelListSMSObject" - MMS: "#/components/schemas/multiChannelChannelListMMSObject" + RBM: '#/components/schemas/multiChannelChannelListRBMObject' + SMS: '#/components/schemas/multiChannelChannelListSMSObject' + MMS: '#/components/schemas/multiChannelChannelListMMSObject' multiChannelChannelListOwnerObject: type: object properties: @@ -2803,21 +2834,21 @@ components: - owner multiChannelChannelListResponseObject: anyOf: - - $ref: "#/components/schemas/multiChannelChannelListRBMResponseObject" - - $ref: "#/components/schemas/multiChannelChannelListSMSResponseObject" - - $ref: "#/components/schemas/multiChannelChannelListMMSResponseObject" + - $ref: '#/components/schemas/multiChannelChannelListRBMResponseObject' + - $ref: '#/components/schemas/multiChannelChannelListSMSResponseObject' + - $ref: '#/components/schemas/multiChannelChannelListMMSResponseObject' discriminator: propertyName: channel mapping: - RBM: "#/components/schemas/multiChannelChannelListRBMResponseObject" - SMS: "#/components/schemas/multiChannelChannelListSMSResponseObject" - MMS: "#/components/schemas/multiChannelChannelListMMSResponseObject" + RBM: '#/components/schemas/multiChannelChannelListRBMResponseObject' + SMS: '#/components/schemas/multiChannelChannelListSMSResponseObject' + MMS: '#/components/schemas/multiChannelChannelListMMSResponseObject' multiChannelMessageRequest: description: Multi-Channel Message Request type: object properties: to: - $ref: "#/components/schemas/multiChannelDestination" + $ref: '#/components/schemas/multiChannelDestination' channelList: type: array description: >- @@ -2825,14 +2856,14 @@ components: order they are listed. Once a message sends successfully, the others will be ignored. items: - $ref: "#/components/schemas/multiChannelChannelListRequestObject" + $ref: '#/components/schemas/multiChannelChannelListRequestObject' maxItems: 4 tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' required: - to - channelList @@ -2841,16 +2872,16 @@ components: type: object properties: id: - $ref: "#/components/schemas/id" + $ref: '#/components/schemas/id' time: description: The time the message was received by the Bandwidth API. type: string format: date-time example: 2025-01-01T18:20:16.000Z direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: - $ref: "#/components/schemas/multiChannelDestinations" + $ref: '#/components/schemas/multiChannelDestinations' channelList: type: array description: >- @@ -2858,14 +2889,14 @@ components: order they are listed. Once a message sends successfully, the others will be ignored. items: - $ref: "#/components/schemas/multiChannelChannelListResponseObject" + $ref: '#/components/schemas/multiChannelChannelListResponseObject' maxItems: 4 tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' expiration: - $ref: "#/components/schemas/expiration" + $ref: '#/components/schemas/expiration' required: - id - time @@ -2879,7 +2910,7 @@ components: text: type: string media: - $ref: "#/components/schemas/rbmMessageContentFile" + $ref: '#/components/schemas/rbmMessageContentFile' rbmSuggestionResponse: type: object properties: @@ -2888,7 +2919,7 @@ components: description: The text associated with the suggestion response. example: Yes, I would like to proceed postbackData: - $ref: "#/components/schemas/rbmActionPostbackData" + $ref: '#/components/schemas/rbmActionPostbackData' pairedMessageId: type: string nullable: true @@ -2901,12 +2932,12 @@ components: type: string format: double description: The latitude of the client's location. - example: "37.7749" + example: '37.7749' longitude: type: string format: double description: The longitude of the client's location. - example: "-122.4194" + example: '-122.4194' callback: description: >- Callbacks are divided into two types based on direction of the related @@ -2919,19 +2950,19 @@ components: message client's response to a suggestion or location request. type: object oneOf: - - $ref: "#/components/schemas/statusCallback" - - $ref: "#/components/schemas/inboundCallback" + - $ref: '#/components/schemas/statusCallback' + - $ref: '#/components/schemas/inboundCallback' discriminator: propertyName: type mapping: - message-sending: "#/components/schemas/statusCallback" - message-sent: "#/components/schemas/statusCallback" - message-delivered: "#/components/schemas/statusCallback" - message-failed: "#/components/schemas/statusCallback" - message-read: "#/components/schemas/statusCallback" - message-received: "#/components/schemas/inboundCallback" - requested-location-response: "#/components/schemas/inboundCallback" - suggestion-response: "#/components/schemas/inboundCallback" + message-sending: '#/components/schemas/statusCallback' + message-sent: '#/components/schemas/statusCallback' + message-delivered: '#/components/schemas/statusCallback' + message-failed: '#/components/schemas/statusCallback' + message-read: '#/components/schemas/statusCallback' + message-received: '#/components/schemas/inboundCallback' + requested-location-response: '#/components/schemas/inboundCallback' + suggestion-response: '#/components/schemas/inboundCallback' statusCallback: type: object description: >- @@ -2950,7 +2981,7 @@ components: format: date-time example: 2024-12-02T20:15:58.278Z type: - $ref: "#/components/schemas/statusCallbackTypeEnum" + $ref: '#/components/schemas/statusCallbackTypeEnum' to: type: string description: >- @@ -2958,19 +2989,19 @@ components: For status callbacks, this the the Bandwidth user's client phone number. - example: "+15552223333" + example: '+15552223333' description: type: string description: A detailed description of the event described by the callback. example: Message delivered to handset. message: - $ref: "#/components/schemas/statusCallbackMessage" + $ref: '#/components/schemas/statusCallbackMessage' errorCode: type: integer description: Optional error code, applicable only when type is `message-failed`. example: 4405 carrierName: - $ref: "#/components/schemas/carrierName" + $ref: '#/components/schemas/carrierName' required: - time - type @@ -2986,7 +3017,7 @@ components: format: date-time example: 2024-12-02T20:15:57.278Z type: - $ref: "#/components/schemas/inboundCallbackTypeEnum" + $ref: '#/components/schemas/inboundCallbackTypeEnum' to: type: string description: > @@ -2994,15 +3025,15 @@ components: For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. - example: "+15552223333" + example: '+15552223333' description: type: string description: A detailed description of the event described by the callback. example: Incoming message received message: - $ref: "#/components/schemas/inboundCallbackMessage" + $ref: '#/components/schemas/inboundCallbackMessage' carrierName: - $ref: "#/components/schemas/carrierName" + $ref: '#/components/schemas/carrierName' required: - time - type @@ -3069,17 +3100,17 @@ components: description: >- The Bandwidth phone number or alphanumeric identifier associated with the message. - example: "+15553332222" + example: '+15553332222' applicationId: - $ref: "#/components/schemas/applicationId" + $ref: '#/components/schemas/applicationId' time: type: string format: date-time example: 2024-12-02T20:15:57.666Z segmentCount: - $ref: "#/components/schemas/segmentCount" + $ref: '#/components/schemas/segmentCount' direction: - $ref: "#/components/schemas/messageDirectionEnum" + $ref: '#/components/schemas/messageDirectionEnum' to: description: The phone number recipients of the message. uniqueItems: true @@ -3087,18 +3118,18 @@ components: items: type: string example: - - "+15552223333" + - '+15552223333' from: type: string description: >- The Bandwidth phone number or alphanumeric identifier the message was sent from. - example: "+15553332222" + example: '+15553332222' text: type: string example: Hello world tag: - $ref: "#/components/schemas/tag" + $ref: '#/components/schemas/tag' media: type: array description: Optional media, not applicable for sms @@ -3109,9 +3140,9 @@ components: - https://dev.bandwidth.com/images/bandwidth-logo.png - https://dev.bandwidth.com/images/github_logo.png priority: - $ref: "#/components/schemas/priorityEnum" + $ref: '#/components/schemas/priorityEnum' channel: - $ref: "#/components/schemas/multiChannelMessageChannelEnum" + $ref: '#/components/schemas/multiChannelMessageChannelEnum' required: - id - owner @@ -3123,15 +3154,15 @@ components: - from inboundCallbackMessage: allOf: - - $ref: "#/components/schemas/statusCallbackMessage" + - $ref: '#/components/schemas/statusCallbackMessage' - type: object properties: content: - $ref: "#/components/schemas/multiChannelMessageContent" + $ref: '#/components/schemas/multiChannelMessageContent' suggestionResponse: - $ref: "#/components/schemas/rbmSuggestionResponse" + $ref: '#/components/schemas/rbmSuggestionResponse' locationResponse: - $ref: "#/components/schemas/rbmLocationResponse" + $ref: '#/components/schemas/rbmLocationResponse' required: - id - owner @@ -3273,7 +3304,7 @@ components: (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). - example: "+19195551234" + example: '+19195551234' from: type: string description: >- @@ -3281,7 +3312,7 @@ components: from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. - example: "+15555551212" + example: '+15555551212' privacy: nullable: true type: boolean @@ -3344,7 +3375,7 @@ components: maxLength: 2048 example: https://www.myCallbackServer.example/webhooks/answer answerMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -3372,7 +3403,7 @@ components: maxLength: 2048 example: https://www.myFallbackServer.example/webhooks/answer answerFallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' fallbackUsername: type: string nullable: true @@ -3396,7 +3427,7 @@ components: maxLength: 2048 example: https://www.myCallbackServer.example/webhooks/disconnect disconnectMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' callTimeout: nullable: true type: number @@ -3431,7 +3462,7 @@ components: default: 15 example: 15 machineDetection: - $ref: "#/components/schemas/machineDetectionConfiguration" + $ref: '#/components/schemas/machineDetectionConfiguration' priority: nullable: true type: integer @@ -3493,7 +3524,7 @@ components: description: The id of the application associated with the `from` number. accountId: type: string - example: "9900000" + example: '9900000' description: The bandwidth account ID associated with the call. callId: type: string @@ -3501,18 +3532,18 @@ components: description: Programmable Voice API Call ID. to: type: string - example: "+19195551234" + example: '+19195551234' description: Recipient of the outgoing call. from: type: string - example: "+19195554321" + example: '+19195554321' description: Phone number that created the outbound call. enqueuedTime: nullable: true type: string format: date-time description: The time at which the call was accepted into the queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' callUrl: type: string format: uri @@ -3539,14 +3570,14 @@ components: example: My custom tag value description: Custom tag value. answerMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' answerUrl: type: string format: uri example: https://myServer.example/bandwidth/webhooks/answer description: URL to deliver the `answer` event webhook. answerFallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' answerFallbackUrl: nullable: true type: string @@ -3554,7 +3585,7 @@ components: example: https://myFallbackServer.example/bandwidth/webhooks/answer description: Fallback URL to deliver the `answer` event webhook. disconnectMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' disconnectUrl: nullable: true type: string @@ -3600,7 +3631,7 @@ components: accountId: type: string description: The account id associated with the call. - example: "9900000" + example: '9900000' callId: type: string description: The programmable voice API call ID. @@ -3617,15 +3648,15 @@ components: description: >- The phone number that received the call, in E.164 format (e.g. +15555555555), or if the call was to a SIP URI, the SIP URI. - example: "+19195551234" + example: '+19195551234' from: type: string description: >- The phone number that made the call, in E.164 format (e.g. +15555555555). - example: "+19195554321" + example: '+19195554321' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' state: description: >- The current state of the call. Current possible values are @@ -3695,7 +3726,7 @@ components: type: string format: date-time description: The time this call was placed in queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' startTime: nullable: true type: string @@ -3703,7 +3734,7 @@ components: description: >- The time the call was initiated, in ISO 8601 format. `null` if the call is still in your queue. - example: "2022-06-16T13:15:07.160Z" + example: '2022-06-16T13:15:07.160Z' answerTime: nullable: true type: string @@ -3711,13 +3742,13 @@ components: description: >- Populated once the call has been answered, with the time in ISO 8601 format. - example: "2022-06-16T13:15:18.126Z" + example: '2022-06-16T13:15:18.126Z' endTime: nullable: true type: string format: date-time description: Populated once the call has ended, with the time in ISO 8601 format. - example: "2022-06-16T13:15:18.314Z" + example: '2022-06-16T13:15:18.314Z' disconnectCause: nullable: true type: string @@ -3780,12 +3811,12 @@ components: type: string format: date-time description: The last time the call had a state update, in ISO 8601 format. - example: "2022-06-16T13:15:18.314Z" + example: '2022-06-16T13:15:18.314Z' updateCall: type: object properties: state: - $ref: "#/components/schemas/callStateEnum" + $ref: '#/components/schemas/callStateEnum' redirectUrl: description: |- The URL to send the [Redirect](/docs/voice/bxml/redirect) event @@ -3799,7 +3830,7 @@ components: format: uri example: https://myServer.example/bandwidth/webhooks/redirect redirectMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' username: type: string nullable: true @@ -3821,7 +3852,7 @@ components: redirect callback delivery in case `redirectUrl` fails to respond. example: https://myFallbackServer.example/bandwidth/webhooks/redirect redirectFallbackMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' fallbackUsername: type: string nullable: true @@ -3861,7 +3892,7 @@ components: - state properties: state: - $ref: "#/components/schemas/recordingStateEnum" + $ref: '#/components/schemas/recordingStateEnum' accountStatistics: type: object properties: @@ -3879,43 +3910,43 @@ components: type: object properties: applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' transcription: - $ref: "#/components/schemas/recordingTranscriptionMetadata" + $ref: '#/components/schemas/recordingTranscriptionMetadata' recordingName: - $ref: "#/components/schemas/recordingName" + $ref: '#/components/schemas/recordingName' conference: type: object properties: @@ -3931,13 +3962,13 @@ components: type: string format: date-time description: The time the conference was initiated, in ISO 8601 format. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' completedTime: nullable: true type: string format: date-time description: The time the conference was terminated, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' conferenceEventUrl: nullable: true type: string @@ -3945,7 +3976,7 @@ components: description: The URL to send the conference-related events. example: https://myServer.example/bandwidth/webhooks/conferenceEvent conferenceEventMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' tag: nullable: true type: string @@ -3957,7 +3988,7 @@ components: type: array nullable: true items: - $ref: "#/components/schemas/conferenceMember" + $ref: '#/components/schemas/conferenceMember' description: >- A list of active members of the conference. Omitted if this @@ -3967,7 +3998,7 @@ components: type: object properties: status: - $ref: "#/components/schemas/conferenceStateEnum" + $ref: '#/components/schemas/conferenceStateEnum' redirectUrl: nullable: true type: string @@ -3982,7 +4013,7 @@ components: but required if `state` is `active`. example: https://myServer.example/bandwidth/webhooks/conferenceRedirect redirectMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' username: type: string nullable: true @@ -4009,7 +4040,7 @@ components: example: >- https://myFallbackServer.example/bandwidth/webhooks/conferenceRedirect redirectFallbackMethod: - $ref: "#/components/schemas/redirectMethodEnum" + $ref: '#/components/schemas/redirectMethodEnum' fallbackUsername: type: string nullable: true @@ -4026,9 +4057,9 @@ components: type: object properties: callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' memberUrl: type: string format: uri @@ -4136,29 +4167,29 @@ components: type: object properties: accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' recordingName: - $ref: "#/components/schemas/recordingName" + $ref: '#/components/schemas/recordingName' machineDetectionConfiguration: type: object description: >- @@ -4170,7 +4201,7 @@ components: information. properties: mode: - $ref: "#/components/schemas/machineDetectionModeEnum" + $ref: '#/components/schemas/machineDetectionModeEnum' detectionTimeout: nullable: true type: number @@ -4259,7 +4290,7 @@ components: maxLength: 2048 example: https://myServer.example/bandwidth/webhooks/machineDetectionComplete callbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -4287,7 +4318,7 @@ components: example: >- https://myFallbackServer.example/bandwidth/webhooks/machineDetectionComplete fallbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' fallbackUsername: type: string nullable: true @@ -4319,7 +4350,7 @@ components: password fields for authorization. example: https://myServer.example/bandwidth/webhooks/transcriptionAvailable callbackMethod: - $ref: "#/components/schemas/callbackMethodEnum" + $ref: '#/components/schemas/callbackMethodEnum' username: type: string nullable: true @@ -4333,7 +4364,7 @@ components: maxLength: 1024 example: mySecretPassword1! tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' callbackTimeout: nullable: true type: number @@ -4365,14 +4396,14 @@ components: transcripts: type: array items: - $ref: "#/components/schemas/transcription" + $ref: '#/components/schemas/transcription' clips: type: array description: >- A list of individual speech clips with speaker, timing, and confidence information. items: - $ref: "#/components/schemas/recordingTranscriptionClip" + $ref: '#/components/schemas/recordingTranscriptionClip' example: transcripts: - speaker: 0 @@ -4435,7 +4466,7 @@ components: callTranscriptionMetadataList: type: array items: - $ref: "#/components/schemas/callTranscriptionMetadata" + $ref: '#/components/schemas/callTranscriptionMetadata' example: - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b transcriptionName: live_transcription @@ -4471,7 +4502,7 @@ components: accountId: type: string description: The user account associated with the call. - example: "9900000" + example: '9900000' callId: type: string description: The call id associated with the event. @@ -4483,7 +4514,7 @@ components: tracks: type: array items: - $ref: "#/components/schemas/callTranscription" + $ref: '#/components/schemas/callTranscription' example: - detectedLanguage: en-US track: inbound @@ -4493,9 +4524,9 @@ components: type: object properties: detectedLanguage: - $ref: "#/components/schemas/callTranscriptionDetectedLanguageEnum" + $ref: '#/components/schemas/callTranscriptionDetectedLanguageEnum' track: - $ref: "#/components/schemas/callTranscriptionTrackEnum" + $ref: '#/components/schemas/callTranscriptionTrackEnum' transcript: type: string description: The transcription itself. @@ -4519,12 +4550,12 @@ components: description: The unique transcription ID example: t-387bd648-18f3-4823-9d16-746bca0003c9 status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' completedTime: type: string format: date-time description: The time that the transcription was completed - example: "2022-06-13T18:46:29.715Z" + example: '2022-06-13T18:46:29.715Z' url: type: string format: uri @@ -4548,35 +4579,35 @@ components: request when an outbound call is answered. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' machineDetectionResult: - $ref: "#/components/schemas/machineDetectionResult" + $ref: '#/components/schemas/machineDetectionResult' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' bridgeCompleteCallback: type: object description: >- @@ -4587,37 +4618,37 @@ components: calls to be bridged. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' bridgeTargetCompleteCallback: type: object description: >- @@ -4627,31 +4658,31 @@ components: is NOT sent. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceCreatedCallback: type: object description: >- @@ -4665,15 +4696,15 @@ components: conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceRedirectCallback: type: object description: >- @@ -4687,15 +4718,15 @@ components: audio verbs that are played into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceMemberJoinCallback: type: object description: >- @@ -4709,21 +4740,21 @@ components: into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceMemberExitCallback: type: object description: >- @@ -4737,21 +4768,21 @@ components: into the conference. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceCompletedCallback: type: object description: >- @@ -4759,15 +4790,15 @@ components: conference. The response to this event may not contain BXML. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' conferenceRecordingAvailableCallback: type: object description: >- @@ -4776,75 +4807,75 @@ components: available for download. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' conferenceId: - $ref: "#/components/schemas/conferenceId" + $ref: '#/components/schemas/conferenceId' name: - $ref: "#/components/schemas/name" + $ref: '#/components/schemas/name' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' disconnectCallback: type: object description: The Disconnect event is fired when a call ends, for any reason. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' sipResponseCode: - $ref: "#/components/schemas/sipResponseCode" + $ref: '#/components/schemas/sipResponseCode' dtmfCallback: type: object description: >- @@ -4852,39 +4883,39 @@ components: verb is executed. You may not respond to this event with BXML. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' digit: - $ref: "#/components/schemas/digit" + $ref: '#/components/schemas/digit' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' gatherCallback: type: object description: >- @@ -4892,41 +4923,41 @@ components: is to report the gathered digits to the calling application. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' digits: - $ref: "#/components/schemas/digits" + $ref: '#/components/schemas/digits' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' terminatingDigit: - $ref: "#/components/schemas/terminatingDigit" + $ref: '#/components/schemas/terminatingDigit' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' initiateCallback: type: object description: >- @@ -4936,35 +4967,35 @@ components: telephone number belongs to. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' diversion: - $ref: "#/components/schemas/diversion" + $ref: '#/components/schemas/diversion' stirShaken: - $ref: "#/components/schemas/stirShaken" + $ref: '#/components/schemas/stirShaken' uui: - $ref: "#/components/schemas/uui" + $ref: '#/components/schemas/uui' sipCallId: - $ref: "#/components/schemas/sipCallId" + $ref: '#/components/schemas/sipCallId' sipHeaders: - $ref: "#/components/schemas/sipHeaders" + $ref: '#/components/schemas/sipHeaders' machineDetectionCompleteCallback: type: object description: >- @@ -4974,33 +5005,33 @@ components: event is not sent when sync answering machine detection mode is chosen. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' machineDetectionResult: - $ref: "#/components/schemas/machineDetectionResult" + $ref: '#/components/schemas/machineDetectionResult' recordingCompleteCallback: type: object description: >- @@ -5010,49 +5041,49 @@ components: Available event will be sent. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' recordingAvailableCallback: type: object description: >- @@ -5060,49 +5091,49 @@ components: processed. It indicates that the recording is available for download. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' channels: - $ref: "#/components/schemas/channels" + $ref: '#/components/schemas/channels' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' status: - $ref: "#/components/schemas/status" + $ref: '#/components/schemas/status' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' redirectCallback: type: object description: >- @@ -5110,37 +5141,37 @@ components: purpose is to get the next set of verbs from the calling application. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' referCompleteCallback: type: object description: >- @@ -5151,35 +5182,35 @@ components: on the call. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' referCallStatus: - $ref: "#/components/schemas/referCallStatusEnum" + $ref: '#/components/schemas/referCallStatusEnum' referSipResponseCode: - $ref: "#/components/schemas/referSipResponseCode" + $ref: '#/components/schemas/referSipResponseCode' notifySipResponseCode: - $ref: "#/components/schemas/notifySipResponseCode" + $ref: '#/components/schemas/notifySipResponseCode' transcriptionAvailableCallback: type: object description: >- @@ -5187,47 +5218,47 @@ components: transcription is available to be downloaded. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' mediaUrl: - $ref: "#/components/schemas/mediaUrl" + $ref: '#/components/schemas/mediaUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' recordingId: - $ref: "#/components/schemas/recordingId" + $ref: '#/components/schemas/recordingId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' duration: - $ref: "#/components/schemas/duration" + $ref: '#/components/schemas/duration' fileFormat: - $ref: "#/components/schemas/fileFormatEnum" + $ref: '#/components/schemas/fileFormatEnum' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transcription: - $ref: "#/components/schemas/transcription" + $ref: '#/components/schemas/transcription' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' transferAnswerCallback: type: object description: >- @@ -5240,35 +5271,35 @@ components: transferAnswer event, but some are not allowed. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' transferCompleteCallback: type: object description: >- @@ -5279,41 +5310,41 @@ components: transferComplete event corresponds to one of the legs. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' transferDisconnectCallback: type: object description: >- @@ -5325,45 +5356,45 @@ components: the transferred leg. properties: eventType: - $ref: "#/components/schemas/eventType" + $ref: '#/components/schemas/eventType' eventTime: - $ref: "#/components/schemas/eventTime" + $ref: '#/components/schemas/eventTime' accountId: - $ref: "#/components/schemas/accountId" + $ref: '#/components/schemas/accountId' applicationId: - $ref: "#/components/schemas/applicationId1" + $ref: '#/components/schemas/applicationId1' from: - $ref: "#/components/schemas/from" + $ref: '#/components/schemas/from' to: - $ref: "#/components/schemas/to" + $ref: '#/components/schemas/to' direction: - $ref: "#/components/schemas/callDirectionEnum" + $ref: '#/components/schemas/callDirectionEnum' callId: - $ref: "#/components/schemas/callId" + $ref: '#/components/schemas/callId' callUrl: - $ref: "#/components/schemas/callUrl" + $ref: '#/components/schemas/callUrl' parentCallId: - $ref: "#/components/schemas/parentCallId" + $ref: '#/components/schemas/parentCallId' enqueuedTime: - $ref: "#/components/schemas/enqueuedTime" + $ref: '#/components/schemas/enqueuedTime' startTime: - $ref: "#/components/schemas/startTime" + $ref: '#/components/schemas/startTime' answerTime: - $ref: "#/components/schemas/answerTime" + $ref: '#/components/schemas/answerTime' endTime: - $ref: "#/components/schemas/endTime" + $ref: '#/components/schemas/endTime' tag: - $ref: "#/components/schemas/tag1" + $ref: '#/components/schemas/tag1' transferCallerId: - $ref: "#/components/schemas/transferCallerId" + $ref: '#/components/schemas/transferCallerId' transferTo: - $ref: "#/components/schemas/transferTo" + $ref: '#/components/schemas/transferTo' cause: - $ref: "#/components/schemas/cause" + $ref: '#/components/schemas/cause' errorMessage: - $ref: "#/components/schemas/errorMessage" + $ref: '#/components/schemas/errorMessage' errorId: - $ref: "#/components/schemas/errorId" + $ref: '#/components/schemas/errorId' eventType: type: string description: >- @@ -5382,11 +5413,11 @@ components: The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' accountId: type: string description: The user account associated with the call. - example: "9900000" + example: '9900000' applicationId1: type: string description: The id of the application associated with the call. @@ -5396,13 +5427,13 @@ components: description: >- The phone number that received the call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' from: type: string description: >- The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' conferenceId: type: string description: The unique, Bandwidth-generated ID of the conference that was recorded @@ -5429,43 +5460,43 @@ components: digit: type: string description: The digit collected in the call. - example: "2" + example: '2' digits: type: string description: >- (optional) The digits, letters, and/or symbols entered by the user. The string is empty if a timeout occurred before any buttons were pressed. - example: "123" + example: '123' terminatingDigit: type: string description: >- (optional) The digit the user pressed to end the gather. Empty string value if no terminating digit was pressed. - example: "#" + example: '#' startTime: type: string format: date-time description: Time the call was started, in ISO 8601 format. - example: "2022-06-17T22:19:40.375Z" + example: '2022-06-17T22:19:40.375Z' enqueuedTime: type: string format: date-time description: >- (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' nullable: true answerTime: type: string format: date-time description: Time the call was answered, in ISO 8601 format. - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' nullable: true endTime: type: string format: date-time description: The time that the recording ended in ISO-8601 format - example: "2022-06-17T22:20:00.000Z" + example: '2022-06-17T22:20:00.000Z' status: type: string description: >- @@ -5481,13 +5512,13 @@ components: description: >- The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' transferTo: type: string description: >- The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). - example: "+15555555555" + example: '+15555555555' mediaUrl: nullable: true type: string @@ -5592,21 +5623,21 @@ components: privacy: type: string description: off or full - example: "off" + example: 'off' screen: type: string description: >- No if the number was provided by the user, yes if the number was provided by the network - example: "no" + example: 'no' counter: type: string description: The number of diversions that have occurred - example: "2" + example: '2' limit: type: string description: The maximum number of diversions allowed for this session - example: "3" + example: '3' unknown: type: string description: >- @@ -5618,7 +5649,7 @@ components: description: >- Always present. Indicates the last telephone number that the call was diverted from. - example: "+15558884444" + example: '+15558884444' transcription: type: object properties: @@ -5703,13 +5734,13 @@ components: type: string description: The phone number to send the mfa code to. pattern: ^\+[1-9]\d{1,14}$ - example: "+19195551234" + example: '+19195551234' from: type: string description: The application phone number, the sender of the mfa code. pattern: ^\+[1-9]\d{1,14}$ maxLength: 32 - example: "+19195554321" + example: '+19195554321' applicationId: type: string description: The application unique ID, obtained from Bandwidth. @@ -5769,7 +5800,7 @@ components: type: string description: The phone number to send the mfa code to. pattern: ^\+[1-9]\d{1,14}$ - example: "+19195551234" + example: '+19195551234' scope: type: string description: >- @@ -5791,7 +5822,7 @@ components: description: The generated mfa code to check if valid. minLength: 4 maxLength: 8 - example: "123456" + example: '123456' required: - to - expirationTimeInMinutes @@ -5933,8 +5964,8 @@ components: type: string description: Phone number experiencing the error. example: - - "+13992077164" - - "+19196104424" + - '+13992077164' + - '+19196104424' message: type: string description: Message describing the error @@ -5988,27 +6019,27 @@ components: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/completedLookupStatusEnum" + $ref: '#/components/schemas/completedLookupStatusEnum' results: type: array description: >- The carrier information results for the specified telephone numbers. items: - $ref: "#/components/schemas/lookupResult" + $ref: '#/components/schemas/lookupResult' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' createAsyncBulkLookupResponse: type: object properties: @@ -6016,53 +6047,53 @@ components: type: array description: Links for pagination (if applicable) items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/inProgressLookupStatusEnum" + $ref: '#/components/schemas/inProgressLookupStatusEnum' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' getAsyncBulkLookupResponse: type: object properties: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object description: The phone number lookup response data properties: requestId: - $ref: "#/components/schemas/requestId" + $ref: '#/components/schemas/requestId' status: - $ref: "#/components/schemas/inProgressLookupStatusEnum" + $ref: '#/components/schemas/inProgressLookupStatusEnum' results: type: array description: >- The carrier information results for the specified telephone number. items: - $ref: "#/components/schemas/lookupResult" + $ref: '#/components/schemas/lookupResult' errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' lookupErrorResponse: type: object properties: links: type: array items: - $ref: "#/components/schemas/linkSchema" + $ref: '#/components/schemas/linkSchema' example: [] data: type: object @@ -6070,7 +6101,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/lookupErrorSchema" + $ref: '#/components/schemas/lookupErrorSchema' rcsErrorEnum: type: string description: >- @@ -6111,9 +6142,9 @@ components: phoneNumber: type: string description: The telephone number in E.164 format. - example: "+10072904498" + example: '+10072904498' lineType: - $ref: "#/components/schemas/lineTypeEnum" + $ref: '#/components/schemas/lineTypeEnum' messagingProvider: type: string description: The messaging service provider of the telephone number. @@ -6143,9 +6174,9 @@ components: deactivation event. example: 2025-06-20 18:35 deactivationEvent: - $ref: "#/components/schemas/deactivationEventEnum" + $ref: '#/components/schemas/deactivationEventEnum' latestMessageDeliveryStatus: - $ref: "#/components/schemas/latestMessageDeliveryStatusEnum" + $ref: '#/components/schemas/latestMessageDeliveryStatusEnum' initialMessageDeliveryStatusDate: type: string format: date @@ -6156,7 +6187,7 @@ components: Think of this as the "start time" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. - example: "2025-06-20" + example: '2025-06-20' latestMessageDeliveryStatusDate: type: string format: date @@ -6168,7 +6199,7 @@ components: `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. - example: "2025-06-21" + example: '2025-06-21' rcsEnabled: type: boolean description: > @@ -6180,7 +6211,7 @@ components: accountId1: type: string description: User's account ID. - example: "1234567" + example: '1234567' tfPhoneNumber: type: string description: Toll-free telephone number in E.164 format. @@ -6188,13 +6219,13 @@ components: maxLength: 12 nullable: false pattern: ^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$ - example: "+18005555555" + example: '+18005555555' tfvWebhookErrors: type: array description: Details of the errors that were encountered when processing the request. items: type: string - example: "optInWorkflowImageURLs: Entries must be a valid array of objects." + example: 'optInWorkflowImageURLs: Entries must be a valid array of objects.' tfvCallbackStatusEnum: type: string enum: @@ -6231,11 +6262,11 @@ components: type: object properties: statusCode: - $ref: "#/components/schemas/denialStatusCode" + $ref: '#/components/schemas/denialStatusCode' reason: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' required: - statusCode - reason @@ -6273,10 +6304,9 @@ components: Government-issued business identifying number. - **Note: As of October 19th, 2026 this field will be required when - `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is - provided, `businessRegistrationType` and - `businessRegistrationIssuingCountry` are also required.** + **This field is required when `businessEntityType` is _not_ + `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` + and `businessRegistrationIssuingCountry` are also required.** nullable: true maxLength: 500 example: 12-3456789 @@ -6286,8 +6316,8 @@ components: The type of business registration number. - **Note: As of October 19th, 2026 this field will be required when - `businessRegistrationNumber` is provided.** + **This field is required when `businessRegistrationNumber` is + provided.** enum: - EIN - CBN @@ -6317,8 +6347,8 @@ components: encouraged. - **Note: As of October 19th, 2026 this field will be required when - `businessRegistrationNumber` is provided.** + **This field is required when `businessRegistrationNumber` is + provided.** | Registration Type | Supported Countries | @@ -6368,9 +6398,9 @@ components: The type of registered business. - **Note: As of October 19th, 2026 submissions using a value other than - `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, - `businessRegistrationType`, and `businessRegistrationIssuingCountry`. + **Submissions using a value other than `SOLE_PROPRIETOR` must provide a + value for `businessRegistrationNumber`, `businessRegistrationType`, and + `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and @@ -6413,7 +6443,7 @@ components: minLength: 1 maxLength: 500 nullable: false - example: "+19192654500" + example: '+19192654500' verificationRequest: type: object required: @@ -6428,9 +6458,9 @@ components: - businessEntityType properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -6442,15 +6472,15 @@ components: minItems: 1 maxItems: 10 items: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: type: string description: Any additional information. @@ -6459,27 +6489,27 @@ components: nullable: true example: Any additional information isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' helpMessageResponse: - $ref: "#/components/schemas/helpMessageResponse" + $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: - $ref: "#/components/schemas/ageGatedContent" + $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' verificationUpdateRequest: type: object required: @@ -6490,11 +6520,12 @@ components: - useCaseSummary - productionMessageContent - optInWorkflow + - businessEntityType properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -6502,37 +6533,37 @@ components: maximum: 10000000 example: 10000 useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: - $ref: "#/components/schemas/additionalInformation" + $ref: '#/components/schemas/additionalInformation' isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' helpMessageResponse: - $ref: "#/components/schemas/helpMessageResponse" + $ref: '#/components/schemas/helpMessageResponse' ageGatedContent: - $ref: "#/components/schemas/ageGatedContent" + $ref: '#/components/schemas/ageGatedContent' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' tfvBasicAuthentication: type: object properties: @@ -6551,47 +6582,47 @@ components: type: object properties: basicAuthentication: - $ref: "#/components/schemas/tfvBasicAuthentication" + $ref: '#/components/schemas/tfvBasicAuthentication' callbackUrl: - $ref: "#/components/schemas/webhookUrl" + $ref: '#/components/schemas/webhookUrl' sharedSecretKey: - $ref: "#/components/schemas/sharedSecretKey" + $ref: '#/components/schemas/sharedSecretKey' required: - callbackUrl failureWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' errorCode: type: string description: >- An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. - example: "400" + example: '400' errorMessage: type: string description: A description of the error that was encountered. example: cannot process request. errors: - $ref: "#/components/schemas/tfvWebhookErrors" + $ref: '#/components/schemas/tfvWebhookErrors' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' verificationDenialWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' additionalDenialReasons: description: >- An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply. type: array items: - $ref: "#/components/schemas/additionalDenialReason" + $ref: '#/components/schemas/additionalDenialReason' example: - statusCode: 512 reason: Reason A @@ -6600,52 +6631,52 @@ components: reason: Reason B resubmitAllowed: true declineReasonDescription: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' denialStatusCode: - $ref: "#/components/schemas/denialStatusCode" + $ref: '#/components/schemas/denialStatusCode' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' status: - $ref: "#/components/schemas/tfvUnverifiedStatus" + $ref: '#/components/schemas/tfvUnverifiedStatus' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' verificationWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvCallbackStatusEnum" + $ref: '#/components/schemas/tfvCallbackStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' blockedWebhook: type: object properties: accountId: - $ref: "#/components/schemas/accountId1" + $ref: '#/components/schemas/accountId1' phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvCallbackStatusEnum" + $ref: '#/components/schemas/tfvCallbackStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumberForWebhook" + $ref: '#/components/schemas/internalTicketNumberForWebhook' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' tfvSubmissionWrapper: type: object properties: submission: - $ref: "#/components/schemas/verificationUpdateRequest" + $ref: '#/components/schemas/verificationUpdateRequest' address: type: object nullable: false @@ -6696,8 +6727,8 @@ components: type: string description: The zip of the business using the toll-free number. nullable: false - example: "27606" - pattern: "[- A-Za-z0-9]{0,500}" + example: '27606' + pattern: '[- A-Za-z0-9]{0,500}' url: type: string format: url @@ -6773,9 +6804,9 @@ components: nullable: false example: Doe email: - $ref: "#/components/schemas/email" + $ref: '#/components/schemas/email' phoneNumber: - $ref: "#/components/schemas/businessContactPhoneNumber" + $ref: '#/components/schemas/businessContactPhoneNumber' email: type: string format: email @@ -6829,14 +6860,14 @@ components: - data properties: links: - $ref: "#/components/schemas/linksObject" + $ref: '#/components/schemas/linksObject' errors: type: array items: - $ref: "#/components/schemas/webhookSubscriptionError" + $ref: '#/components/schemas/webhookSubscriptionError' data: items: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' type: array linksObject: type: object @@ -6869,7 +6900,7 @@ components: telephoneNumbers: type: array items: - $ref: "#/components/schemas/telephoneNumber" + $ref: '#/components/schemas/telephoneNumber' telephoneNumber: type: object properties: @@ -6895,11 +6926,11 @@ components: example: 7hICGStfAfeGxEq3N0lQwO accountId: type: string - example: "1234567" + example: '1234567' callbackUrl: - $ref: "#/components/schemas/webhookUrl" + $ref: '#/components/schemas/webhookUrl' type: - $ref: "#/components/schemas/webhookSubscriptionTypeEnum" + $ref: '#/components/schemas/webhookSubscriptionTypeEnum' basicAuthentication: description: >- Basic authentication credentials are not required, but if present, @@ -6918,11 +6949,11 @@ components: createdDate: type: string format: date-time - example: "2023-05-15T13:56:39.965Z" + example: '2023-05-15T13:56:39.965Z' modifiedDate: type: string format: date-time - example: "2023-05-15T13:56:39.965Z" + example: '2023-05-15T13:56:39.965Z' webhookUrl: description: >- Callback URL to receive status updates from Bandwidth. When a webhook @@ -6959,15 +6990,15 @@ components: type: object properties: phoneNumber: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' status: - $ref: "#/components/schemas/tfvStatusEnum" + $ref: '#/components/schemas/tfvStatusEnum' internalTicketNumber: - $ref: "#/components/schemas/internalTicketNumber" + $ref: '#/components/schemas/internalTicketNumber' declineReasonDescription: - $ref: "#/components/schemas/declineReasonDescription" + $ref: '#/components/schemas/declineReasonDescription' denialStatusCode: - $ref: "#/components/schemas/denialStatusCodeNullable" + $ref: '#/components/schemas/denialStatusCodeNullable' additionalDenialReasons: description: >- An optional list of denial reasons in addition to @@ -6975,7 +7006,7 @@ components: nullable: true type: array items: - $ref: "#/components/schemas/additionalDenialReason" + $ref: '#/components/schemas/additionalDenialReason' example: - statusCode: 512 reason: Reason A @@ -6984,32 +7015,32 @@ components: reason: Reason B resubmitAllowed: true resubmitAllowed: - $ref: "#/components/schemas/resubmitAllowed" + $ref: '#/components/schemas/resubmitAllowed' createdDateTime: type: string description: Date and time the verification request was created. format: date-time - example: "2021-06-08T06:45:13.0Z" + example: '2021-06-08T06:45:13.0Z' modifiedDateTime: type: string description: Date and time the verification request was last modified. format: date-time - example: "2021-06-08T06:45:13.0Z" + example: '2021-06-08T06:45:13.0Z' submission: - $ref: "#/components/schemas/tfvSubmissionInfo" + $ref: '#/components/schemas/tfvSubmissionInfo' blocked: - $ref: "#/components/schemas/blocked" + $ref: '#/components/schemas/blocked' blockedReason: - $ref: "#/components/schemas/blockedReason" + $ref: '#/components/schemas/blockedReason' cvToken: - $ref: "#/components/schemas/cvTokenNullable" + $ref: '#/components/schemas/cvTokenNullable' tfvSubmissionInfo: type: object properties: businessAddress: - $ref: "#/components/schemas/address" + $ref: '#/components/schemas/address' businessContact: - $ref: "#/components/schemas/contact" + $ref: '#/components/schemas/contact' messageVolume: type: integer description: Estimated monthly volume of messages from the toll-free number. @@ -7017,36 +7048,36 @@ components: maximum: 10000000 example: 10000 useCase: - $ref: "#/components/schemas/useCase" + $ref: '#/components/schemas/useCase' useCaseSummary: - $ref: "#/components/schemas/useCaseSummary" + $ref: '#/components/schemas/useCaseSummary' productionMessageContent: - $ref: "#/components/schemas/productionMessageContent" + $ref: '#/components/schemas/productionMessageContent' optInWorkflow: - $ref: "#/components/schemas/optInWorkflow" + $ref: '#/components/schemas/optInWorkflow' additionalInformation: - $ref: "#/components/schemas/additionalInformation" + $ref: '#/components/schemas/additionalInformation' isvReseller: - $ref: "#/components/schemas/isvReseller" + $ref: '#/components/schemas/isvReseller' privacyPolicyUrl: - $ref: "#/components/schemas/privacyPolicyUrl" + $ref: '#/components/schemas/privacyPolicyUrl' termsAndConditionsUrl: - $ref: "#/components/schemas/termsAndConditionsUrl" + $ref: '#/components/schemas/termsAndConditionsUrl' businessDba: - $ref: "#/components/schemas/businessDba" + $ref: '#/components/schemas/businessDba' businessRegistrationNumber: - $ref: "#/components/schemas/businessRegistrationNumber" + $ref: '#/components/schemas/businessRegistrationNumber' description: Government-issued business identifying number. businessRegistrationType: - $ref: "#/components/schemas/businessRegistrationTypeEnum" + $ref: '#/components/schemas/businessRegistrationTypeEnum' description: The type of business registration number. businessRegistrationIssuingCountry: - $ref: "#/components/schemas/businessRegistrationIssuingCountry" + $ref: '#/components/schemas/businessRegistrationIssuingCountry' description: >- The country issuing the business registration in ISO-3166-1 alpha-3 format. businessEntityType: - $ref: "#/components/schemas/businessEntityTypeEnum" + $ref: '#/components/schemas/businessEntityTypeEnum' description: The type of registered business. tfvStatusEnum: type: string @@ -7126,7 +7157,7 @@ components: description: The port of the SIP connection. example: 5060 credentials: - $ref: "#/components/schemas/sipCredentials" + $ref: '#/components/schemas/sipCredentials' uuiHeader: type: string description: The User-to-User Information header for the SIP connection. @@ -7158,12 +7189,12 @@ components: maximum: 1024 example: David's iPhone status: - $ref: "#/components/schemas/deviceStatusEnum" + $ref: '#/components/schemas/deviceStatusEnum' creationTimestamp: type: string format: date-time description: The time the device was created. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' required: - deviceId - status @@ -7172,25 +7203,25 @@ components: type: object properties: endpointId: - $ref: "#/components/schemas/endpointId" + $ref: '#/components/schemas/endpointId' type: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' status: - $ref: "#/components/schemas/endpointStatusEnum" + $ref: '#/components/schemas/endpointStatusEnum' creationTimestamp: type: string format: date-time description: The time the endpoint was created. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' expirationTimestamp: type: string format: date-time description: >- The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. - example: "2021-01-02T00:00:00Z" + example: '2021-01-02T00:00:00Z' tag: - $ref: "#/components/schemas/endpointTag" + $ref: '#/components/schemas/endpointTag' required: - endpointId - type @@ -7200,27 +7231,27 @@ components: endpoint: type: object allOf: - - $ref: "#/components/schemas/endpoints" + - $ref: '#/components/schemas/endpoints' - type: object properties: devices: type: array items: - $ref: "#/components/schemas/device" + $ref: '#/components/schemas/device' createWebRtcConnectionRequest: allOf: - - $ref: "#/components/schemas/createEndpointRequestBase" + - $ref: '#/components/schemas/createEndpointRequestBase' - type: object properties: connectionMetadata: - $ref: "#/components/schemas/webRtcConnectionMetadata" + $ref: '#/components/schemas/webRtcConnectionMetadata' createEndpointRequestBase: type: object properties: type: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' direction: - $ref: "#/components/schemas/endpointDirectionEnum" + $ref: '#/components/schemas/endpointDirectionEnum' eventCallbackUrl: type: string format: uri @@ -7232,24 +7263,24 @@ components: description: The URL to send event fallbacks to. example: https://fallback.myapp.com/callback tag: - $ref: "#/components/schemas/endpointTag" + $ref: '#/components/schemas/endpointTag' required: - type - direction createEndpointRequest: oneOf: - - $ref: "#/components/schemas/createWebRtcConnectionRequest" + - $ref: '#/components/schemas/createWebRtcConnectionRequest' discriminator: propertyName: type mapping: - WEBRTC: "#/components/schemas/createWebRtcConnectionRequest" + WEBRTC: '#/components/schemas/createWebRtcConnectionRequest' createEndpointResponseData: allOf: - - $ref: "#/components/schemas/endpoint" + - $ref: '#/components/schemas/endpoint' - type: object properties: token: - $ref: "#/components/schemas/endpointToken" + $ref: '#/components/schemas/endpointToken' required: - token endpointEventTypeEnum: @@ -7260,18 +7291,18 @@ components: endpointEvent: description: An event that occurred on an endpoint. allOf: - - $ref: "#/components/schemas/endpoints" + - $ref: '#/components/schemas/endpoints' - type: object properties: eventTime: type: string format: date-time description: The time the event occurred. In ISO-8601 format. - example: "2021-01-01T00:00:00Z" + example: '2021-01-01T00:00:00Z' eventType: - $ref: "#/components/schemas/endpointEventTypeEnum" + $ref: '#/components/schemas/endpointEventTypeEnum' device: - $ref: "#/components/schemas/device" + $ref: '#/components/schemas/device' required: - eventType - eventTime @@ -7335,9 +7366,9 @@ components: code: type: string description: A code that uniquely identifies the error. - example: "404" + example: '404' source: - $ref: "#/components/schemas/brtcErrorSource" + $ref: '#/components/schemas/brtcErrorSource' required: - type - description @@ -7368,17 +7399,17 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' page: - $ref: "#/components/schemas/page" + $ref: '#/components/schemas/page' data: type: array items: - $ref: "#/components/schemas/endpoints" + $ref: '#/components/schemas/endpoints' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7389,13 +7420,13 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: - $ref: "#/components/schemas/endpoint" + $ref: '#/components/schemas/endpoint' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7406,13 +7437,13 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: - $ref: "#/components/schemas/createEndpointResponseData" + $ref: '#/components/schemas/createEndpointResponseData' errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7423,7 +7454,7 @@ components: links: type: array items: - $ref: "#/components/schemas/brtcLink" + $ref: '#/components/schemas/brtcLink' data: type: object nullable: true @@ -7431,7 +7462,7 @@ components: errors: type: array items: - $ref: "#/components/schemas/brtcError" + $ref: '#/components/schemas/brtcError' required: - links - data @@ -7442,19 +7473,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/message" + $ref: '#/components/schemas/message' createMultiChannelMessageResponse: description: Accepted content: application/json: schema: - $ref: "#/components/schemas/createMultiChannelMessageResponse" + $ref: '#/components/schemas/createMultiChannelMessageResponse' listMessagesResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/messagesList" + $ref: '#/components/schemas/messagesList' getMediaResponse: description: OK content: @@ -7475,73 +7506,73 @@ components: schema: type: array items: - $ref: "#/components/schemas/media" + $ref: '#/components/schemas/media' messagingBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingNotAcceptableError: description: Not Acceptable content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' createMessageBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/createMessageRequestError" + $ref: '#/components/schemas/createMessageRequestError' messagingUnauthorizedError: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingForbiddenError: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingNotFoundError: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingMethodNotAllowedError: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingInvalidMediaTypeError: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingTooManyRequestsError: description: Too Many Requests content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' messagingInternalServerError: description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' multiChannelBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7559,7 +7590,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7572,7 +7603,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7585,7 +7616,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7598,7 +7629,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7611,7 +7642,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7627,7 +7658,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7642,7 +7673,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/multiChannelError" + $ref: '#/components/schemas/multiChannelError' example: links: [] data: null @@ -7661,7 +7692,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/messagingRequestError" + $ref: '#/components/schemas/messagingRequestError' example: type: rate_limit_exceeded description: >- @@ -7677,16 +7708,16 @@ components: content: application/json: schema: - $ref: "#/components/schemas/createCallResponse" + $ref: '#/components/schemas/createCallResponse' examples: createCall Response: - $ref: "#/components/examples/createCallResponseExample" + $ref: '#/components/examples/createCallResponseExample' getCallStateResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callState" + $ref: '#/components/schemas/callState' updateCallResponse: description: OK listCallsResponse: @@ -7696,13 +7727,13 @@ components: schema: type: array items: - $ref: "#/components/schemas/callState" + $ref: '#/components/schemas/callState' getStatisticsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/accountStatistics" + $ref: '#/components/schemas/accountStatistics' updateRecordingResponse: description: OK listCallRecordingsResponse: @@ -7712,13 +7743,13 @@ components: schema: type: array items: - $ref: "#/components/schemas/callRecordingMetadata" + $ref: '#/components/schemas/callRecordingMetadata' getCallRecordingResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callRecordingMetadata" + $ref: '#/components/schemas/callRecordingMetadata' downloadRecordingMediaResponse: description: OK content: @@ -7735,19 +7766,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/recordingTranscriptions" + $ref: '#/components/schemas/recordingTranscriptions' listTranscriptionsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callTranscriptionMetadataList" + $ref: '#/components/schemas/callTranscriptionMetadataList' getCallTranscriptionResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/callTranscriptionResponse" + $ref: '#/components/schemas/callTranscriptionResponse' deleteCallTranscriptionResponse: description: No Content listConferencesResponse: @@ -7757,22 +7788,22 @@ components: schema: type: array items: - $ref: "#/components/schemas/conference" + $ref: '#/components/schemas/conference' examples: listConferences Response: - $ref: "#/components/examples/listConferencesResponseExample" + $ref: '#/components/examples/listConferencesResponseExample' getConferenceResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conference" + $ref: '#/components/schemas/conference' getConferenceMemberResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conferenceMember" + $ref: '#/components/schemas/conferenceMember' listConferenceRecordingsResponse: description: OK content: @@ -7780,76 +7811,76 @@ components: schema: type: array items: - $ref: "#/components/schemas/conferenceRecordingMetadata" + $ref: '#/components/schemas/conferenceRecordingMetadata' getConferenceRecordingResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/conferenceRecordingMetadata" + $ref: '#/components/schemas/conferenceRecordingMetadata' voiceBadRequestError: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: badRequestErrorExample: - $ref: "#/components/examples/voiceBadRequestErrorExample" + $ref: '#/components/examples/voiceBadRequestErrorExample' voiceUnauthorizedError: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: unauthorizedErrorExample: - $ref: "#/components/examples/voiceUnauthorizedErrorExample" + $ref: '#/components/examples/voiceUnauthorizedErrorExample' voiceForbiddenError: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: forbiddenErrorExample: - $ref: "#/components/examples/voiceForbiddenErrorExample" + $ref: '#/components/examples/voiceForbiddenErrorExample' voiceNotFoundError: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: notFoundErrorExample: - $ref: "#/components/examples/voiceNotFoundErrorExample" + $ref: '#/components/examples/voiceNotFoundErrorExample' voiceNotAllowedError: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: notAllowedErrorExample: - $ref: "#/components/examples/voiceNotAllowedErrorExample" + $ref: '#/components/examples/voiceNotAllowedErrorExample' voiceConflictError: description: Conflict content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: conflictErrorExample: - $ref: "#/components/examples/voiceConflictErrorExample" + $ref: '#/components/examples/voiceConflictErrorExample' voiceUnsupportedMediaTypeError: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/voiceUnsupportedMediaTypeErrorExample" + $ref: '#/components/examples/voiceUnsupportedMediaTypeErrorExample' voiceTooManyRequestsError: description: Too Many Requests headers: @@ -7860,174 +7891,174 @@ components: content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/voiceTooManyRequestsErrorExample" + $ref: '#/components/examples/voiceTooManyRequestsErrorExample' voiceInternalServerError: description: Internal Server Error content: application/json: schema: - $ref: "#/components/schemas/voiceApiError" + $ref: '#/components/schemas/voiceApiError' examples: internalServerErrorExample: - $ref: "#/components/examples/voiceInternalServerErrorExample" + $ref: '#/components/examples/voiceInternalServerErrorExample' voiceCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/voiceCodeResponse" + $ref: '#/components/schemas/voiceCodeResponse' messagingCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/messagingCodeResponse" + $ref: '#/components/schemas/messagingCodeResponse' verifyCodeResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/verifyCodeResponse" + $ref: '#/components/schemas/verifyCodeResponse' mfaBadRequestError: description: Bad Request headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' mfaUnauthorizedError: description: Unauthorized headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaUnauthorizedRequestError" + $ref: '#/components/schemas/mfaUnauthorizedRequestError' mfaForbiddenError: description: Forbidden headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaForbiddenRequestError" + $ref: '#/components/schemas/mfaForbiddenRequestError' mfaTooManyRequestsError: description: Too Many Requests headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' mfaInternalServerError: description: Internal Server Error headers: {} content: application/json: schema: - $ref: "#/components/schemas/mfaRequestError" + $ref: '#/components/schemas/mfaRequestError' createSyncLookupResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/createSyncLookupResponse" + $ref: '#/components/schemas/createSyncLookupResponse' examples: lookupCompleteWithDniExample: - $ref: "#/components/examples/lookupCompleteWithDniExample" + $ref: '#/components/examples/lookupCompleteWithDniExample' lookupCompleteExample: - $ref: "#/components/examples/lookupCompleteExample" + $ref: '#/components/examples/lookupCompleteExample' lookupCompleteWithRcsExample: - $ref: "#/components/examples/lookupCompleteWithRcsExample" + $ref: '#/components/examples/lookupCompleteWithRcsExample' lookupCompleteWithRcsErrorExample: - $ref: "#/components/examples/lookupCompleteWithRcsErrorExample" + $ref: '#/components/examples/lookupCompleteWithRcsErrorExample' lookupPartialExample: - $ref: "#/components/examples/lookupPartialExample" + $ref: '#/components/examples/lookupPartialExample' lookupFailedExample: - $ref: "#/components/examples/lookupFailedExample" + $ref: '#/components/examples/lookupFailedExample' createAsyncBulkLookupResponse: description: Accepted content: application/json: schema: - $ref: "#/components/schemas/createAsyncBulkLookupResponse" + $ref: '#/components/schemas/createAsyncBulkLookupResponse' examples: lookupAcceptedExample: - $ref: "#/components/examples/lookupAcceptedExample" + $ref: '#/components/examples/lookupAcceptedExample' getAsyncBulkLookupResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/getAsyncBulkLookupResponse" + $ref: '#/components/schemas/getAsyncBulkLookupResponse' examples: lookupCompleteWithDniExample: - $ref: "#/components/examples/lookupCompleteWithDniExample" + $ref: '#/components/examples/lookupCompleteWithDniExample' lookupCompleteExample: - $ref: "#/components/examples/lookupCompleteExample" + $ref: '#/components/examples/lookupCompleteExample' lookupInProgressExample: - $ref: "#/components/examples/lookupInProgressExample" + $ref: '#/components/examples/lookupInProgressExample' lookupPartialExample: - $ref: "#/components/examples/lookupPartialExample" + $ref: '#/components/examples/lookupPartialExample' lookupFailedExample: - $ref: "#/components/examples/lookupFailedExample" + $ref: '#/components/examples/lookupFailedExample' tnLookupDefaultResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/lookupErrorResponse" + $ref: '#/components/schemas/lookupErrorResponse' examples: badRequest: - $ref: "#/components/examples/badRequestExample" + $ref: '#/components/examples/badRequestExample' unauthorized: - $ref: "#/components/examples/unauthorizedExample" + $ref: '#/components/examples/unauthorizedExample' forbidden: - $ref: "#/components/examples/forbiddenExample" + $ref: '#/components/examples/forbiddenExample' mediaType: - $ref: "#/components/examples/unsupportedMediaTypeExample" + $ref: '#/components/examples/unsupportedMediaTypeExample' notFound: - $ref: "#/components/examples/notFoundExample" + $ref: '#/components/examples/notFoundExample' tooManyRequests: - $ref: "#/components/examples/tooManyRequestsExample" + $ref: '#/components/examples/tooManyRequestsExample' internalServer: - $ref: "#/components/examples/internalServerErrorExample" + $ref: '#/components/examples/internalServerErrorExample' getTollFreeVerificationStatusResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/tfvStatus" + $ref: '#/components/schemas/tfvStatus' listWebhookSubscriptionsResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/webhookSubscriptionsListBody" + $ref: '#/components/schemas/webhookSubscriptionsListBody' createWebhookSubscriptionResponse: description: Created content: application/json: schema: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' updateWebhookSubscriptionResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/webhookSubscription" + $ref: '#/components/schemas/webhookSubscription' listTollFreeUseCasesResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/useCases" + $ref: '#/components/schemas/useCases' tfvBadRequestResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Cannot process request. type: bad request @@ -8038,7 +8069,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: cannot process request. errors: @@ -8050,7 +8081,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Client is providing incorrect or invalid credentials. type: unauthorized @@ -8059,7 +8090,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Client is not authorized for the action. type: forbidden @@ -8068,16 +8099,27 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Cannot find the requested resource. type: Not Found + tfvConflictResponse: + description: >- + Conflict. A toll-free verification for the phone number is already in + progress. + content: + application/json: + schema: + $ref: '#/components/schemas/tfvError' + example: + description: 'TFV request already in progress for phone number: +18005551234' + type: conflict tfvNotAllowedResponse: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Method is not allowed. type: Method Not Allowed @@ -8086,7 +8128,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Throttling error. Too many requests. type: Too Many Requests @@ -8095,7 +8137,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Internal Server Error. type: Internal Server Error @@ -8104,7 +8146,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/tfvError" + $ref: '#/components/schemas/tfvError' example: description: Service Unavailable Error. type: Service Unavailable @@ -8115,82 +8157,82 @@ components: content: application/json: schema: - $ref: "#/components/schemas/listEndpointsResponse" + $ref: '#/components/schemas/listEndpointsResponse' examples: listEndpointsResponseExample: - $ref: "#/components/examples/listEndpointsResponseExample" + $ref: '#/components/examples/listEndpointsResponseExample' createEndpointResponse: description: Created content: application/json: schema: - $ref: "#/components/schemas/createEndpointResponse" + $ref: '#/components/schemas/createEndpointResponse' examples: createEndpointResponseExample: - $ref: "#/components/examples/createEndpointResponseExample" + $ref: '#/components/examples/createEndpointResponseExample' getEndpointResponse: description: OK content: application/json: schema: - $ref: "#/components/schemas/endpointResponse" + $ref: '#/components/schemas/endpointResponse' examples: getEndpointResponseExample: - $ref: "#/components/examples/getEndpointResponseExample" + $ref: '#/components/examples/getEndpointResponseExample' badRequestErrorResponse: description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: badRequestErrorExample: - $ref: "#/components/examples/badRequestErrorExample" + $ref: '#/components/examples/badRequestErrorExample' unauthorizedErrorResponse: description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: unauthorizedErrorExample: - $ref: "#/components/examples/unauthorizedErrorExample" + $ref: '#/components/examples/unauthorizedErrorExample' forbiddenErrorResponse: description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: forbiddenErrorExample: - $ref: "#/components/examples/forbiddenErrorExample" + $ref: '#/components/examples/forbiddenErrorExample' notFoundErrorResponse: description: Not Found content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: notFoundErrorExample: - $ref: "#/components/examples/notFoundErrorExample" + $ref: '#/components/examples/notFoundErrorExample' methodNotAllowedErrorResponse: description: Method Not Allowed content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: methodNotAllowedErrorExample: - $ref: "#/components/examples/methodNotAllowedErrorExample" + $ref: '#/components/examples/methodNotAllowedErrorExample' unsupportedMediaTypeErrorResponse: description: Unsupported Media Type content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: unsuppotedMediaTypeErrorExample: - $ref: "#/components/examples/unsupportedMediaTypeErrorExample" + $ref: '#/components/examples/unsupportedMediaTypeErrorExample' tooManyRequestsErrorResponse: description: Too Many Requests headers: @@ -8205,19 +8247,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: tooManyRequestsErrorExample: - $ref: "#/components/examples/tooManyRequestsErrorExample" + $ref: '#/components/examples/tooManyRequestsErrorExample' serviceUnavailableErrorResponse: description: Service Unavailable content: application/json: schema: - $ref: "#/components/schemas/brtcErrorResponse" + $ref: '#/components/schemas/brtcErrorResponse' examples: serviceUnavailableErrorExample: - $ref: "#/components/examples/serviceUnavailableErrorExample" + $ref: '#/components/examples/serviceUnavailableErrorExample' parameters: accountId: in: path @@ -8232,7 +8274,7 @@ components: **When migrating to OAuth authentication, you must use the 7-digit Account ID.** - example: "9900000" + example: '9900000' mediaId: in: path name: mediaId @@ -8256,8 +8298,8 @@ components: style: simple explode: false description: >- - General-header field is used to specify directives that MUST be obeyed - by all caching mechanisms along the request/response chain. + Pass-through header stored with the media and returned when the media is + retrieved by the user. Does not affect internal server caching behavior. example: no-cache schema: type: string @@ -8291,7 +8333,7 @@ components: full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). - example: "%2B15554443333" + example: '%2B15554443333' schema: type: string destinationTn: @@ -8303,7 +8345,7 @@ components: single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. '%2B1919'). - example: "%2B15554443333" + example: '%2B15554443333' schema: type: string messageStatus: @@ -8314,14 +8356,14 @@ components: The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. schema: - $ref: "#/components/schemas/messageStatusEnum" + $ref: '#/components/schemas/messageStatusEnum' messageDirection: in: query name: messageDirection required: false description: The direction of the message. One of INBOUND OUTBOUND. schema: - $ref: "#/components/schemas/listMessageDirectionEnum" + $ref: '#/components/schemas/listMessageDirectionEnum' carrierName: in: query name: carrierName @@ -8339,7 +8381,7 @@ components: required: false description: The type of message. Either sms or mms. schema: - $ref: "#/components/schemas/messageTypeEnum" + $ref: '#/components/schemas/messageTypeEnum' errorCode: in: query name: errorCode @@ -8403,7 +8445,7 @@ components: description: Messaging product associated with the message. example: P2P schema: - $ref: "#/components/schemas/productTypeEnum" + $ref: '#/components/schemas/productTypeEnum' location: in: query name: location @@ -8530,7 +8572,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' callId: name: callId in: path @@ -8578,7 +8620,7 @@ components: schema: type: string description: Filter results by the `to` field. - example: "%2b19195551234" + example: '%2b19195551234' from: name: from in: query @@ -8586,7 +8628,7 @@ components: schema: type: string description: Filter results by the `from` field. - example: "%2b19195554321" + example: '%2b19195554321' name: name: name in: query @@ -8604,7 +8646,7 @@ components: description: >- Filter results to conferences which have a `createdTime` after or at `minCreatedTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxCreatedTime: name: maxCreatedTime in: query @@ -8614,7 +8656,7 @@ components: description: >- Filter results to conferences which have a `createdTime` before or at `maxCreatedTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' minStartTime: name: minStartTime in: query @@ -8624,7 +8666,7 @@ components: description: >- Filter results to recordings which have a `startTime` after or including `minStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxStartTime: name: maxStartTime in: query @@ -8634,7 +8676,7 @@ components: description: >- Filter results to recordings which have a `startTime` before `maxStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' pageSize: name: pageSize in: query @@ -8656,7 +8698,7 @@ components: description: >- Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' maxStartTimeCalls: name: maxStartTime in: query @@ -8666,7 +8708,7 @@ components: description: >- Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format). - example: "2022-06-21T19:13:21Z" + example: '2022-06-21T19:13:21Z' pageSizeCalls: name: pageSize in: query @@ -8705,7 +8747,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' accountId3: in: path name: accountId @@ -8713,7 +8755,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' requestId: in: path name: requestId @@ -8730,15 +8772,15 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' tfPhoneNumberPathParam: in: path name: phoneNumber required: true schema: - $ref: "#/components/schemas/tfPhoneNumber" + $ref: '#/components/schemas/tfPhoneNumber' description: Valid Toll-Free telephone number in E.164 format. - example: "+18885555555" + example: '+18885555555' webhookSubscriptionIdPathParam: in: path name: id @@ -8754,7 +8796,7 @@ components: schema: type: string description: Your Bandwidth Account ID. - example: "9900000" + example: '9900000' endpointId: name: endpointId in: path @@ -8767,13 +8809,13 @@ components: name: type in: query schema: - $ref: "#/components/schemas/endpointTypeEnum" + $ref: '#/components/schemas/endpointTypeEnum' description: The type of endpoint. endpointStatus: name: status in: query schema: - $ref: "#/components/schemas/endpointStatusEnum" + $ref: '#/components/schemas/endpointStatusEnum' description: The status of the endpoint. afterCursor: name: afterCursor @@ -8798,39 +8840,39 @@ components: smsMessageReceivedCallbackExample: summary: An example of a sms message-received callback body. value: - time: "2025-01-06T15:43:35.502180Z" + time: '2025-01-06T15:43:35.502180Z' type: message-received - to: "+12345678902" + to: '+12345678902' description: Incoming message received message: id: 14762070468292kw2fuqty55yp2b2 - owner: "+12345678902" + owner: '+12345678902' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2025-01-06T15:43:34.000000Z" + time: '2025-01-06T15:43:34.000000Z' segmentCount: 1 direction: in to: - - "+12345678902" - from: "+12345678901" + - '+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" + time: '2024-09-14T18:20:45.160744Z' type: message-received - to: "+12345678902" + to: '+12345678902' description: Incoming message received message: id: 14762070468292kw2fuqty55yp2b2 - owner: "+12345678902" + owner: '+12345678902' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - time: "2024-09-14T18:20:45.160744Z" + time: '2024-09-14T18:20:45.160744Z' segmentCount: 1 direction: in to: - - "+12345678902" - - "+12345678903" - from: "+12345678901" + - '+12345678902' + - '+12345678903' + from: '+12345678901' text: Hey, check out the MMS! media: - >- @@ -8838,42 +8880,42 @@ components: messageSendingCallbackExample: summary: An example of a message-sending callback body. value: - time: "2024-06-25T18:42:36.979456Z" + time: '2024-06-25T18:42:36.979456Z' type: message-sending - to: "+15554443333" + to: '+15554443333' description: Message is sending to carrier. message: id: 1593110555875xo7watq5px6rbe5d - owner: "+15552221111" + owner: '+15552221111' applicationId: cfd4fb83-7531-4acc-b471-42d0bb76a65c - time: "2024-06-25T18:42:35.876906Z" + time: '2024-06-25T18:42:35.876906Z' segmentCount: 1 direction: out to: - - "+15554443333" - from: "+15552221111" - text: "" + - '+15554443333' + from: '+15552221111' + text: '' 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" + time: '2024-06-25T18:42:36.979456Z' type: message-sent - to: "+15554443333" + to: '+15554443333' description: Message sent to carrier message: id: 1593110555875xo7watq5px6rbe5d - owner: "+15552221111" + owner: '+15552221111' applicationId: cfd4fb83-7531-4acc-b471-42d0bb76a65c - time: "2024-06-25T18:42:35.876906Z" + time: '2024-06-25T18:42:35.876906Z' segmentCount: 1 direction: out to: - - "+15554443333" - from: "+15552221111" - text: "" + - '+15554443333' + from: '+15552221111' + text: '' media: - https://dev.bandwidth.com/images/bandwidth-logo.png tag: v2 lab @@ -8881,36 +8923,36 @@ components: summary: An example of a sms message-delivered callback body. value: type: message-delivered - time: "2024-09-14T18:20:11.160744Z" + time: '2024-09-14T18:20:11.160744Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:11.160744Z" + time: '2024-09-14T18:20:11.160744Z' to: - - "+12345678902" - from: "+12345678901" - text: "" + - '+12345678902' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + 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" + time: '2024-09-14T18:20:24.160544Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:24.160544Z" + time: '2024-09-14T18:20:24.160544Z' to: - - "+12345678902" - from: "+12345678901" - text: "" + - '+12345678902' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + owner: '+12345678902' direction: out segmentCount: 1 media: @@ -8919,52 +8961,52 @@ components: summary: An example of a group mms message-delivered callback body. value: type: message-delivered - time: "2024-09-14T18:20:17.160544Z" + time: '2024-09-14T18:20:17.160544Z' description: Message delivered to handset. - to: "+12345678902" + to: '+12345678902' message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-09-14T18:20:17.160544Z" + time: '2024-09-14T18:20:17.160544Z' to: - - "+12345678902" - - "+12345678903" - from: "+12345678901" - text: "" + - '+12345678902' + - '+12345678903' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 - owner: "+12345678902" + 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" + time: '2024-12-18T16:51:27.704450Z' description: forbidden to country - to: "+52345678903" + to: '+52345678903' errorCode: 4432 message: id: 14762070468292kw2fuqty55yp2b2 - time: "2024-12-18T16:51:27.704450Z" + time: '2024-12-18T16:51:27.704450Z' to: - - "+12345678902" - - "+52345678903" - from: "+12345678901" - text: "" + - '+12345678902' + - '+52345678903' + from: '+12345678901' + text: '' applicationId: 93de2206-9669-4e07-948d-329f4b722ee2 media: - https://dev.bandwidth.com/images/bandwidth-logo.png - owner: "+12345678901" + owner: '+12345678901' direction: out segmentCount: 1 createCallResponseExample: summary: Example of a createCall Response value: applicationId: 04e88489-df02-4e34-a0ee-27a91849555f - accountId: "9900000" + accountId: '9900000' callId: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 - to: "+19195551234" - from: "+19195554312" - enqueuedTime: "2022-06-16T13:15:07.160Z" + 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 @@ -8977,17 +9019,17 @@ components: disconnectMethod: POST disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect username: mySecretUsername - password: "*****" + password: '*****' fallbackUsername: mySecretUsername - fallbackPassword: "*****" + 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" + 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 @@ -8995,64 +9037,64 @@ components: summary: Example of a Bad Request (400) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceUnauthorizedErrorExample: summary: Example of an Unauthorized (401) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceForbiddenErrorExample: summary: Example of a Forbidden (403) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceNotFoundErrorExample: summary: Example of a Not Found (404) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceNotAllowedErrorExample: summary: Example of a Not Allowed (405) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceConflictErrorExample: summary: Example of a Conflict (409) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceUnsupportedMediaTypeErrorExample: summary: Example of an Unsupported Media Type (415) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceTooManyRequestsErrorExample: summary: Example of a Too Many Requests (429) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' voiceInternalServerErrorExample: summary: Example of an Internal Server (500) Error value: type: validation - description: "Invalid answerUrl: only http and https are allowed." + description: 'Invalid answerUrl: only http and https are allowed.' singleNumberRequestExample: summary: Number Lookup Request value: phoneNumbers: - - "+19196104423" + - '+19196104423' multipleNumberRequestExample: summary: Number Lookup Request for Multiple Numbers value: phoneNumbers: - - "+19196104423" - - "+19196104424" + - '+19196104423' + - '+19196104424' rcsAgentRequestExample: summary: Number Lookup Request with Custom RCS Agent value: phoneNumbers: - - "+19196104423" - - "+19196104424" + - '+19196104423' + - '+19196104424' rcsAgent: MyCustomRcsAgent lookupAcceptedExample: summary: Numbers Lookup Accepted @@ -9089,7 +9131,7 @@ components: description: The following TNs could not be found in the Number Industry data meta: phoneNumbers: - - "+13992077164" + - '+13992077164' message: Invalid TNs code: 1001 type: NumberInventory @@ -9101,12 +9143,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: PARTIAL_COMPLETE results: - - phoneNumber: "+19196104423" + - phoneNumber: '+19196104423' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+19196104424" + - phoneNumber: '+19196104424' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9116,7 +9158,7 @@ components: description: The following TNs could not be found in the Number Industry data meta: phoneNumbers: - - "+13992077164" + - '+13992077164' message: Invalid TNs code: 1001 type: NumberInventory @@ -9128,12 +9170,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9147,36 +9189,36 @@ components: requestId: 20732adf-bf81-8b17-41b1-004223a05590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' countryCodeA3: USA lineType: MOBILE messagingProvider: T-MOBILE USA INC voiceProvider: T-MOBILE USA INC latestMessageDeliveryStatus: ACTIVE - initialMessageDeliveryStatusDate: "2025-05-14" - latestMessageDeliveryStatusDate: "2025-05-18" - - phoneNumber: "+10072904498" + initialMessageDeliveryStatusDate: '2025-05-14' + latestMessageDeliveryStatusDate: '2025-05-18' + - phoneNumber: '+10072904498' countryCodeA3: USA lineType: MOBILE voiceProvider: VERIZON latestMessageDeliveryStatus: DEACTIVATED - initialMessageDeliveryStatusDate: "2025-09-05" - latestMessageDeliveryStatusDate: "2025-09-05" - - phoneNumber: "+10072904499" + initialMessageDeliveryStatusDate: '2025-09-05' + latestMessageDeliveryStatusDate: '2025-09-05' + - phoneNumber: '+10072904499' lineType: MOBILE countryCodeA3: USA messagingProvider: VERIZON voiceProvider: VERIZON deactivationReporter: Verizon Wireless - deactivationDate: "2025-09-29 01:23:00" + deactivationDate: '2025-09-29 01:23:00' deactivationEvent: DEACTIVATED latestMessageDeliveryStatus: UNKNOWN - - phoneNumber: "+10072904500" + - phoneNumber: '+10072904500' lineType: FIXED countryCodeA3: USA voiceProvider: VERIZON deactivationReporter: Verizon Wireless - deactivationDate: "2025-09-29 01:23:00" + deactivationDate: '2025-09-29 01:23:00' deactivationEvent: DEACTIVATED latestMessageDeliveryStatus: NOT_ENABLED errors: [] @@ -9188,13 +9230,13 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA rcsEnabled: true - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9209,12 +9251,12 @@ components: requestId: 004223a0-8b17-41b1-bf81-20732adf5590 status: COMPLETE results: - - phoneNumber: "+10072904497" + - phoneNumber: '+10072904497' lineType: MOBILE messagingProvider: Verizon Wireless voiceProvider: Verizon Wireless countryCodeA3: USA - - phoneNumber: "+10072904498" + - phoneNumber: '+10072904498' lineType: MOBILE messagingProvider: T-Mobile USA voiceProvider: T-Mobile USA @@ -9225,13 +9267,13 @@ components: description: An exception was thrown during the async RCS service call. meta: phoneNumbers: - - "+10072904497" + - '+10072904497' - code: MISSING_FROM_RESPONSE type: rcs-error description: The phone number was absent from the RCS service response. meta: phoneNumbers: - - "+10072904498" + - '+10072904498' badRequestExample: summary: Example Bad Request Error value: @@ -9250,7 +9292,7 @@ components: errors: - type: Unauthorized description: You are not authorized to access this resource. - code: "1" + code: '1' page: null forbiddenExample: summary: Forbidden Error @@ -9260,7 +9302,7 @@ components: errors: - type: Forbidden description: You do not have permission to access this resource. - code: "2" + code: '2' page: null unsupportedMediaTypeExample: summary: Unsupported Media Type Error @@ -9298,7 +9340,7 @@ components: links: [] data: {} errors: - - code: "500" + - code: '500' type: unexpected-error description: >- Unexpected error. Please contact Bandwidth Support if your @@ -9325,14 +9367,14 @@ components: - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' tag: my-tag - endpointId: e-2cb0-4a07-b215-b22865662d85-15ac29a2-1331029c type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' tag: my-tag errors: [] createEndpointResponseExample: @@ -9348,8 +9390,8 @@ components: token: xxxxx.yyyyy.zzzzz type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' devices: [] tag: my-tag errors: [] @@ -9365,8 +9407,8 @@ components: endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: CONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' devices: [] tag: my-tag errors: [] @@ -9379,7 +9421,7 @@ components: port: 3000 credentials: username: username - password: "********" + password: '********' uuiHeader: 123456;encoding=jwt direction: INBOUND eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth @@ -9402,9 +9444,9 @@ components: endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 type: WEBRTC status: DISCONNECTED - creationTimestamp: "2021-01-01T00:00:00Z" - expirationTimestamp: "2021-01-02T00:00:00Z" - eventTime: "2021-01-01T00:00:00Z" + creationTimestamp: '2021-01-01T00:00:00Z' + expirationTimestamp: '2021-01-02T00:00:00Z' + eventTime: '2021-01-01T00:00:00Z' eventType: DEVICE_DISCONNECTED tag: my-tag badRequestErrorExample: @@ -9416,7 +9458,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: invalid_parameter description: accountId must not contain any characters other than numbers. - code: "400" + code: '400' source: parameter: accountId unauthorizedErrorExample: @@ -9430,7 +9472,7 @@ components: description: >- The provided credentials are not authorized to access this resource. - code: "401" + code: '401' source: header: Authorization forbiddenErrorExample: @@ -9444,7 +9486,7 @@ components: description: >- The provided credentials are not authorized to access this resource. - code: "403" + code: '403' source: header: Authorization notFoundErrorExample: @@ -9456,7 +9498,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: resource_not_found description: The requested resource was not found. - code: "404" + code: '404' source: reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 methodNotAllowedErrorExample: @@ -9468,7 +9510,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: method_not_allowed description: The requested method is not allowed on this resource. - code: "405" + code: '405' source: parameter: accountId unsupportedMediaTypeErrorExample: @@ -9480,7 +9522,7 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: unsupported_media_type description: The provided media type is not supported. - code: "415" + code: '415' source: header: Content-Type tooManyRequestsErrorExample: @@ -9502,19 +9544,19 @@ components: - id: 59512d87-7a92-4040-8e4a-78fb772019b9 type: service_unavailable description: The service is currently unavailable. - code: "500" + code: '500' requestBodies: createMessageRequest: content: application/json: schema: - $ref: "#/components/schemas/messageRequest" + $ref: '#/components/schemas/messageRequest' required: true createMultiChannelMessageRequest: content: application/json: schema: - $ref: "#/components/schemas/multiChannelMessageRequest" + $ref: '#/components/schemas/multiChannelMessageRequest' required: true uploadMediaRequest: content: @@ -9717,7 +9759,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/createCall" + $ref: '#/components/schemas/createCall' updateCallRequest: description: >- JSON object containing information to redirect an existing call to a new @@ -9726,7 +9768,7 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateCall" + $ref: '#/components/schemas/updateCall' updateCallBxmlRequest: required: true content: @@ -9754,19 +9796,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateCallRecording" + $ref: '#/components/schemas/updateCallRecording' transcribeRecordingRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/transcribeRecording" + $ref: '#/components/schemas/transcribeRecording' updateConferenceRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/updateConference" + $ref: '#/components/schemas/updateConference' updateConferenceBxmlRequest: required: true content: @@ -9787,59 +9829,59 @@ components: content: application/json: schema: - $ref: "#/components/schemas/updateConferenceMember" + $ref: '#/components/schemas/updateConferenceMember' codeRequest: description: MFA code request body. required: true content: application/json: schema: - $ref: "#/components/schemas/codeRequest" + $ref: '#/components/schemas/codeRequest' codeVerify: description: MFA code verify request body. required: true content: application/json: schema: - $ref: "#/components/schemas/verifyCodeRequest" + $ref: '#/components/schemas/verifyCodeRequest' createSyncLookupRequest: description: Synchronous phone number lookup request. required: true content: application/json: schema: - $ref: "#/components/schemas/syncLookupRequest" + $ref: '#/components/schemas/syncLookupRequest' examples: singleNumberRequestExample: - $ref: "#/components/examples/singleNumberRequestExample" + $ref: '#/components/examples/singleNumberRequestExample' multipleNumberRequestExample: - $ref: "#/components/examples/multipleNumberRequestExample" + $ref: '#/components/examples/multipleNumberRequestExample' rcsAgentRequestExample: - $ref: "#/components/examples/rcsAgentRequestExample" + $ref: '#/components/examples/rcsAgentRequestExample' createAsyncBulkLookupRequest: description: Asynchronous bulk phone number lookup request. required: true content: application/json: schema: - $ref: "#/components/schemas/asyncLookupRequest" + $ref: '#/components/schemas/asyncLookupRequest' examples: multipleNumberRequestExample: - $ref: "#/components/examples/multipleNumberRequestExample" + $ref: '#/components/examples/multipleNumberRequestExample' requestTollFreeVerificationRequest: description: Request for verification of a toll-free phone number. required: true content: application/json: schema: - $ref: "#/components/schemas/verificationRequest" + $ref: '#/components/schemas/verificationRequest' updateTollFreeVerificationRequestRequest: description: Update a request for verification of a toll-free phone number. required: true content: application/json: schema: - $ref: "#/components/schemas/tfvSubmissionWrapper" + $ref: '#/components/schemas/tfvSubmissionWrapper' verificationWebhookRequest: description: Verification callback status of a toll-free phone number. required: true @@ -9847,10 +9889,10 @@ components: application/json: schema: oneOf: - - $ref: "#/components/schemas/verificationWebhook" - - $ref: "#/components/schemas/verificationDenialWebhook" - - $ref: "#/components/schemas/failureWebhook" - - $ref: "#/components/schemas/blockedWebhook" + - $ref: '#/components/schemas/verificationWebhook' + - $ref: '#/components/schemas/verificationDenialWebhook' + - $ref: '#/components/schemas/failureWebhook' + - $ref: '#/components/schemas/blockedWebhook' webhookSubscriptionRequest: description: >- Information about a webhook that Bandwidth should send upon the @@ -9859,16 +9901,16 @@ components: content: application/json: schema: - $ref: "#/components/schemas/webhookSubscriptionRequestSchema" + $ref: '#/components/schemas/webhookSubscriptionRequestSchema' createEndpointRequest: required: true content: application/json: schema: - $ref: "#/components/schemas/createEndpointRequest" + $ref: '#/components/schemas/createEndpointRequest' examples: createWebRtcEndpointRequestExample: - $ref: "#/components/examples/createWeRtcEndpointExample" + $ref: '#/components/examples/createWeRtcEndpointExample' updateEndpointBxmlRequest: required: true content: @@ -9883,7 +9925,7 @@ components: documentation](/docs/voice/bxml/). examples: updateEndpointBxmlRequestExample: - $ref: "#/components/examples/updateEndpointBxmlRequestExample" + $ref: '#/components/examples/updateEndpointBxmlRequestExample' securitySchemes: Basic: type: http @@ -9904,7 +9946,7 @@ components: scopes: {} callbacks: inboundCallback: - "{inboundCallbackUrl}": + '{inboundCallbackUrl}': post: requestBody: required: true @@ -9931,19 +9973,19 @@ components: content: application/json: schema: - $ref: "#/components/schemas/inboundCallback" + $ref: '#/components/schemas/inboundCallback' examples: smsMessageReceivedCallback: - $ref: "#/components/examples/smsMessageReceivedCallbackExample" + $ref: '#/components/examples/smsMessageReceivedCallbackExample' mmsMessageReceivedCallback: - $ref: "#/components/examples/mmsMessageReceivedCallbackExample" + $ref: '#/components/examples/mmsMessageReceivedCallbackExample' responses: - "200": + '200': description: OK - "202": + '202': description: Accepted statusCallback: - "{statusCallbackUrl}": + '{statusCallbackUrl}': post: requestBody: required: true @@ -9959,25 +10001,25 @@ components: content: application/json: schema: - $ref: "#/components/schemas/statusCallback" + $ref: '#/components/schemas/statusCallback' examples: messageSendingCallback: - $ref: "#/components/examples/messageSendingCallbackExample" + $ref: '#/components/examples/messageSendingCallbackExample' messageSentCallback: - $ref: "#/components/examples/messageSentCallbackExample" + $ref: '#/components/examples/messageSentCallbackExample' smsMessageDeliveredCallback: - $ref: "#/components/examples/smsMessageDeliveredCallbackExample" + $ref: '#/components/examples/smsMessageDeliveredCallbackExample' mmsMessageDeliveredCallback: - $ref: "#/components/examples/mmsMessageDeliveredCallbackExample" + $ref: '#/components/examples/mmsMessageDeliveredCallbackExample' groupMmsMessageDeliveredCallback: $ref: >- #/components/examples/groupMmsMessageDeliveredCallbackExample messageFailedCallback: - $ref: "#/components/examples/messageFailedCallbackExample" + $ref: '#/components/examples/messageFailedCallbackExample' responses: - "200": + '200': description: OK - "202": + '202': description: Accepted tfVerificationStatus: your_url.com/webhookService: @@ -9999,37 +10041,37 @@ components: schema: type: string requestBody: - $ref: "#/components/requestBodies/verificationWebhookRequest" + $ref: '#/components/requestBodies/verificationWebhookRequest' responses: - "204": - $ref: "#/components/responses/noContentResponse" - "400": - $ref: "#/components/responses/tfvBadRequestResponse" - "401": - $ref: "#/components/responses/tfvUnauthorizedResponse" - "403": - $ref: "#/components/responses/tfvForbiddenResponse" - "404": - $ref: "#/components/responses/tfvNotFoundResponse" - "405": - $ref: "#/components/responses/tfvNotAllowedResponse" - "429": - $ref: "#/components/responses/tfvTooManyRequestsResponse" - "500": - $ref: "#/components/responses/tfvServerErrorResponse" - "503": - $ref: "#/components/responses/tfvServiceUnavailableResponse" + '204': + $ref: '#/components/responses/noContentResponse' + '400': + $ref: '#/components/responses/tfvBadRequestResponse' + '401': + $ref: '#/components/responses/tfvUnauthorizedResponse' + '403': + $ref: '#/components/responses/tfvForbiddenResponse' + '404': + $ref: '#/components/responses/tfvNotFoundResponse' + '405': + $ref: '#/components/responses/tfvNotAllowedResponse' + '429': + $ref: '#/components/responses/tfvTooManyRequestsResponse' + '500': + $ref: '#/components/responses/tfvServerErrorResponse' + '503': + $ref: '#/components/responses/tfvServiceUnavailableResponse' endpointEvent: - "{request.body#/eventCallbackUrl}": + '{request.body#/eventCallbackUrl}': post: requestBody: content: application/json: schema: - $ref: "#/components/schemas/endpointEvent" + $ref: '#/components/schemas/endpointEvent' examples: endpointDisconnectedEventExample: - $ref: "#/components/examples/endpointDisconnectedEventExample" + $ref: '#/components/examples/endpointDisconnectedEventExample' responses: - "204": + '204': description: Event was successfully received. diff --git a/docs/Api/MediaApi.md b/docs/Api/MediaApi.md index 81a2ffe5..af3e40f7 100644 --- a/docs/Api/MediaApi.md +++ b/docs/Api/MediaApi.md @@ -240,7 +240,7 @@ uploadMedia($account_id, $media_id, $body, $content_type, $cache_control) - https://messaging.bandwidth.com/api/v2 Production Upload Media -Upload a file. You may add headers to the request in order to provide some control to your media file. If a file is uploaded with the same name as a file that already exists under this account, the previous file will be overwritten. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). +Upload a file. Filename should always be unique. Reusing filenames may result in the wrong media being sent. A list of supported media types can be found at [Bandwidth Support](https://www.bandwidth.com/support/en/articles/12823220-what-mms-file-types-are-supported). ### Example @@ -268,7 +268,7 @@ $account_id = 9900000; // string | This is your 7-digit Bandwidth Account ID, as $media_id = bw.png; // string | The ID of the media file. $body = '/path/to/file.txt'; // \SplFileObject $content_type = audio/wav; // string | The media type of the entity-body. -$cache_control = no-cache; // string | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. +$cache_control = no-cache; // string | Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. $hostIndex = 0; $variables = [ @@ -289,7 +289,7 @@ try { | **media_id** | **string**| The ID of the media file. | | | **body** | **\SplFileObject****\SplFileObject**| | | | **content_type** | **string**| The media type of the entity-body. | [optional] | -| **cache_control** | **string**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. | [optional] | +| **cache_control** | **string**| Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. | [optional] | | hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] | | variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] | diff --git a/docs/Api/TollFreeVerificationApi.md b/docs/Api/TollFreeVerificationApi.md index c4ca7f6e..f433558d 100644 --- a/docs/Api/TollFreeVerificationApi.md +++ b/docs/Api/TollFreeVerificationApi.md @@ -98,7 +98,7 @@ deleteVerificationRequest($account_id, $phone_number) - https://api.bandwidth.com/api/v2 Production Delete a Toll-Free Verification Submission -Delete a toll-free verification submission for a toll-free number. +Delete a toll-free verification submission for a toll-free number. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, it will be cancelled and the submission will then be deleted asynchronously. ### Example @@ -459,7 +459,7 @@ requestTollFreeVerification($account_id, $verification_request) - https://api.bandwidth.com/api/v2 Production Request Toll-Free Verification -Submit a request for verification of a toll-free phone number. +Submit a request for verification of a toll-free phone number. **Upcoming change (effective January 2027):** If any phone number in the request already has a verification in progress, the request will be rejected with a `409 Conflict`. This check is all-or-nothing: if a single phone number conflicts, the entire request is rejected and **none** of the phone numbers in the request are submitted. Today, these requests are accepted with a `202`. ### Example @@ -532,7 +532,7 @@ updateTollFreeVerificationRequest($account_id, $phone_number, $tfv_submission_wr - https://api.bandwidth.com/api/v2 Production Update Toll-Free Verification Request -Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). +Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). Returns a `404` if no verification request exists for the phone number, and a `400` if the existing request is not eligible for resubmission. **Upcoming change (effective January 2027):** If a verification for the phone number is in progress, the update will be rejected with a `409 Conflict`. ### Example diff --git a/docs/Model/TfvSubmissionInfo.md b/docs/Model/TfvSubmissionInfo.md index baa36f27..544ae6bd 100644 --- a/docs/Model/TfvSubmissionInfo.md +++ b/docs/Model/TfvSubmissionInfo.md @@ -16,9 +16,9 @@ Name | Type | Description | Notes **privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **string** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] +**business_registration_number** | **string** | Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] **business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] -**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] +**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/docs/Model/VerificationRequest.md b/docs/Model/VerificationRequest.md index cd5dcf68..d9bcdbd0 100644 --- a/docs/Model/VerificationRequest.md +++ b/docs/Model/VerificationRequest.md @@ -17,9 +17,9 @@ Name | Type | Description | Notes **privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **string** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] +**business_registration_number** | **string** | Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] **business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] -**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] +**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | **help_message_response** | **string** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] diff --git a/docs/Model/VerificationUpdateRequest.md b/docs/Model/VerificationUpdateRequest.md index 1d891fcc..a76a4568 100644 --- a/docs/Model/VerificationUpdateRequest.md +++ b/docs/Model/VerificationUpdateRequest.md @@ -16,10 +16,10 @@ Name | Type | Description | Notes **privacy_policy_url** | **string** | The Toll-Free Verification request privacy policy URL. | [optional] **terms_and_conditions_url** | **string** | The Toll-Free Verification request terms and conditions policy URL. | [optional] **business_dba** | **string** | The company 'Doing Business As'. | [optional] -**business_registration_number** | **string** | Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] +**business_registration_number** | **string** | Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** | [optional] **business_registration_type** | [**\Bandwidth\Model\BusinessRegistrationTypeEnum**](BusinessRegistrationTypeEnum.md) | | [optional] -**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | [optional] -**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] +**business_entity_type** | [**\Bandwidth\Model\BusinessEntityTypeEnum**](BusinessEntityTypeEnum.md) | | +**business_registration_issuing_country** | **string** | The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | | [optional] **help_message_response** | **string** | A message that gets sent to users requesting help. | [optional] **age_gated_content** | **bool** | Indicates whether the content is age-gated. | [optional] **cv_token** | **string** | The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection. | [optional] diff --git a/src/Api/MediaApi.php b/src/Api/MediaApi.php index c7948d11..d340797a 100644 --- a/src/Api/MediaApi.php +++ b/src/Api/MediaApi.php @@ -1487,7 +1487,7 @@ protected function getHostSettingsForlistMedia(): array * @param string $media_id The ID of the media file. (required) * @param \SplFileObject $body body (required) * @param string|null $content_type The media type of the entity-body. (optional) - * @param string|null $cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) + * @param string|null $cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. * @param string $contentType The value for the Content-Type header. Check self::contentTypes['uploadMedia'] to see the possible values for this operation @@ -1524,7 +1524,7 @@ public function uploadMedia( * @param string $media_id The ID of the media file. (required) * @param \SplFileObject $body (required) * @param string|null $content_type The media type of the entity-body. (optional) - * @param string|null $cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) + * @param string|null $cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. * @param string $contentType The value for the Content-Type header. Check self::contentTypes['uploadMedia'] to see the possible values for this operation @@ -1655,7 +1655,7 @@ public function uploadMediaWithHttpInfo( * @param string $media_id The ID of the media file. (required) * @param \SplFileObject $body (required) * @param string|null $content_type The media type of the entity-body. (optional) - * @param string|null $cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) + * @param string|null $cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. * @param string $contentType The value for the Content-Type header. Check self::contentTypes['uploadMedia'] to see the possible values for this operation @@ -1695,7 +1695,7 @@ function ($response) { * @param string $media_id The ID of the media file. (required) * @param \SplFileObject $body (required) * @param string|null $content_type The media type of the entity-body. (optional) - * @param string|null $cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) + * @param string|null $cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. * @param string $contentType The value for the Content-Type header. Check self::contentTypes['uploadMedia'] to see the possible values for this operation @@ -1751,7 +1751,7 @@ function ($exception) { * @param string $media_id The ID of the media file. (required) * @param \SplFileObject $body (required) * @param string|null $content_type The media type of the entity-body. (optional) - * @param string|null $cache_control General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. (optional) + * @param string|null $cache_control Pass-through header stored with the media and returned when the media is retrieved by the user. Does not affect internal server caching behavior. (optional) * @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead * @param array $variables Associative array of variables to pass to the host. Defaults to empty array. * @param string $contentType The value for the Content-Type header. Check self::contentTypes['uploadMedia'] to see the possible values for this operation diff --git a/src/Api/TollFreeVerificationApi.php b/src/Api/TollFreeVerificationApi.php index 95efd653..990a3b22 100644 --- a/src/Api/TollFreeVerificationApi.php +++ b/src/Api/TollFreeVerificationApi.php @@ -2838,6 +2838,14 @@ public function requestTollFreeVerificationWithHttpInfo( ); $e->setResponseObject($data); throw $e; + case 409: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Bandwidth\Model\TfvError', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + throw $e; case 429: $data = ObjectSerializer::deserialize( $e->getResponseBody(), @@ -3230,6 +3238,14 @@ public function updateTollFreeVerificationRequestWithHttpInfo( ); $e->setResponseObject($data); throw $e; + case 404: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Bandwidth\Model\TfvError', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + throw $e; case 405: $data = ObjectSerializer::deserialize( $e->getResponseBody(), @@ -3238,6 +3254,14 @@ public function updateTollFreeVerificationRequestWithHttpInfo( ); $e->setResponseObject($data); throw $e; + case 409: + $data = ObjectSerializer::deserialize( + $e->getResponseBody(), + '\Bandwidth\Model\TfvError', + $e->getResponseHeaders() + ); + $e->setResponseObject($data); + throw $e; case 429: $data = ObjectSerializer::deserialize( $e->getResponseBody(), diff --git a/src/Model/BusinessEntityTypeEnum.php b/src/Model/BusinessEntityTypeEnum.php index f2fb682d..39eb4cd6 100644 --- a/src/Model/BusinessEntityTypeEnum.php +++ b/src/Model/BusinessEntityTypeEnum.php @@ -31,7 +31,7 @@ /** * BusinessEntityTypeEnum Class Doc Comment * - * @description The type of registered business. **Note: As of October 19th, 2026 submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.** + * @description The type of registered business. **Submissions using a value other than `SOLE_PROPRIETOR` must provide a value for `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Submissions using `SOLE_PROPRIETOR` must _omit_ `businessRegistrationNumber`, `businessRegistrationType`, and `businessRegistrationIssuingCountry`. Failure to adhere to these constraints will result in a 400 Bad Request rejection.** * @package Bandwidth * @author OpenAPI Generator team * @link https://openapi-generator.tech diff --git a/src/Model/BusinessRegistrationTypeEnum.php b/src/Model/BusinessRegistrationTypeEnum.php index c639cde9..cbdfb8b2 100644 --- a/src/Model/BusinessRegistrationTypeEnum.php +++ b/src/Model/BusinessRegistrationTypeEnum.php @@ -31,7 +31,7 @@ /** * BusinessRegistrationTypeEnum Class Doc Comment * - * @description The type of business registration number. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** + * @description The type of business registration number. **This field is required when `businessRegistrationNumber` is provided.** * @package Bandwidth * @author OpenAPI Generator team * @link https://openapi-generator.tech diff --git a/src/Model/TfvSubmissionInfo.php b/src/Model/TfvSubmissionInfo.php index 0007e413..a715f7f8 100644 --- a/src/Model/TfvSubmissionInfo.php +++ b/src/Model/TfvSubmissionInfo.php @@ -838,7 +838,7 @@ public function getBusinessRegistrationNumber(): ?string /** * Sets business_registration_number * - * @param string|null $business_registration_number Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** + * @param string|null $business_registration_number Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** * * @return $this */ @@ -910,7 +910,7 @@ public function getBusinessRegistrationIssuingCountry(): ?string /** * Sets business_registration_issuing_country * - * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | + * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | * * @return $this */ diff --git a/src/Model/VerificationRequest.php b/src/Model/VerificationRequest.php index ec206e08..4e93da46 100644 --- a/src/Model/VerificationRequest.php +++ b/src/Model/VerificationRequest.php @@ -946,7 +946,7 @@ public function getBusinessRegistrationNumber(): ?string /** * Sets business_registration_number * - * @param string|null $business_registration_number Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** + * @param string|null $business_registration_number Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** * * @return $this */ @@ -1018,7 +1018,7 @@ public function getBusinessRegistrationIssuingCountry(): ?string /** * Sets business_registration_issuing_country * - * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | + * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | * * @return $this */ diff --git a/src/Model/VerificationUpdateRequest.php b/src/Model/VerificationUpdateRequest.php index c213ac3f..33343b42 100644 --- a/src/Model/VerificationUpdateRequest.php +++ b/src/Model/VerificationUpdateRequest.php @@ -463,6 +463,9 @@ public function listInvalidProperties(): array $invalidProperties[] = "invalid value for 'business_registration_number', the character length must be smaller than or equal to 500."; } + if ($this->container['business_entity_type'] === null) { + $invalidProperties[] = "'business_entity_type' can't be null"; + } if (!is_null($this->container['help_message_response']) && (mb_strlen($this->container['help_message_response']) > 500)) { $invalidProperties[] = "invalid value for 'help_message_response', the character length must be smaller than or equal to 500."; } @@ -892,7 +895,7 @@ public function getBusinessRegistrationNumber(): ?string /** * Sets business_registration_number * - * @param string|null $business_registration_number Government-issued business identifying number. **Note: As of October 19th, 2026 this field will be required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** + * @param string|null $business_registration_number Government-issued business identifying number. **This field is required when `businessEntityType` is _not_ `SOLE_PROPRIETOR`. If this field is provided, `businessRegistrationType` and `businessRegistrationIssuingCountry` are also required.** * * @return $this */ @@ -954,9 +957,9 @@ public function setBusinessRegistrationType(?\Bandwidth\Model\BusinessRegistrati /** * Gets business_entity_type * - * @return \Bandwidth\Model\BusinessEntityTypeEnum|null + * @return \Bandwidth\Model\BusinessEntityTypeEnum */ - public function getBusinessEntityType(): ?\Bandwidth\Model\BusinessEntityTypeEnum + public function getBusinessEntityType(): \Bandwidth\Model\BusinessEntityTypeEnum { return $this->container['business_entity_type']; } @@ -964,11 +967,11 @@ public function getBusinessEntityType(): ?\Bandwidth\Model\BusinessEntityTypeEnu /** * Sets business_entity_type * - * @param \Bandwidth\Model\BusinessEntityTypeEnum|null $business_entity_type business_entity_type + * @param \Bandwidth\Model\BusinessEntityTypeEnum $business_entity_type business_entity_type * * @return $this */ - public function setBusinessEntityType(?\Bandwidth\Model\BusinessEntityTypeEnum $business_entity_type): static + public function setBusinessEntityType(\Bandwidth\Model\BusinessEntityTypeEnum $business_entity_type): static { if (is_null($business_entity_type)) { throw new InvalidArgumentException('non-nullable business_entity_type cannot be null'); @@ -991,7 +994,7 @@ public function getBusinessRegistrationIssuingCountry(): ?string /** * Sets business_registration_issuing_country * - * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **Note: As of October 19th, 2026 this field will be required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | + * @param string|null $business_registration_issuing_country The country issuing the business registration in ISO-3166-1 alpha-3 format. Alpha-2 format is accepted by the API, but alpha-3 is highly encouraged. **This field is required when `businessRegistrationNumber` is provided.** | Registration Type | Supported Countries | |----------------------|------------------------------------| | EIN | USA | | CBN | CAN | | NEQ | CAN | | PROVINCIAL_NUMBER | CAN | | CRN | GBR, HKG | | VAT | GBR, IRL, BRA, NLD | | ACN | AUS | | ABN | AUS | | BRN | HKG | | SIREN | FRA | | SIRET | FRA | | NZBN | NZL | | UST_IDNR | DEU | | CIF | ESP | | NIF | ESP | | CNPJ | BRA | | UID | CHE | | OTHER | Must Provide Country Code | * * @return $this */