bandwidth-sdk 8.0.0 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy.yml +1 -1
- package/.github/workflows/test-pr.yml +1 -1
- package/.github/workflows/test-smoke.yml +1 -1
- package/.openapi-generator/FILES +48 -2
- package/README.md +28 -1
- package/api/endpoints-api.ts +519 -0
- package/api.ts +1 -0
- package/bandwidth.yml +937 -19
- package/base.ts +30 -0
- package/configuration.ts +1 -1
- package/coverage/clover.xml +815 -611
- package/coverage/coverage-final.json +95 -87
- package/coverage/lcov-report/index.html +38 -38
- package/coverage/lcov-report/node-sdk/api/calls-api.ts.html +14 -14
- package/coverage/lcov-report/node-sdk/api/conferences-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/endpoints-api.ts.html +1642 -0
- package/coverage/lcov-report/node-sdk/api/index.html +24 -9
- package/coverage/lcov-report/node-sdk/api/media-api.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/api/messages-api.ts.html +11 -11
- package/coverage/lcov-report/node-sdk/api/mfaapi.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/multi-channel-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/phone-number-lookup-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api/recordings-api.ts.html +19 -19
- package/coverage/lcov-report/node-sdk/api/statistics-api.ts.html +10 -10
- package/coverage/lcov-report/node-sdk/api/toll-free-verification-api.ts.html +18 -18
- package/coverage/lcov-report/node-sdk/api/transcriptions-api.ts.html +12 -12
- package/coverage/lcov-report/node-sdk/api.ts.html +18 -15
- package/coverage/lcov-report/node-sdk/base.ts.html +104 -14
- package/coverage/lcov-report/node-sdk/common.ts.html +39 -39
- package/coverage/lcov-report/node-sdk/configuration.ts.html +26 -26
- package/coverage/lcov-report/node-sdk/index.html +7 -7
- package/coverage/lcov-report/node-sdk/models/business-entity-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/business-registration-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/bxml/Bxml.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/NestableVerb.ts.html +23 -23
- package/coverage/lcov-report/node-sdk/models/bxml/Response.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/Root.ts.html +8 -8
- package/coverage/lcov-report/node-sdk/models/bxml/Verb.ts.html +13 -13
- package/coverage/lcov-report/node-sdk/models/bxml/index.html +15 -15
- package/coverage/lcov-report/node-sdk/models/bxml/index.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Bridge.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Conference.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Connect.ts.html +184 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/CustomParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Endpoint.ts.html +142 -0
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Forward.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Gather.ts.html +7 -7
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Hangup.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Pause.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PauseRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PhoneNumber.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/PlayAudio.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Record.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Redirect.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/ResumeRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Ring.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SendDtmf.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SipUri.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/SpeakSentence.ts.html +6 -6
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartStream.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StartTranscription.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopGather.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopRecording.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopStream.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StopTranscription.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/StreamParam.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Tag.ts.html +4 -4
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/Transfer.ts.html +5 -5
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.html +38 -8
- package/coverage/lcov-report/node-sdk/models/bxml/verbs/index.ts.html +39 -33
- package/coverage/lcov-report/node-sdk/models/call-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-detected-language-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/call-transcription-track-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/callback-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/card-width-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/completed-lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/conference-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/deactivation-event-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/device-status-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-direction-enum.ts.html +166 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-event-type-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-status-enum.ts.html +163 -0
- package/coverage/lcov-report/node-sdk/models/endpoint-type-enum.ts.html +160 -0
- package/coverage/lcov-report/node-sdk/models/file-format-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/in-progress-lookup-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/inbound-callback-type-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/index.html +80 -5
- package/coverage/lcov-report/node-sdk/models/index.ts.html +247 -181
- package/coverage/lcov-report/node-sdk/models/latest-message-delivery-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/line-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/list-message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/machine-detection-mode-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-direction-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/message-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/multi-channel-message-channel-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/priority-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/product-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-action-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-media-height-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/rbm-open-url-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/rbm-web-view-enum.ts.html +3 -3
- package/coverage/lcov-report/node-sdk/models/recording-state-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/redirect-method-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/standalone-card-orientation-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/status-callback-type-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-callback-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/tfv-status-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/thumbnail-alignment-enum.ts.html +2 -2
- package/coverage/lcov-report/node-sdk/models/webhook-subscription-type-enum.ts.html +2 -2
- package/coverage/lcov.info +1234 -761
- package/custom_templates/modelAllOf.mustache +14 -0
- package/dist/api/endpoints-api.d.ts +236 -0
- package/dist/api/endpoints-api.js +666 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +30 -0
- package/dist/configuration.js +1 -1
- package/dist/models/brtc-error-response.d.ts +18 -0
- package/dist/models/brtc-error-source.d.ts +29 -0
- package/dist/models/brtc-error-source.js +15 -0
- package/dist/models/brtc-error.d.ts +31 -0
- package/dist/models/brtc-error.js +15 -0
- package/dist/models/brtc-link.d.ts +25 -0
- package/dist/models/brtc-link.js +15 -0
- package/dist/models/bxml/verbs/Connect.d.ts +25 -0
- package/dist/models/bxml/verbs/Connect.js +45 -0
- package/dist/models/bxml/verbs/Endpoint.d.ts +15 -0
- package/dist/models/bxml/verbs/Endpoint.js +37 -0
- package/dist/models/bxml/verbs/index.d.ts +2 -0
- package/dist/models/bxml/verbs/index.js +2 -0
- package/dist/models/create-call.d.ts +2 -2
- package/dist/models/create-endpoint-request-base.d.ts +29 -0
- package/dist/models/create-endpoint-request-base.js +15 -0
- package/dist/models/create-endpoint-response-data.d.ts +42 -0
- package/dist/models/create-endpoint-response-data.js +15 -0
- package/dist/models/create-endpoint-response.d.ts +19 -0
- package/dist/models/create-endpoint-response.js +15 -0
- package/dist/models/create-web-rtc-connection-request.d.ts +33 -0
- package/dist/models/create-web-rtc-connection-request.js +15 -0
- package/dist/models/device-status-enum.d.ts +16 -0
- package/dist/models/device-status-enum.js +20 -0
- package/dist/models/device.d.ts +27 -0
- package/dist/models/device.js +15 -0
- package/dist/models/endpoint-direction-enum.d.ts +17 -0
- package/dist/models/endpoint-direction-enum.js +21 -0
- package/dist/models/endpoint-event-type-enum.d.ts +16 -0
- package/dist/models/endpoint-event-type-enum.js +20 -0
- package/dist/models/endpoint-event.d.ts +45 -0
- package/dist/models/endpoint-event.js +15 -0
- package/dist/models/endpoint-response.d.ts +19 -0
- package/dist/models/endpoint-response.js +15 -0
- package/dist/models/endpoint-status-enum.d.ts +16 -0
- package/dist/models/endpoint-status-enum.js +20 -0
- package/dist/models/endpoint-type-enum.d.ts +15 -0
- package/dist/models/endpoint-type-enum.js +19 -0
- package/dist/models/endpoint.d.ts +38 -0
- package/dist/models/endpoint.js +15 -0
- package/dist/models/endpoints.d.ts +33 -0
- package/dist/models/endpoints.js +15 -0
- package/dist/models/inbound-callback-message.d.ts +48 -2
- package/dist/models/inbound-callback-type-enum.d.ts +1 -1
- package/dist/models/inbound-callback-type-enum.js +1 -1
- package/dist/models/inbound-callback.d.ts +2 -2
- package/dist/models/index.d.ts +23 -1
- package/dist/models/index.js +23 -1
- package/dist/models/list-endpoints-response.d.ts +21 -0
- package/dist/models/list-endpoints-response.js +15 -0
- package/dist/models/lookup-result.d.ts +1 -1
- package/dist/models/machine-detection-configuration.d.ts +1 -1
- package/dist/models/message-request.d.ts +1 -1
- package/dist/models/multi-channel-action-calendar-event.d.ts +28 -2
- package/dist/models/multi-channel-channel-list-mmsobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-mmsresponse-object.d.ts +18 -3
- package/dist/models/multi-channel-channel-list-rbmobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-rbmresponse-object.d.ts +18 -3
- package/dist/models/multi-channel-channel-list-smsobject.d.ts +14 -2
- package/dist/models/multi-channel-channel-list-smsresponse-object.d.ts +18 -3
- package/dist/models/page.d.ts +29 -0
- package/dist/models/page.js +15 -0
- package/dist/models/rbm-action-dial.d.ts +16 -2
- package/dist/models/rbm-action-open-url.d.ts +20 -2
- package/dist/models/rbm-action-view-location.d.ts +24 -2
- package/dist/models/rbm-card-content-media.d.ts +12 -2
- package/dist/models/rbm-open-url-enum.d.ts +1 -1
- package/dist/models/rbm-open-url-enum.js +1 -1
- package/dist/models/rbm-web-view-enum.d.ts +1 -1
- package/dist/models/rbm-web-view-enum.js +1 -1
- package/dist/models/sip-connection-metadata.d.ts +27 -0
- package/dist/models/sip-connection-metadata.js +15 -0
- package/dist/models/sip-credentials.d.ts +21 -0
- package/dist/models/sip-credentials.js +15 -0
- package/dist/models/status-callback.d.ts +1 -1
- package/dist/models/update-call.d.ts +1 -1
- package/dist/models/{model-error.d.ts → webhook-subscription-error.d.ts} +1 -1
- package/dist/models/webhook-subscription-error.js +15 -0
- package/dist/models/webhook-subscriptions-list-body.d.ts +2 -2
- package/docs/BrtcError.md +28 -0
- package/docs/BrtcErrorResponse.md +24 -0
- package/docs/BrtcErrorSource.md +26 -0
- package/docs/BrtcLink.md +24 -0
- package/docs/Callback.md +2 -2
- package/docs/CreateCall.md +2 -2
- package/docs/CreateEndpointRequestBase.md +28 -0
- package/docs/CreateEndpointResponse.md +24 -0
- package/docs/CreateEndpointResponseData.md +34 -0
- package/docs/CreateWebRtcConnectionRequest.md +30 -0
- package/docs/Device.md +26 -0
- package/docs/DeviceStatusEnum.md +10 -0
- package/docs/Endpoint.md +32 -0
- package/docs/EndpointDirectionEnum.md +12 -0
- package/docs/EndpointEvent.md +37 -0
- package/docs/EndpointEventTypeEnum.md +10 -0
- package/docs/EndpointResponse.md +24 -0
- package/docs/EndpointStatusEnum.md +10 -0
- package/docs/EndpointTypeEnum.md +8 -0
- package/docs/Endpoints.md +30 -0
- package/docs/EndpointsApi.md +334 -0
- package/docs/InboundCallback.md +2 -2
- package/docs/InboundCallbackTypeEnum.md +1 -1
- package/docs/ListEndpointsResponse.md +26 -0
- package/docs/LookupResult.md +1 -1
- package/docs/MachineDetectionConfiguration.md +1 -1
- package/docs/MessageRequest.md +1 -1
- package/docs/Page.md +26 -0
- package/docs/RbmOpenUrlEnum.md +1 -1
- package/docs/RbmWebViewEnum.md +1 -1
- package/docs/SipConnectionMetadata.md +26 -0
- package/docs/SipCredentials.md +22 -0
- package/docs/StatusCallback.md +1 -1
- package/docs/UpdateCall.md +1 -1
- package/docs/{Error.md → WebhookSubscriptionError.md} +3 -3
- package/docs/WebhookSubscriptionsListBody.md +1 -1
- package/models/brtc-error-response.ts +28 -0
- package/models/brtc-error-source.ts +35 -0
- package/models/brtc-error.ts +39 -0
- package/models/brtc-link.ts +31 -0
- package/models/bxml/verbs/Connect.ts +33 -0
- package/models/bxml/verbs/Endpoint.ts +19 -0
- package/models/bxml/verbs/index.ts +2 -0
- package/models/create-call.ts +2 -2
- package/models/create-endpoint-request-base.ts +41 -0
- package/models/create-endpoint-response-data.ts +58 -0
- package/models/create-endpoint-response.ts +31 -0
- package/models/create-web-rtc-connection-request.ts +47 -0
- package/models/device-status-enum.ts +26 -0
- package/models/device.ts +37 -0
- package/models/endpoint-direction-enum.ts +27 -0
- package/models/endpoint-event-type-enum.ts +26 -0
- package/models/endpoint-event.ts +63 -0
- package/models/endpoint-response.ts +31 -0
- package/models/endpoint-status-enum.ts +26 -0
- package/models/endpoint-type-enum.ts +25 -0
- package/models/endpoint.ts +54 -0
- package/models/endpoints.ts +45 -0
- package/models/inbound-callback-message.ts +42 -1
- package/models/inbound-callback-type-enum.ts +1 -1
- package/models/inbound-callback.ts +2 -2
- package/models/index.ts +23 -1
- package/models/list-endpoints-response.ts +35 -0
- package/models/lookup-result.ts +1 -1
- package/models/machine-detection-configuration.ts +1 -1
- package/models/message-request.ts +1 -1
- package/models/multi-channel-action-calendar-event.ts +27 -1
- package/models/multi-channel-channel-list-mmsobject.ts +12 -1
- package/models/multi-channel-channel-list-mmsresponse-object.ts +16 -1
- package/models/multi-channel-channel-list-rbmobject.ts +12 -1
- package/models/multi-channel-channel-list-rbmresponse-object.ts +16 -1
- package/models/multi-channel-channel-list-smsobject.ts +12 -1
- package/models/multi-channel-channel-list-smsresponse-object.ts +16 -1
- package/models/page.ts +35 -0
- package/models/rbm-action-dial.ts +15 -1
- package/models/rbm-action-open-url.ts +17 -1
- package/models/rbm-action-view-location.ts +23 -1
- package/models/rbm-card-content-media.ts +11 -1
- package/models/rbm-open-url-enum.ts +1 -1
- package/models/rbm-web-view-enum.ts +1 -1
- package/models/sip-connection-metadata.ts +35 -0
- package/models/sip-credentials.ts +27 -0
- package/models/status-callback.ts +1 -1
- package/models/update-call.ts +1 -1
- package/models/{model-error.ts → webhook-subscription-error.ts} +1 -1
- package/models/webhook-subscriptions-list-body.ts +3 -3
- package/package.json +1 -1
- package/tests/smoke/endpoints-api.test.ts +141 -0
- package/tests/unit/api/endpoints-api.test.ts +106 -0
- package/tests/unit/models/brtc-error-response.test.ts +50 -0
- package/tests/unit/models/brtc-error-source.test.ts +17 -0
- package/tests/unit/models/brtc-error.test.ts +30 -0
- package/tests/unit/models/brtc-link.test.ts +15 -0
- package/tests/unit/models/bxml/verbs/Connect.test.ts +47 -0
- package/tests/unit/models/bxml/verbs/Endpoint.test.ts +12 -0
- package/tests/unit/models/create-endpoint-request-base.test.ts +21 -0
- package/tests/unit/models/create-endpoint-response-data.test.ts +44 -0
- package/tests/unit/models/create-endpoint-response.test.ts +86 -0
- package/tests/unit/models/create-web-rtc-connection-request.test.ts +21 -0
- package/tests/unit/models/device-status-enum.test.ts +12 -0
- package/tests/unit/models/device.test.ts +19 -0
- package/tests/unit/models/endpoint-direction-enum.test.ts +14 -0
- package/tests/unit/models/endpoint-event-type-enum.test.ts +12 -0
- package/tests/unit/models/endpoint-event.test.ts +44 -0
- package/tests/unit/models/endpoint-response.test.ts +84 -0
- package/tests/unit/models/endpoint-status-enum.test.ts +12 -0
- package/tests/unit/models/endpoint-type-enum.test.ts +10 -0
- package/tests/unit/models/endpoint.test.ts +50 -0
- package/tests/unit/models/endpoints.test.ts +25 -0
- package/tests/unit/models/list-endpoints-response.test.ts +94 -0
- package/tests/unit/models/page.test.ts +17 -0
- package/tests/unit/models/sip-connection-metadata.test.ts +25 -0
- package/tests/unit/models/sip-credentials.test.ts +13 -0
- /package/dist/models/{model-error.js → brtc-error-response.js} +0 -0
package/bandwidth.yml
CHANGED
|
@@ -22,6 +22,7 @@ tags:
|
|
|
22
22
|
- name: MFA
|
|
23
23
|
- name: Phone Number Lookup
|
|
24
24
|
- name: Toll-Free Verification
|
|
25
|
+
- name: Endpoints
|
|
25
26
|
paths:
|
|
26
27
|
/users/{accountId}/media:
|
|
27
28
|
get:
|
|
@@ -1690,6 +1691,180 @@ paths:
|
|
|
1690
1691
|
'503':
|
|
1691
1692
|
$ref: '#/components/responses/tfvServiceUnavailableResponse'
|
|
1692
1693
|
servers: *ref_4
|
|
1694
|
+
/accounts/{accountId}/endpoints:
|
|
1695
|
+
get:
|
|
1696
|
+
tags:
|
|
1697
|
+
- Endpoints
|
|
1698
|
+
summary: List Endpoints
|
|
1699
|
+
description: Returns a list of endpoints associated with the specified account.
|
|
1700
|
+
operationId: listEndpoints
|
|
1701
|
+
parameters:
|
|
1702
|
+
- $ref: '#/components/parameters/accountId'
|
|
1703
|
+
- $ref: '#/components/parameters/endpointType'
|
|
1704
|
+
- $ref: '#/components/parameters/endpointStatus'
|
|
1705
|
+
- $ref: '#/components/parameters/afterCursor'
|
|
1706
|
+
- $ref: '#/components/parameters/limit1'
|
|
1707
|
+
responses:
|
|
1708
|
+
'200':
|
|
1709
|
+
$ref: '#/components/responses/listEndpointsResponse'
|
|
1710
|
+
'400':
|
|
1711
|
+
$ref: '#/components/responses/badRequestErrorResponse'
|
|
1712
|
+
'401':
|
|
1713
|
+
$ref: '#/components/responses/unauthorizedErrorResponse'
|
|
1714
|
+
'403':
|
|
1715
|
+
$ref: '#/components/responses/forbiddenErrorResponse'
|
|
1716
|
+
'404':
|
|
1717
|
+
$ref: '#/components/responses/notFoundErrorResponse'
|
|
1718
|
+
'405':
|
|
1719
|
+
$ref: '#/components/responses/methodNotAllowedErrorResponse'
|
|
1720
|
+
'415':
|
|
1721
|
+
$ref: '#/components/responses/unsupportedMediaTypeErrorResponse'
|
|
1722
|
+
'429':
|
|
1723
|
+
$ref: '#/components/responses/tooManyRequestsErrorResponse'
|
|
1724
|
+
'500':
|
|
1725
|
+
$ref: '#/components/responses/serviceUnavailableErrorResponse'
|
|
1726
|
+
x-badges:
|
|
1727
|
+
- name: Beta
|
|
1728
|
+
color: '#076EA8'
|
|
1729
|
+
post:
|
|
1730
|
+
tags:
|
|
1731
|
+
- Endpoints
|
|
1732
|
+
summary: Create Endpoint
|
|
1733
|
+
description: Creates a new Endpoint for the specified account.
|
|
1734
|
+
operationId: createEndpoint
|
|
1735
|
+
parameters:
|
|
1736
|
+
- $ref: '#/components/parameters/accountId'
|
|
1737
|
+
requestBody:
|
|
1738
|
+
$ref: '#/components/requestBodies/createEndpointRequest'
|
|
1739
|
+
responses:
|
|
1740
|
+
'201':
|
|
1741
|
+
$ref: '#/components/responses/createEndpointResponse'
|
|
1742
|
+
'400':
|
|
1743
|
+
$ref: '#/components/responses/badRequestErrorResponse'
|
|
1744
|
+
'401':
|
|
1745
|
+
$ref: '#/components/responses/unauthorizedErrorResponse'
|
|
1746
|
+
'403':
|
|
1747
|
+
$ref: '#/components/responses/forbiddenErrorResponse'
|
|
1748
|
+
'404':
|
|
1749
|
+
$ref: '#/components/responses/notFoundErrorResponse'
|
|
1750
|
+
'405':
|
|
1751
|
+
$ref: '#/components/responses/methodNotAllowedErrorResponse'
|
|
1752
|
+
'415':
|
|
1753
|
+
$ref: '#/components/responses/unsupportedMediaTypeErrorResponse'
|
|
1754
|
+
'429':
|
|
1755
|
+
$ref: '#/components/responses/tooManyRequestsErrorResponse'
|
|
1756
|
+
'500':
|
|
1757
|
+
$ref: '#/components/responses/serviceUnavailableErrorResponse'
|
|
1758
|
+
callbacks:
|
|
1759
|
+
endpointEventCallback:
|
|
1760
|
+
$ref: '#/components/callbacks/endpointEvent'
|
|
1761
|
+
x-badges:
|
|
1762
|
+
- name: Beta
|
|
1763
|
+
color: '#076EA8'
|
|
1764
|
+
servers: &ref_5
|
|
1765
|
+
- url: https://api.bandwidth.com/v2
|
|
1766
|
+
description: Production
|
|
1767
|
+
/accounts/{accountId}/endpoints/{endpointId}:
|
|
1768
|
+
get:
|
|
1769
|
+
tags:
|
|
1770
|
+
- Endpoints
|
|
1771
|
+
summary: Get Endpoint
|
|
1772
|
+
description: Returns information about the specified endpoint.
|
|
1773
|
+
operationId: getEndpoint
|
|
1774
|
+
parameters:
|
|
1775
|
+
- $ref: '#/components/parameters/accountId'
|
|
1776
|
+
- $ref: '#/components/parameters/endpointId'
|
|
1777
|
+
responses:
|
|
1778
|
+
'200':
|
|
1779
|
+
$ref: '#/components/responses/getEndpointResponse'
|
|
1780
|
+
'400':
|
|
1781
|
+
$ref: '#/components/responses/badRequestErrorResponse'
|
|
1782
|
+
'401':
|
|
1783
|
+
$ref: '#/components/responses/unauthorizedErrorResponse'
|
|
1784
|
+
'403':
|
|
1785
|
+
$ref: '#/components/responses/forbiddenErrorResponse'
|
|
1786
|
+
'404':
|
|
1787
|
+
$ref: '#/components/responses/notFoundErrorResponse'
|
|
1788
|
+
'405':
|
|
1789
|
+
$ref: '#/components/responses/methodNotAllowedErrorResponse'
|
|
1790
|
+
'415':
|
|
1791
|
+
$ref: '#/components/responses/unsupportedMediaTypeErrorResponse'
|
|
1792
|
+
'429':
|
|
1793
|
+
$ref: '#/components/responses/tooManyRequestsErrorResponse'
|
|
1794
|
+
'500':
|
|
1795
|
+
$ref: '#/components/responses/serviceUnavailableErrorResponse'
|
|
1796
|
+
x-badges:
|
|
1797
|
+
- name: Beta
|
|
1798
|
+
color: '#076EA8'
|
|
1799
|
+
delete:
|
|
1800
|
+
tags:
|
|
1801
|
+
- Endpoints
|
|
1802
|
+
summary: Delete Endpoint
|
|
1803
|
+
description: >-
|
|
1804
|
+
Deletes the specified endpoint. If the endpoint is actively streaming
|
|
1805
|
+
media, the media stream will be terminated.
|
|
1806
|
+
operationId: deleteEndpoint
|
|
1807
|
+
parameters:
|
|
1808
|
+
- $ref: '#/components/parameters/accountId'
|
|
1809
|
+
- $ref: '#/components/parameters/endpointId'
|
|
1810
|
+
responses:
|
|
1811
|
+
'204':
|
|
1812
|
+
description: No Content
|
|
1813
|
+
'400':
|
|
1814
|
+
$ref: '#/components/responses/badRequestErrorResponse'
|
|
1815
|
+
'401':
|
|
1816
|
+
$ref: '#/components/responses/unauthorizedErrorResponse'
|
|
1817
|
+
'403':
|
|
1818
|
+
$ref: '#/components/responses/forbiddenErrorResponse'
|
|
1819
|
+
'404':
|
|
1820
|
+
$ref: '#/components/responses/notFoundErrorResponse'
|
|
1821
|
+
'405':
|
|
1822
|
+
$ref: '#/components/responses/methodNotAllowedErrorResponse'
|
|
1823
|
+
'415':
|
|
1824
|
+
$ref: '#/components/responses/unsupportedMediaTypeErrorResponse'
|
|
1825
|
+
'429':
|
|
1826
|
+
$ref: '#/components/responses/tooManyRequestsErrorResponse'
|
|
1827
|
+
'500':
|
|
1828
|
+
$ref: '#/components/responses/serviceUnavailableErrorResponse'
|
|
1829
|
+
x-badges:
|
|
1830
|
+
- name: Beta
|
|
1831
|
+
color: '#076EA8'
|
|
1832
|
+
servers: *ref_5
|
|
1833
|
+
/accounts/{accountId}/endpoints/{endpointId}/bxml:
|
|
1834
|
+
put:
|
|
1835
|
+
tags:
|
|
1836
|
+
- Endpoints
|
|
1837
|
+
summary: Update Endpoint BXML
|
|
1838
|
+
description: Updates the BXML for the specified endpoint.
|
|
1839
|
+
operationId: updateEndpointBxml
|
|
1840
|
+
parameters:
|
|
1841
|
+
- $ref: '#/components/parameters/accountId'
|
|
1842
|
+
- $ref: '#/components/parameters/endpointId'
|
|
1843
|
+
requestBody:
|
|
1844
|
+
$ref: '#/components/requestBodies/updateEndpointBxmlRequest'
|
|
1845
|
+
responses:
|
|
1846
|
+
'204':
|
|
1847
|
+
description: No Content
|
|
1848
|
+
'400':
|
|
1849
|
+
$ref: '#/components/responses/badRequestErrorResponse'
|
|
1850
|
+
'401':
|
|
1851
|
+
$ref: '#/components/responses/unauthorizedErrorResponse'
|
|
1852
|
+
'403':
|
|
1853
|
+
$ref: '#/components/responses/forbiddenErrorResponse'
|
|
1854
|
+
'404':
|
|
1855
|
+
$ref: '#/components/responses/notFoundErrorResponse'
|
|
1856
|
+
'405':
|
|
1857
|
+
$ref: '#/components/responses/methodNotAllowedErrorResponse'
|
|
1858
|
+
'415':
|
|
1859
|
+
$ref: '#/components/responses/unsupportedMediaTypeErrorResponse'
|
|
1860
|
+
'429':
|
|
1861
|
+
$ref: '#/components/responses/tooManyRequestsErrorResponse'
|
|
1862
|
+
'500':
|
|
1863
|
+
$ref: '#/components/responses/serviceUnavailableErrorResponse'
|
|
1864
|
+
x-badges:
|
|
1865
|
+
- name: Beta
|
|
1866
|
+
color: '#076EA8'
|
|
1867
|
+
servers: *ref_5
|
|
1693
1868
|
components:
|
|
1694
1869
|
schemas:
|
|
1695
1870
|
applicationId:
|
|
@@ -1986,7 +2161,7 @@ components:
|
|
|
1986
2161
|
type: string
|
|
1987
2162
|
description: >-
|
|
1988
2163
|
The name of the Authorized Message Provider (AMP) that handled this
|
|
1989
|
-
message.
|
|
2164
|
+
message.
|
|
1990
2165
|
|
|
1991
2166
|
In the US, this is the carrier that the message was sent to.
|
|
1992
2167
|
|
|
@@ -2073,7 +2248,7 @@ components:
|
|
|
2073
2248
|
description: >-
|
|
2074
2249
|
Either an alphanumeric sender ID or the sender's Bandwidth phone
|
|
2075
2250
|
number in E.164 format, which must be hosted within Bandwidth and
|
|
2076
|
-
linked to the account that is generating the message.
|
|
2251
|
+
linked to the account that is generating the message.
|
|
2077
2252
|
|
|
2078
2253
|
Alphanumeric Sender IDs can contain up to 11 characters, upper-case
|
|
2079
2254
|
letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -,
|
|
@@ -2396,8 +2571,8 @@ components:
|
|
|
2396
2571
|
Specifies how the URL should be opened on a mobile device.
|
|
2397
2572
|
|
|
2398
2573
|
- `BROWSER` Opens the URL in the device's default browser. If
|
|
2399
|
-
application is not set or the device doesn
|
|
2400
|
-
option is used by default.
|
|
2574
|
+
application is not set or the device doesn't support WebView, this
|
|
2575
|
+
option is used by default.
|
|
2401
2576
|
|
|
2402
2577
|
- `WEBVIEW` Opens the URL in an in-app WebView.
|
|
2403
2578
|
enum:
|
|
@@ -2410,7 +2585,7 @@ components:
|
|
|
2410
2585
|
Defines the layout of the WebView on a mobile device. It must be defined
|
|
2411
2586
|
when application is set to `WEBVIEW`
|
|
2412
2587
|
|
|
2413
|
-
- `FULL` WebView takes the full screen.
|
|
2588
|
+
- `FULL` WebView takes the full screen.
|
|
2414
2589
|
|
|
2415
2590
|
- `HALF` WebView takes half of the screen.
|
|
2416
2591
|
|
|
@@ -2812,7 +2987,7 @@ components:
|
|
|
2812
2987
|
to:
|
|
2813
2988
|
type: string
|
|
2814
2989
|
description: >
|
|
2815
|
-
The destination phone number the message was sent to.
|
|
2990
|
+
The destination phone number the message was sent to.
|
|
2816
2991
|
|
|
2817
2992
|
For inbound callbacks, this is the Bandwidth number or alphanumeric
|
|
2818
2993
|
identifier that received the message.
|
|
@@ -2863,7 +3038,7 @@ components:
|
|
|
2863
3038
|
client to a Bandwidth number.
|
|
2864
3039
|
|
|
2865
3040
|
- `request-location-response` indicates a response to a location request
|
|
2866
|
-
sent by the Bandwidth user's client after receiving an RBM message.
|
|
3041
|
+
sent by the Bandwidth user's client after receiving an RBM message.
|
|
2867
3042
|
|
|
2868
3043
|
- `suggestion-response` indicates a response to a suggestion sent by the
|
|
2869
3044
|
Bandwidth user's client after receiving an RBM message.
|
|
@@ -3102,7 +3277,7 @@ components:
|
|
|
3102
3277
|
nullable: true
|
|
3103
3278
|
type: string
|
|
3104
3279
|
description: >-
|
|
3105
|
-
The caller display name to use when the call is created.
|
|
3280
|
+
The caller display name to use when the call is created.
|
|
3106
3281
|
|
|
3107
3282
|
May not exceed 256 characters nor contain control characters such as
|
|
3108
3283
|
new lines.
|
|
@@ -3280,8 +3455,8 @@ components:
|
|
|
3280
3455
|
May be cleared by setting `tag=""`
|
|
3281
3456
|
|
|
3282
3457
|
|
|
3283
|
-
Max length
|
|
3284
|
-
maxLength:
|
|
3458
|
+
Max length 4096 characters.
|
|
3459
|
+
maxLength: 4096
|
|
3285
3460
|
example: arbitrary text here
|
|
3286
3461
|
createCallResponse:
|
|
3287
3462
|
type: object
|
|
@@ -3658,11 +3833,11 @@ components:
|
|
|
3658
3833
|
May be cleared by setting `tag=""`.
|
|
3659
3834
|
|
|
3660
3835
|
|
|
3661
|
-
Max length
|
|
3836
|
+
Max length 4096 characters.
|
|
3662
3837
|
|
|
3663
3838
|
|
|
3664
3839
|
Not allowed if `state` is `completed`.
|
|
3665
|
-
maxLength:
|
|
3840
|
+
maxLength: 4096
|
|
3666
3841
|
example: My Custom Tag
|
|
3667
3842
|
updateCallRecording:
|
|
3668
3843
|
type: object
|
|
@@ -4039,7 +4214,7 @@ components:
|
|
|
4039
4214
|
format: double
|
|
4040
4215
|
description: >-
|
|
4041
4216
|
When an answering machine is detected, the amount of silence (in
|
|
4042
|
-
seconds) before assuming the message has finished playing.
|
|
4217
|
+
seconds) before assuming the message has finished playing.
|
|
4043
4218
|
|
|
4044
4219
|
If not provided it will default to the speechEndThreshold value.
|
|
4045
4220
|
example: 5
|
|
@@ -5783,7 +5958,7 @@ components:
|
|
|
5783
5958
|
format: date
|
|
5784
5959
|
description: >-
|
|
5785
5960
|
[DNI-Only](#section/DNI-Only). The date the phone number entered the
|
|
5786
|
-
status described in `latestMessageDeliveryStatus`.
|
|
5961
|
+
status described in `latestMessageDeliveryStatus`.
|
|
5787
5962
|
|
|
5788
5963
|
Think of this as the "start time" for that status.
|
|
5789
5964
|
|
|
@@ -6460,7 +6635,7 @@ components:
|
|
|
6460
6635
|
errors:
|
|
6461
6636
|
type: array
|
|
6462
6637
|
items:
|
|
6463
|
-
$ref: '#/components/schemas/
|
|
6638
|
+
$ref: '#/components/schemas/webhookSubscriptionError'
|
|
6464
6639
|
data:
|
|
6465
6640
|
items:
|
|
6466
6641
|
$ref: '#/components/schemas/webhookSubscription'
|
|
@@ -6486,7 +6661,7 @@ components:
|
|
|
6486
6661
|
If more results exist than specified by 'size', this link return the
|
|
6487
6662
|
last page of result.
|
|
6488
6663
|
type: string
|
|
6489
|
-
|
|
6664
|
+
webhookSubscriptionError:
|
|
6490
6665
|
type: object
|
|
6491
6666
|
properties:
|
|
6492
6667
|
code:
|
|
@@ -6687,6 +6862,365 @@ components:
|
|
|
6687
6862
|
nullable: true
|
|
6688
6863
|
example: >-
|
|
6689
6864
|
cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
|
|
6865
|
+
endpointId:
|
|
6866
|
+
type: string
|
|
6867
|
+
description: The unique ID of the endpoint.
|
|
6868
|
+
example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
6869
|
+
endpointStatusEnum:
|
|
6870
|
+
type: string
|
|
6871
|
+
enum:
|
|
6872
|
+
- CONNECTED
|
|
6873
|
+
- DISCONNECTED
|
|
6874
|
+
deviceStatusEnum:
|
|
6875
|
+
type: string
|
|
6876
|
+
enum:
|
|
6877
|
+
- CONNECTED
|
|
6878
|
+
- DISCONNECTED
|
|
6879
|
+
endpointTypeEnum:
|
|
6880
|
+
type: string
|
|
6881
|
+
enum:
|
|
6882
|
+
- WEBRTC
|
|
6883
|
+
endpointDirectionEnum:
|
|
6884
|
+
type: string
|
|
6885
|
+
enum:
|
|
6886
|
+
- INBOUND
|
|
6887
|
+
- OUTBOUND
|
|
6888
|
+
- BIDIRECTIONAL
|
|
6889
|
+
sipCredentials:
|
|
6890
|
+
type: object
|
|
6891
|
+
properties:
|
|
6892
|
+
username:
|
|
6893
|
+
type: string
|
|
6894
|
+
description: The username for the SIP connection.
|
|
6895
|
+
example: username
|
|
6896
|
+
password:
|
|
6897
|
+
type: string
|
|
6898
|
+
description: The password for the SIP connection.
|
|
6899
|
+
example: password
|
|
6900
|
+
sipConnectionMetadata:
|
|
6901
|
+
title: SIP Connection
|
|
6902
|
+
type: object
|
|
6903
|
+
properties:
|
|
6904
|
+
ipAddress:
|
|
6905
|
+
type: string
|
|
6906
|
+
format: ipv4
|
|
6907
|
+
description: The IP address of the SIP connection.
|
|
6908
|
+
example: 192.168.0.0
|
|
6909
|
+
port:
|
|
6910
|
+
type: integer
|
|
6911
|
+
description: The port of the SIP connection.
|
|
6912
|
+
example: 5060
|
|
6913
|
+
credentials:
|
|
6914
|
+
$ref: '#/components/schemas/sipCredentials'
|
|
6915
|
+
uuiHeader:
|
|
6916
|
+
type: string
|
|
6917
|
+
description: The User-to-User Information header for the SIP connection.
|
|
6918
|
+
example: my-uui-header
|
|
6919
|
+
webRtcConnectionMetadata:
|
|
6920
|
+
title: WebRTC Connection
|
|
6921
|
+
type: object
|
|
6922
|
+
endpointToken:
|
|
6923
|
+
type: string
|
|
6924
|
+
description: >-
|
|
6925
|
+
The json web token specific to the endpoint. Used to authenticate the
|
|
6926
|
+
client with the media gateway.
|
|
6927
|
+
example: xxxxx.yyyyy.zzzzz
|
|
6928
|
+
endpointTag:
|
|
6929
|
+
type: string
|
|
6930
|
+
description: A tag for the endpoint.
|
|
6931
|
+
example: my-tag
|
|
6932
|
+
maximum: 1024
|
|
6933
|
+
device:
|
|
6934
|
+
type: object
|
|
6935
|
+
properties:
|
|
6936
|
+
deviceId:
|
|
6937
|
+
type: string
|
|
6938
|
+
description: The unique ID of the device.
|
|
6939
|
+
example: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
6940
|
+
deviceName:
|
|
6941
|
+
type: string
|
|
6942
|
+
description: The name of the device.
|
|
6943
|
+
maximum: 1024
|
|
6944
|
+
example: David's iPhone
|
|
6945
|
+
status:
|
|
6946
|
+
$ref: '#/components/schemas/deviceStatusEnum'
|
|
6947
|
+
creationTimestamp:
|
|
6948
|
+
type: string
|
|
6949
|
+
format: date-time
|
|
6950
|
+
description: The time the device was created. In ISO-8601 format.
|
|
6951
|
+
example: '2021-01-01T00:00:00Z'
|
|
6952
|
+
required:
|
|
6953
|
+
- deviceId
|
|
6954
|
+
- status
|
|
6955
|
+
- creationTimestamp
|
|
6956
|
+
endpoints:
|
|
6957
|
+
type: object
|
|
6958
|
+
properties:
|
|
6959
|
+
endpointId:
|
|
6960
|
+
$ref: '#/components/schemas/endpointId'
|
|
6961
|
+
type:
|
|
6962
|
+
$ref: '#/components/schemas/endpointTypeEnum'
|
|
6963
|
+
status:
|
|
6964
|
+
$ref: '#/components/schemas/endpointStatusEnum'
|
|
6965
|
+
creationTimestamp:
|
|
6966
|
+
type: string
|
|
6967
|
+
format: date-time
|
|
6968
|
+
description: The time the endpoint was created. In ISO-8601 format.
|
|
6969
|
+
example: '2021-01-01T00:00:00Z'
|
|
6970
|
+
expirationTimestamp:
|
|
6971
|
+
type: string
|
|
6972
|
+
format: date-time
|
|
6973
|
+
description: >-
|
|
6974
|
+
The time the endpoint token will expire. In ISO-8601 format. Tokens
|
|
6975
|
+
last 24 hours.
|
|
6976
|
+
example: '2021-01-02T00:00:00Z'
|
|
6977
|
+
tag:
|
|
6978
|
+
$ref: '#/components/schemas/endpointTag'
|
|
6979
|
+
required:
|
|
6980
|
+
- endpointId
|
|
6981
|
+
- type
|
|
6982
|
+
- status
|
|
6983
|
+
- creationTimestamp
|
|
6984
|
+
- expirationTimestamp
|
|
6985
|
+
endpoint:
|
|
6986
|
+
type: object
|
|
6987
|
+
allOf:
|
|
6988
|
+
- $ref: '#/components/schemas/endpoints'
|
|
6989
|
+
- type: object
|
|
6990
|
+
properties:
|
|
6991
|
+
devices:
|
|
6992
|
+
type: array
|
|
6993
|
+
items:
|
|
6994
|
+
$ref: '#/components/schemas/device'
|
|
6995
|
+
createWebRtcConnectionRequest:
|
|
6996
|
+
allOf:
|
|
6997
|
+
- $ref: '#/components/schemas/createEndpointRequestBase'
|
|
6998
|
+
- type: object
|
|
6999
|
+
properties:
|
|
7000
|
+
connectionMetadata:
|
|
7001
|
+
$ref: '#/components/schemas/webRtcConnectionMetadata'
|
|
7002
|
+
createEndpointRequestBase:
|
|
7003
|
+
type: object
|
|
7004
|
+
properties:
|
|
7005
|
+
type:
|
|
7006
|
+
$ref: '#/components/schemas/endpointTypeEnum'
|
|
7007
|
+
direction:
|
|
7008
|
+
$ref: '#/components/schemas/endpointDirectionEnum'
|
|
7009
|
+
eventCallbackUrl:
|
|
7010
|
+
type: string
|
|
7011
|
+
format: uri
|
|
7012
|
+
description: The URL to send event callbacks to.
|
|
7013
|
+
example: https://myapp.com/callback
|
|
7014
|
+
eventFallbackUrl:
|
|
7015
|
+
type: string
|
|
7016
|
+
format: uri
|
|
7017
|
+
description: The URL to send event fallbacks to.
|
|
7018
|
+
example: https://fallback.myapp.com/callback
|
|
7019
|
+
tag:
|
|
7020
|
+
$ref: '#/components/schemas/endpointTag'
|
|
7021
|
+
required:
|
|
7022
|
+
- type
|
|
7023
|
+
- direction
|
|
7024
|
+
createEndpointRequest:
|
|
7025
|
+
oneOf:
|
|
7026
|
+
- $ref: '#/components/schemas/createWebRtcConnectionRequest'
|
|
7027
|
+
discriminator:
|
|
7028
|
+
propertyName: type
|
|
7029
|
+
mapping:
|
|
7030
|
+
WEBRTC: '#/components/schemas/createWebRtcConnectionRequest'
|
|
7031
|
+
createEndpointResponseData:
|
|
7032
|
+
allOf:
|
|
7033
|
+
- $ref: '#/components/schemas/endpoint'
|
|
7034
|
+
- type: object
|
|
7035
|
+
properties:
|
|
7036
|
+
token:
|
|
7037
|
+
$ref: '#/components/schemas/endpointToken'
|
|
7038
|
+
required:
|
|
7039
|
+
- token
|
|
7040
|
+
endpointEventTypeEnum:
|
|
7041
|
+
type: string
|
|
7042
|
+
enum:
|
|
7043
|
+
- DEVICE_CONNECTED
|
|
7044
|
+
- DEVICE_DISCONNECTED
|
|
7045
|
+
endpointEvent:
|
|
7046
|
+
description: An event that occurred on an endpoint.
|
|
7047
|
+
allOf:
|
|
7048
|
+
- $ref: '#/components/schemas/endpoints'
|
|
7049
|
+
- type: object
|
|
7050
|
+
properties:
|
|
7051
|
+
eventTime:
|
|
7052
|
+
type: string
|
|
7053
|
+
format: date-time
|
|
7054
|
+
description: The time the event occurred. In ISO-8601 format.
|
|
7055
|
+
example: '2021-01-01T00:00:00Z'
|
|
7056
|
+
eventType:
|
|
7057
|
+
$ref: '#/components/schemas/endpointEventTypeEnum'
|
|
7058
|
+
device:
|
|
7059
|
+
$ref: '#/components/schemas/device'
|
|
7060
|
+
required:
|
|
7061
|
+
- eventType
|
|
7062
|
+
- eventTime
|
|
7063
|
+
brtcLink:
|
|
7064
|
+
type: object
|
|
7065
|
+
properties:
|
|
7066
|
+
href:
|
|
7067
|
+
type: string
|
|
7068
|
+
description: The full URL of the link.
|
|
7069
|
+
example: >-
|
|
7070
|
+
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
7071
|
+
rel:
|
|
7072
|
+
type: string
|
|
7073
|
+
description: The relationship of the link to the current resource.
|
|
7074
|
+
example: self
|
|
7075
|
+
method:
|
|
7076
|
+
type: string
|
|
7077
|
+
description: The HTTP method to use when making the request.
|
|
7078
|
+
example: GET
|
|
7079
|
+
page:
|
|
7080
|
+
type: object
|
|
7081
|
+
properties:
|
|
7082
|
+
pageSize:
|
|
7083
|
+
type: integer
|
|
7084
|
+
description: The number of items per page.
|
|
7085
|
+
minimum: 0
|
|
7086
|
+
example: 10
|
|
7087
|
+
totalElements:
|
|
7088
|
+
type: integer
|
|
7089
|
+
description: The total number of items.
|
|
7090
|
+
minimum: 0
|
|
7091
|
+
example: 100
|
|
7092
|
+
totalPages:
|
|
7093
|
+
type: integer
|
|
7094
|
+
description: The total number of pages.
|
|
7095
|
+
minimum: 0
|
|
7096
|
+
example: 10
|
|
7097
|
+
pageNumber:
|
|
7098
|
+
type: integer
|
|
7099
|
+
description: The current page number.
|
|
7100
|
+
minimum: 0
|
|
7101
|
+
example: 0
|
|
7102
|
+
required:
|
|
7103
|
+
- pageSize
|
|
7104
|
+
brtcError:
|
|
7105
|
+
type: object
|
|
7106
|
+
properties:
|
|
7107
|
+
id:
|
|
7108
|
+
type: string
|
|
7109
|
+
format: uuid
|
|
7110
|
+
description: A unique identifier for the error.
|
|
7111
|
+
example: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
7112
|
+
type:
|
|
7113
|
+
type: string
|
|
7114
|
+
description: The type of error.
|
|
7115
|
+
example: resource.not_found
|
|
7116
|
+
description:
|
|
7117
|
+
type: string
|
|
7118
|
+
description: A description of the error.
|
|
7119
|
+
example: The requested resource was not found.
|
|
7120
|
+
code:
|
|
7121
|
+
type: string
|
|
7122
|
+
description: A code that uniquely identifies the error.
|
|
7123
|
+
example: '404'
|
|
7124
|
+
source:
|
|
7125
|
+
$ref: '#/components/schemas/brtcErrorSource'
|
|
7126
|
+
required:
|
|
7127
|
+
- type
|
|
7128
|
+
- description
|
|
7129
|
+
brtcErrorSource:
|
|
7130
|
+
type: object
|
|
7131
|
+
properties:
|
|
7132
|
+
parameter:
|
|
7133
|
+
type: string
|
|
7134
|
+
description: The URI parameter that caused the error.
|
|
7135
|
+
example: accountId
|
|
7136
|
+
field:
|
|
7137
|
+
type: string
|
|
7138
|
+
description: The request body field that caused the error.
|
|
7139
|
+
example: accountId
|
|
7140
|
+
header:
|
|
7141
|
+
type: string
|
|
7142
|
+
description: The header that caused the error.
|
|
7143
|
+
example: Authorization
|
|
7144
|
+
reference:
|
|
7145
|
+
type: string
|
|
7146
|
+
description: >-
|
|
7147
|
+
The resource ID or path to the resource (or non-existent resource)
|
|
7148
|
+
causing the error.
|
|
7149
|
+
example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
7150
|
+
listEndpointsResponse:
|
|
7151
|
+
type: object
|
|
7152
|
+
properties:
|
|
7153
|
+
links:
|
|
7154
|
+
type: array
|
|
7155
|
+
items:
|
|
7156
|
+
$ref: '#/components/schemas/brtcLink'
|
|
7157
|
+
page:
|
|
7158
|
+
$ref: '#/components/schemas/page'
|
|
7159
|
+
data:
|
|
7160
|
+
type: array
|
|
7161
|
+
items:
|
|
7162
|
+
$ref: '#/components/schemas/endpoints'
|
|
7163
|
+
errors:
|
|
7164
|
+
type: array
|
|
7165
|
+
items:
|
|
7166
|
+
$ref: '#/components/schemas/brtcError'
|
|
7167
|
+
required:
|
|
7168
|
+
- links
|
|
7169
|
+
- data
|
|
7170
|
+
- errors
|
|
7171
|
+
endpointResponse:
|
|
7172
|
+
type: object
|
|
7173
|
+
properties:
|
|
7174
|
+
links:
|
|
7175
|
+
type: array
|
|
7176
|
+
items:
|
|
7177
|
+
$ref: '#/components/schemas/brtcLink'
|
|
7178
|
+
data:
|
|
7179
|
+
$ref: '#/components/schemas/endpoint'
|
|
7180
|
+
errors:
|
|
7181
|
+
type: array
|
|
7182
|
+
items:
|
|
7183
|
+
$ref: '#/components/schemas/brtcError'
|
|
7184
|
+
required:
|
|
7185
|
+
- links
|
|
7186
|
+
- data
|
|
7187
|
+
- errors
|
|
7188
|
+
createEndpointResponse:
|
|
7189
|
+
type: object
|
|
7190
|
+
properties:
|
|
7191
|
+
links:
|
|
7192
|
+
type: array
|
|
7193
|
+
items:
|
|
7194
|
+
$ref: '#/components/schemas/brtcLink'
|
|
7195
|
+
data:
|
|
7196
|
+
$ref: '#/components/schemas/createEndpointResponseData'
|
|
7197
|
+
errors:
|
|
7198
|
+
type: array
|
|
7199
|
+
items:
|
|
7200
|
+
$ref: '#/components/schemas/brtcError'
|
|
7201
|
+
required:
|
|
7202
|
+
- links
|
|
7203
|
+
- data
|
|
7204
|
+
- errors
|
|
7205
|
+
brtcErrorResponse:
|
|
7206
|
+
type: object
|
|
7207
|
+
properties:
|
|
7208
|
+
links:
|
|
7209
|
+
type: array
|
|
7210
|
+
items:
|
|
7211
|
+
$ref: '#/components/schemas/brtcLink'
|
|
7212
|
+
data:
|
|
7213
|
+
type: object
|
|
7214
|
+
nullable: true
|
|
7215
|
+
additionalProperties: false
|
|
7216
|
+
errors:
|
|
7217
|
+
type: array
|
|
7218
|
+
items:
|
|
7219
|
+
$ref: '#/components/schemas/brtcError'
|
|
7220
|
+
required:
|
|
7221
|
+
- links
|
|
7222
|
+
- data
|
|
7223
|
+
- errors
|
|
6690
7224
|
responses:
|
|
6691
7225
|
createMessageResponse:
|
|
6692
7226
|
description: Accepted
|
|
@@ -7361,6 +7895,114 @@ components:
|
|
|
7361
7895
|
type: Service Unavailable
|
|
7362
7896
|
verifyPutResponse:
|
|
7363
7897
|
description: Accepted
|
|
7898
|
+
listEndpointsResponse:
|
|
7899
|
+
description: OK
|
|
7900
|
+
content:
|
|
7901
|
+
application/json:
|
|
7902
|
+
schema:
|
|
7903
|
+
$ref: '#/components/schemas/listEndpointsResponse'
|
|
7904
|
+
examples:
|
|
7905
|
+
listEndpointsResponseExample:
|
|
7906
|
+
$ref: '#/components/examples/listEndpointsResponseExample'
|
|
7907
|
+
createEndpointResponse:
|
|
7908
|
+
description: Created
|
|
7909
|
+
content:
|
|
7910
|
+
application/json:
|
|
7911
|
+
schema:
|
|
7912
|
+
$ref: '#/components/schemas/createEndpointResponse'
|
|
7913
|
+
examples:
|
|
7914
|
+
createEndpointResponseExample:
|
|
7915
|
+
$ref: '#/components/examples/createEndpointResponseExample'
|
|
7916
|
+
getEndpointResponse:
|
|
7917
|
+
description: OK
|
|
7918
|
+
content:
|
|
7919
|
+
application/json:
|
|
7920
|
+
schema:
|
|
7921
|
+
$ref: '#/components/schemas/endpointResponse'
|
|
7922
|
+
examples:
|
|
7923
|
+
getEndpointResponseExample:
|
|
7924
|
+
$ref: '#/components/examples/getEndpointResponseExample'
|
|
7925
|
+
badRequestErrorResponse:
|
|
7926
|
+
description: Bad Request
|
|
7927
|
+
content:
|
|
7928
|
+
application/json:
|
|
7929
|
+
schema:
|
|
7930
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7931
|
+
examples:
|
|
7932
|
+
badRequestErrorExample:
|
|
7933
|
+
$ref: '#/components/examples/badRequestErrorExample'
|
|
7934
|
+
unauthorizedErrorResponse:
|
|
7935
|
+
description: Unauthorized
|
|
7936
|
+
content:
|
|
7937
|
+
application/json:
|
|
7938
|
+
schema:
|
|
7939
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7940
|
+
examples:
|
|
7941
|
+
unauthorizedErrorExample:
|
|
7942
|
+
$ref: '#/components/examples/unauthorizedErrorExample'
|
|
7943
|
+
forbiddenErrorResponse:
|
|
7944
|
+
description: Forbidden
|
|
7945
|
+
content:
|
|
7946
|
+
application/json:
|
|
7947
|
+
schema:
|
|
7948
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7949
|
+
examples:
|
|
7950
|
+
forbiddenErrorExample:
|
|
7951
|
+
$ref: '#/components/examples/forbiddenErrorExample'
|
|
7952
|
+
notFoundErrorResponse:
|
|
7953
|
+
description: Not Found
|
|
7954
|
+
content:
|
|
7955
|
+
application/json:
|
|
7956
|
+
schema:
|
|
7957
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7958
|
+
examples:
|
|
7959
|
+
notFoundErrorExample:
|
|
7960
|
+
$ref: '#/components/examples/notFoundErrorExample'
|
|
7961
|
+
methodNotAllowedErrorResponse:
|
|
7962
|
+
description: Method Not Allowed
|
|
7963
|
+
content:
|
|
7964
|
+
application/json:
|
|
7965
|
+
schema:
|
|
7966
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7967
|
+
examples:
|
|
7968
|
+
methodNotAllowedErrorExample:
|
|
7969
|
+
$ref: '#/components/examples/methodNotAllowedErrorExample'
|
|
7970
|
+
unsupportedMediaTypeErrorResponse:
|
|
7971
|
+
description: Unsupported Media Type
|
|
7972
|
+
content:
|
|
7973
|
+
application/json:
|
|
7974
|
+
schema:
|
|
7975
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7976
|
+
examples:
|
|
7977
|
+
unsuppotedMediaTypeErrorExample:
|
|
7978
|
+
$ref: '#/components/examples/unsupportedMediaTypeErrorExample'
|
|
7979
|
+
tooManyRequestsErrorResponse:
|
|
7980
|
+
description: Too Many Requests
|
|
7981
|
+
headers:
|
|
7982
|
+
Retry-After:
|
|
7983
|
+
description: >-
|
|
7984
|
+
The number of seconds the client should wait before making another
|
|
7985
|
+
request.
|
|
7986
|
+
required: true
|
|
7987
|
+
schema:
|
|
7988
|
+
type: integer
|
|
7989
|
+
example: 900
|
|
7990
|
+
content:
|
|
7991
|
+
application/json:
|
|
7992
|
+
schema:
|
|
7993
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
7994
|
+
examples:
|
|
7995
|
+
tooManyRequestsErrorExample:
|
|
7996
|
+
$ref: '#/components/examples/tooManyRequestsErrorExample'
|
|
7997
|
+
serviceUnavailableErrorResponse:
|
|
7998
|
+
description: Service Unavailable
|
|
7999
|
+
content:
|
|
8000
|
+
application/json:
|
|
8001
|
+
schema:
|
|
8002
|
+
$ref: '#/components/schemas/brtcErrorResponse'
|
|
8003
|
+
examples:
|
|
8004
|
+
serviceUnavailableErrorExample:
|
|
8005
|
+
$ref: '#/components/examples/serviceUnavailableErrorExample'
|
|
7364
8006
|
parameters:
|
|
7365
8007
|
accountId:
|
|
7366
8008
|
in: path
|
|
@@ -7860,6 +8502,45 @@ components:
|
|
|
7860
8502
|
type: string
|
|
7861
8503
|
description: Webhook subscription ID
|
|
7862
8504
|
example: 7bt57JcsVYJrN9K1OcV1Nu
|
|
8505
|
+
endpointId:
|
|
8506
|
+
name: endpointId
|
|
8507
|
+
in: path
|
|
8508
|
+
required: true
|
|
8509
|
+
schema:
|
|
8510
|
+
type: string
|
|
8511
|
+
example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
8512
|
+
description: BRTC Endpoint ID.
|
|
8513
|
+
endpointType:
|
|
8514
|
+
name: type
|
|
8515
|
+
in: query
|
|
8516
|
+
schema:
|
|
8517
|
+
$ref: '#/components/schemas/endpointTypeEnum'
|
|
8518
|
+
description: The type of endpoint.
|
|
8519
|
+
endpointStatus:
|
|
8520
|
+
name: status
|
|
8521
|
+
in: query
|
|
8522
|
+
schema:
|
|
8523
|
+
$ref: '#/components/schemas/endpointStatusEnum'
|
|
8524
|
+
description: The status of the endpoint.
|
|
8525
|
+
afterCursor:
|
|
8526
|
+
name: afterCursor
|
|
8527
|
+
in: query
|
|
8528
|
+
schema:
|
|
8529
|
+
type: string
|
|
8530
|
+
example: TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
|
|
8531
|
+
description: >-
|
|
8532
|
+
The cursor to use for pagination. This is the value of the `next` link
|
|
8533
|
+
in the previous response.
|
|
8534
|
+
limit1:
|
|
8535
|
+
name: limit
|
|
8536
|
+
in: query
|
|
8537
|
+
schema:
|
|
8538
|
+
type: integer
|
|
8539
|
+
minimum: 1
|
|
8540
|
+
maximum: 1000
|
|
8541
|
+
default: 100
|
|
8542
|
+
example: 2
|
|
8543
|
+
description: The maximum number of endpoints to return in the response.
|
|
7863
8544
|
examples:
|
|
7864
8545
|
smsMessageReceivedCallbackExample:
|
|
7865
8546
|
summary: An example of a sms message-received callback body.
|
|
@@ -8342,6 +9023,205 @@ components:
|
|
|
8342
9023
|
Unexpected error. Please contact Bandwidth Support if your
|
|
8343
9024
|
requests are receiving this status code for an extended period of
|
|
8344
9025
|
time.
|
|
9026
|
+
listEndpointsResponseExample:
|
|
9027
|
+
summary: List Endpoints Paginated Response
|
|
9028
|
+
value:
|
|
9029
|
+
links:
|
|
9030
|
+
- href: >-
|
|
9031
|
+
https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2
|
|
9032
|
+
rel: self
|
|
9033
|
+
method: GET
|
|
9034
|
+
- href: >-
|
|
9035
|
+
https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
|
|
9036
|
+
rel: next
|
|
9037
|
+
method: GET
|
|
9038
|
+
page:
|
|
9039
|
+
pageSize: 2
|
|
9040
|
+
totalElements: 10
|
|
9041
|
+
totalPages: 5
|
|
9042
|
+
pageNumber: 0
|
|
9043
|
+
data:
|
|
9044
|
+
- endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9045
|
+
type: WEBRTC
|
|
9046
|
+
status: CONNECTED
|
|
9047
|
+
creationTimestamp: '2021-01-01T00:00:00Z'
|
|
9048
|
+
expirationTimestamp: '2021-01-02T00:00:00Z'
|
|
9049
|
+
tag: my-tag
|
|
9050
|
+
- endpointId: e-2cb0-4a07-b215-b22865662d85-15ac29a2-1331029c
|
|
9051
|
+
type: WEBRTC
|
|
9052
|
+
status: CONNECTED
|
|
9053
|
+
creationTimestamp: '2021-01-01T00:00:00Z'
|
|
9054
|
+
expirationTimestamp: '2021-01-02T00:00:00Z'
|
|
9055
|
+
tag: my-tag
|
|
9056
|
+
errors: []
|
|
9057
|
+
createEndpointResponseExample:
|
|
9058
|
+
summary: Create Endpoint Response
|
|
9059
|
+
value:
|
|
9060
|
+
links:
|
|
9061
|
+
- href: >-
|
|
9062
|
+
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9063
|
+
rel: endpoint
|
|
9064
|
+
method: GET
|
|
9065
|
+
data:
|
|
9066
|
+
endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9067
|
+
token: xxxxx.yyyyy.zzzzz
|
|
9068
|
+
type: WEBRTC
|
|
9069
|
+
status: CONNECTED
|
|
9070
|
+
creationTimestamp: '2021-01-01T00:00:00Z'
|
|
9071
|
+
expirationTimestamp: '2021-01-02T00:00:00Z'
|
|
9072
|
+
devices: []
|
|
9073
|
+
tag: my-tag
|
|
9074
|
+
errors: []
|
|
9075
|
+
getEndpointResponseExample:
|
|
9076
|
+
summary: Get Endpoint Response
|
|
9077
|
+
value:
|
|
9078
|
+
links:
|
|
9079
|
+
- href: >-
|
|
9080
|
+
https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9081
|
+
rel: self
|
|
9082
|
+
method: GET
|
|
9083
|
+
data:
|
|
9084
|
+
endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9085
|
+
type: WEBRTC
|
|
9086
|
+
status: CONNECTED
|
|
9087
|
+
creationTimestamp: '2021-01-01T00:00:00Z'
|
|
9088
|
+
expirationTimestamp: '2021-01-02T00:00:00Z'
|
|
9089
|
+
devices: []
|
|
9090
|
+
tag: my-tag
|
|
9091
|
+
errors: []
|
|
9092
|
+
createSipEndpointRequestExample:
|
|
9093
|
+
summary: SIP Endpoint Example
|
|
9094
|
+
value:
|
|
9095
|
+
type: SIP
|
|
9096
|
+
connectionMetadata:
|
|
9097
|
+
ipAddress: 0.0.0.0
|
|
9098
|
+
port: 3000
|
|
9099
|
+
credentials:
|
|
9100
|
+
username: username
|
|
9101
|
+
password: '********'
|
|
9102
|
+
uuiHeader: 123456;encoding=jwt
|
|
9103
|
+
direction: INBOUND
|
|
9104
|
+
eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
|
|
9105
|
+
eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
|
|
9106
|
+
tag: '{"myTag": "myTagValue"}'
|
|
9107
|
+
createWeRtcEndpointExample:
|
|
9108
|
+
summary: WebRTC Endpoint Example
|
|
9109
|
+
value:
|
|
9110
|
+
type: WEBRTC
|
|
9111
|
+
direction: BIDIRECTIONAL
|
|
9112
|
+
eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
|
|
9113
|
+
eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
|
|
9114
|
+
tag: '{"myTag": "myTagValue"}'
|
|
9115
|
+
updateEndpointBxmlRequestExample:
|
|
9116
|
+
summary: Update Endpoint BXML Request Example
|
|
9117
|
+
value: <Bxml><StartRecording /></Bxml>
|
|
9118
|
+
endpointDisconnectedEventExample:
|
|
9119
|
+
summary: Endpoint Disconnected Event
|
|
9120
|
+
value:
|
|
9121
|
+
endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9122
|
+
type: WEBRTC
|
|
9123
|
+
status: DISCONNECTED
|
|
9124
|
+
creationTimestamp: '2021-01-01T00:00:00Z'
|
|
9125
|
+
expirationTimestamp: '2021-01-02T00:00:00Z'
|
|
9126
|
+
eventTime: '2021-01-01T00:00:00Z'
|
|
9127
|
+
eventType: DEVICE_DISCONNECTED
|
|
9128
|
+
tag: my-tag
|
|
9129
|
+
badRequestErrorExample:
|
|
9130
|
+
summary: Bad Request Error Example
|
|
9131
|
+
value:
|
|
9132
|
+
links: []
|
|
9133
|
+
data: null
|
|
9134
|
+
errors:
|
|
9135
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9136
|
+
type: invalid_parameter
|
|
9137
|
+
description: accountId must not contain any characters other than numbers.
|
|
9138
|
+
code: '400'
|
|
9139
|
+
source:
|
|
9140
|
+
parameter: accountId
|
|
9141
|
+
unauthorizedErrorExample:
|
|
9142
|
+
summary: Unauthorized Error Example
|
|
9143
|
+
value:
|
|
9144
|
+
links: []
|
|
9145
|
+
data: null
|
|
9146
|
+
errors:
|
|
9147
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9148
|
+
type: unauthorized
|
|
9149
|
+
description: >-
|
|
9150
|
+
The provided credentials are not authorized to access this
|
|
9151
|
+
resource.
|
|
9152
|
+
code: '401'
|
|
9153
|
+
source:
|
|
9154
|
+
header: Authorization
|
|
9155
|
+
forbiddenErrorExample:
|
|
9156
|
+
summary: Forbidden Error Example
|
|
9157
|
+
value:
|
|
9158
|
+
links: []
|
|
9159
|
+
data: null
|
|
9160
|
+
errors:
|
|
9161
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9162
|
+
type: forbidden
|
|
9163
|
+
description: >-
|
|
9164
|
+
The provided credentials are not authorized to access this
|
|
9165
|
+
resource.
|
|
9166
|
+
code: '403'
|
|
9167
|
+
source:
|
|
9168
|
+
header: Authorization
|
|
9169
|
+
notFoundErrorExample:
|
|
9170
|
+
summary: Not Found Error Example
|
|
9171
|
+
value:
|
|
9172
|
+
links: []
|
|
9173
|
+
data: null
|
|
9174
|
+
errors:
|
|
9175
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9176
|
+
type: resource_not_found
|
|
9177
|
+
description: The requested resource was not found.
|
|
9178
|
+
code: '404'
|
|
9179
|
+
source:
|
|
9180
|
+
reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
|
|
9181
|
+
methodNotAllowedErrorExample:
|
|
9182
|
+
summary: Method Not Allowed Error Example
|
|
9183
|
+
value:
|
|
9184
|
+
links: []
|
|
9185
|
+
data: null
|
|
9186
|
+
errors:
|
|
9187
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9188
|
+
type: method_not_allowed
|
|
9189
|
+
description: The requested method is not allowed on this resource.
|
|
9190
|
+
code: '405'
|
|
9191
|
+
source:
|
|
9192
|
+
parameter: accountId
|
|
9193
|
+
unsupportedMediaTypeErrorExample:
|
|
9194
|
+
summary: Unsupported Media Type Error Example
|
|
9195
|
+
value:
|
|
9196
|
+
links: []
|
|
9197
|
+
data: null
|
|
9198
|
+
errors:
|
|
9199
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9200
|
+
type: unsupported_media_type
|
|
9201
|
+
description: The provided media type is not supported.
|
|
9202
|
+
code: '415'
|
|
9203
|
+
source:
|
|
9204
|
+
header: Content-Type
|
|
9205
|
+
tooManyRequestsErrorExample:
|
|
9206
|
+
summary: Too Many Requests Error Example
|
|
9207
|
+
value:
|
|
9208
|
+
links: []
|
|
9209
|
+
data: null
|
|
9210
|
+
errors:
|
|
9211
|
+
- type: too_many_endpoints
|
|
9212
|
+
description: >-
|
|
9213
|
+
Too many endpoints. Please delete an existing endpoint or wait 24
|
|
9214
|
+
hours for an endpoint to be removed.
|
|
9215
|
+
serviceUnavailableErrorExample:
|
|
9216
|
+
summary: Service Unavailable Error Example
|
|
9217
|
+
value:
|
|
9218
|
+
links: []
|
|
9219
|
+
data: null
|
|
9220
|
+
errors:
|
|
9221
|
+
- id: 59512d87-7a92-4040-8e4a-78fb772019b9
|
|
9222
|
+
type: service_unavailable
|
|
9223
|
+
description: The service is currently unavailable.
|
|
9224
|
+
code: '500'
|
|
8345
9225
|
requestBodies:
|
|
8346
9226
|
createMessageRequest:
|
|
8347
9227
|
content:
|
|
@@ -8697,6 +9577,30 @@ components:
|
|
|
8697
9577
|
application/json:
|
|
8698
9578
|
schema:
|
|
8699
9579
|
$ref: '#/components/schemas/webhookSubscriptionRequestSchema'
|
|
9580
|
+
createEndpointRequest:
|
|
9581
|
+
required: true
|
|
9582
|
+
content:
|
|
9583
|
+
application/json:
|
|
9584
|
+
schema:
|
|
9585
|
+
$ref: '#/components/schemas/createEndpointRequest'
|
|
9586
|
+
examples:
|
|
9587
|
+
createWebRtcEndpointRequestExample:
|
|
9588
|
+
$ref: '#/components/examples/createWeRtcEndpointExample'
|
|
9589
|
+
updateEndpointBxmlRequest:
|
|
9590
|
+
required: true
|
|
9591
|
+
content:
|
|
9592
|
+
application/xml:
|
|
9593
|
+
schema:
|
|
9594
|
+
type: string
|
|
9595
|
+
description: >-
|
|
9596
|
+
The BXML document to update the endpoint with. This BXML document
|
|
9597
|
+
will be executed against the endpoint when it is updated.
|
|
9598
|
+
|
|
9599
|
+
For more information, please refer to our [BXML
|
|
9600
|
+
documentation](/docs/voice/bxml/).
|
|
9601
|
+
examples:
|
|
9602
|
+
updateEndpointBxmlRequestExample:
|
|
9603
|
+
$ref: '#/components/examples/updateEndpointBxmlRequestExample'
|
|
8700
9604
|
securitySchemes:
|
|
8701
9605
|
Basic:
|
|
8702
9606
|
type: http
|
|
@@ -8723,12 +9627,12 @@ components:
|
|
|
8723
9627
|
required: true
|
|
8724
9628
|
description: >-
|
|
8725
9629
|
<p>This Inbound Message Webhook is an envelope containing either a
|
|
8726
|
-
received (MO) message to your
|
|
9630
|
+
received (MO) message to your
|
|
8727
9631
|
|
|
8728
9632
|
message-enabled Bandwidth telephone number or a multichannel
|
|
8729
|
-
client's response to a suggestion response
|
|
9633
|
+
client's response to a suggestion response
|
|
8730
9634
|
|
|
8731
|
-
or location request.
|
|
9635
|
+
or location request.
|
|
8732
9636
|
|
|
8733
9637
|
<p>The payload type will be one of <code>message-received</code>,
|
|
8734
9638
|
<code>suggestion-response</code>, or
|
|
@@ -8830,3 +9734,17 @@ components:
|
|
|
8830
9734
|
$ref: '#/components/responses/tfvServerErrorResponse'
|
|
8831
9735
|
'503':
|
|
8832
9736
|
$ref: '#/components/responses/tfvServiceUnavailableResponse'
|
|
9737
|
+
endpointEvent:
|
|
9738
|
+
'{request.body#/eventCallbackUrl}':
|
|
9739
|
+
post:
|
|
9740
|
+
requestBody:
|
|
9741
|
+
content:
|
|
9742
|
+
application/json:
|
|
9743
|
+
schema:
|
|
9744
|
+
$ref: '#/components/schemas/endpointEvent'
|
|
9745
|
+
examples:
|
|
9746
|
+
endpointDisconnectedEventExample:
|
|
9747
|
+
$ref: '#/components/examples/endpointDisconnectedEventExample'
|
|
9748
|
+
responses:
|
|
9749
|
+
'204':
|
|
9750
|
+
description: Event was successfully received.
|