This Inbound Message Webhook is an envelope containing\
- \ either a received (MO) message to your \nmessage-enabled Bandwidth\
- \ telephone number or a multichannel client's response to a suggestion\
- \ response \nor location request. \n
The payload type will be one\
- \ of message-received, suggestion-response,\
- \ or location-request-response.\n
Note that suggestion-response\
- \ and location-request-response callback types are pertinent\
- \ only for RBM messages sent from the /messages/multiChannel\
- \ endpoint.\n
This Inbound Message Webhook is an envelope containing either a received (MO) message to your
+ message-enabled Bandwidth telephone number or a multichannel client's response to a suggestion response
+ or location request.
+
The payload type will be one of message-received, suggestion-response, or location-request-response.
+
Note that suggestion-response and location-request-response callback types are pertinent only for RBM messages sent from the /messages/multiChannel endpoint.
+
required: true
responses:
"200":
@@ -5990,6 +6577,20 @@ components:
$ref: "#/components/schemas/tfvError"
description: Service Unavailable
summary: TFV status updates sent to customer's webhook URL.
+ endpointEvent:
+ '{request.body#/eventCallbackUrl}':
+ post:
+ requestBody:
+ content:
+ application/json:
+ examples:
+ endpointDisconnectedEventExample:
+ $ref: "#/components/examples/endpointDisconnectedEventExample"
+ schema:
+ $ref: "#/components/schemas/endpointEvent"
+ responses:
+ "204":
+ description: Event was successfully received.
examples:
smsMessageReceivedCallbackExample:
summary: An example of a sms message-received callback body.
@@ -6408,6 +7009,200 @@ components:
type: unexpected-error
description: Unexpected error. Please contact Bandwidth Support if your
requests are receiving this status code for an extended period of time.
+ listEndpointsResponseExample:
+ summary: List Endpoints Paginated Response
+ value:
+ links:
+ - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2
+ rel: self
+ method: GET
+ - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
+ rel: next
+ method: GET
+ page:
+ pageSize: 2
+ totalElements: 10
+ totalPages: 5
+ pageNumber: 0
+ data:
+ - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: WEBRTC
+ status: CONNECTED
+ 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
+ tag: my-tag
+ errors: []
+ createEndpointResponseExample:
+ summary: Create Endpoint Response
+ value:
+ links:
+ - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ rel: endpoint
+ method: GET
+ data:
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ token: xxxxx.yyyyy.zzzzz
+ type: WEBRTC
+ status: CONNECTED
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ devices: []
+ tag: my-tag
+ errors: []
+ getEndpointResponseExample:
+ summary: Get Endpoint Response
+ value:
+ links:
+ - href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ rel: self
+ method: GET
+ data:
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: WEBRTC
+ status: CONNECTED
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ devices: []
+ tag: my-tag
+ errors: []
+ createSipEndpointRequestExample:
+ summary: SIP Endpoint Example
+ value:
+ type: SIP
+ connectionMetadata:
+ ipAddress: 0.0.0.0
+ port: 3000
+ credentials:
+ username: username
+ password: '********'
+ uuiHeader: 123456;encoding=jwt
+ direction: INBOUND
+ eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
+ eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
+ tag: "{\"myTag\": \"myTagValue\"}"
+ createWeRtcEndpointExample:
+ summary: WebRTC Endpoint Example
+ value:
+ type: WEBRTC
+ direction: BIDIRECTIONAL
+ eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
+ eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
+ tag: "{\"myTag\": \"myTagValue\"}"
+ updateEndpointBxmlRequestExample:
+ summary: Update Endpoint BXML Request Example
+ value:
+ endpointDisconnectedEventExample:
+ summary: Endpoint Disconnected Event
+ value:
+ 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
+ eventType: DEVICE_DISCONNECTED
+ tag: my-tag
+ badRequestErrorExample:
+ summary: Bad Request Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: invalid_parameter
+ description: accountId must not contain any characters other than numbers.
+ code: "400"
+ source:
+ parameter: accountId
+ unauthorizedErrorExample:
+ summary: Unauthorized Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: unauthorized
+ description: The provided credentials are not authorized to access this
+ resource.
+ code: "401"
+ source:
+ header: Authorization
+ forbiddenErrorExample:
+ summary: Forbidden Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: forbidden
+ description: The provided credentials are not authorized to access this
+ resource.
+ code: "403"
+ source:
+ header: Authorization
+ notFoundErrorExample:
+ summary: Not Found Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: resource_not_found
+ description: The requested resource was not found.
+ code: "404"
+ source:
+ reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ methodNotAllowedErrorExample:
+ summary: Method Not Allowed Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: method_not_allowed
+ description: The requested method is not allowed on this resource.
+ code: "405"
+ source:
+ parameter: accountId
+ unsupportedMediaTypeErrorExample:
+ summary: Unsupported Media Type Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: unsupported_media_type
+ description: The provided media type is not supported.
+ code: "415"
+ source:
+ header: Content-Type
+ tooManyRequestsErrorExample:
+ summary: Too Many Requests Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: too_many_requests
+ description: The client has sent too many requests in a given amount of
+ time.
+ code: "429"
+ serviceUnavailableErrorExample:
+ summary: Service Unavailable Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: service_unavailable
+ description: The service is currently unavailable.
+ code: "500"
parameters:
accountId:
description: Your Bandwidth Account ID.
@@ -6989,6 +7784,58 @@ components:
schema:
type: string
style: simple
+ endpointId:
+ description: BRTC Endpoint ID.
+ explode: false
+ in: path
+ name: endpointId
+ required: true
+ schema:
+ example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: string
+ style: simple
+ endpointType:
+ description: The type of endpoint.
+ explode: true
+ in: query
+ name: type
+ required: false
+ schema:
+ $ref: "#/components/schemas/endpointTypeEnum"
+ style: form
+ endpointStatus:
+ description: The status of the endpoint.
+ explode: true
+ in: query
+ name: status
+ required: false
+ schema:
+ $ref: "#/components/schemas/endpointStatusEnum"
+ style: form
+ afterCursor:
+ description: The cursor to use for pagination. This is the value of the `next`
+ link in the previous response.
+ explode: true
+ in: query
+ name: afterCursor
+ required: false
+ schema:
+ example: TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
+ type: string
+ style: form
+ limit1:
+ description: The maximum number of endpoints to return in the response.
+ explode: true
+ in: query
+ name: limit
+ required: false
+ schema:
+ default: 100
+ example: 2
+ maximum: 1000
+ minimum: 1
+ type: integer
+ style: form
requestBodies:
createMessageRequest:
content:
@@ -7342,6 +8189,27 @@ components:
description: Information about a webhook that Bandwidth should send upon the
completion of event customer is trying to subscribe to.
required: true
+ createEndpointRequest:
+ content:
+ application/json:
+ examples:
+ createWebRtcEndpointRequestExample:
+ $ref: "#/components/examples/createWeRtcEndpointExample"
+ schema:
+ $ref: "#/components/schemas/createEndpointRequest"
+ required: true
+ updateEndpointBxmlRequest:
+ content:
+ application/xml:
+ examples:
+ updateEndpointBxmlRequestExample:
+ $ref: "#/components/examples/updateEndpointBxmlRequestExample"
+ schema:
+ description: |-
+ The BXML document to update the endpoint with. This BXML document will be executed against the endpoint when it is updated.
+ For more information, please refer to our [BXML documentation](/docs/voice/bxml/).
+ type: string
+ required: true
responses:
createMessageResponse:
content:
@@ -7980,37 +8848,136 @@ components:
description: Method is not allowed.
type: Method Not Allowed
schema:
- $ref: "#/components/schemas/tfvError"
+ $ref: "#/components/schemas/tfvError"
+ description: Method Not Allowed
+ tfvTooManyRequestsResponse:
+ content:
+ application/json:
+ example:
+ description: Throttling error. Too many requests.
+ type: Too Many Requests
+ schema:
+ $ref: "#/components/schemas/tfvError"
+ description: Too Many Requests
+ tfvServerErrorResponse:
+ content:
+ application/json:
+ example:
+ description: Internal Server Error.
+ type: Internal Server Error
+ schema:
+ $ref: "#/components/schemas/tfvError"
+ description: Internal Server Error
+ tfvServiceUnavailableResponse:
+ content:
+ application/json:
+ example:
+ description: Service Unavailable Error.
+ type: Service Unavailable
+ schema:
+ $ref: "#/components/schemas/tfvError"
+ description: Service Unavailable
+ verifyPutResponse:
+ description: Accepted
+ listEndpointsResponse:
+ content:
+ application/json:
+ examples:
+ listEndpointsResponseExample:
+ $ref: "#/components/examples/listEndpointsResponseExample"
+ schema:
+ $ref: "#/components/schemas/listEndpointsResponse"
+ description: OK
+ createEndpointResponse:
+ content:
+ application/json:
+ examples:
+ createEndpointResponseExample:
+ $ref: "#/components/examples/createEndpointResponseExample"
+ schema:
+ $ref: "#/components/schemas/createEndpointResponse"
+ description: Created
+ getEndpointResponse:
+ content:
+ application/json:
+ examples:
+ getEndpointResponseExample:
+ $ref: "#/components/examples/getEndpointResponseExample"
+ schema:
+ $ref: "#/components/schemas/endpointResponse"
+ description: OK
+ badRequestErrorResponse:
+ content:
+ application/json:
+ examples:
+ badRequestErrorExample:
+ $ref: "#/components/examples/badRequestErrorExample"
+ schema:
+ $ref: "#/components/schemas/errorResponse"
+ description: Bad Request
+ unauthorizedErrorResponse:
+ content:
+ application/json:
+ examples:
+ unauthorizedErrorExample:
+ $ref: "#/components/examples/unauthorizedErrorExample"
+ schema:
+ $ref: "#/components/schemas/errorResponse"
+ description: Unauthorized
+ forbiddenErrorResponse:
+ content:
+ application/json:
+ examples:
+ forbiddenErrorExample:
+ $ref: "#/components/examples/forbiddenErrorExample"
+ schema:
+ $ref: "#/components/schemas/errorResponse"
+ description: Forbidden
+ notFoundErrorResponse:
+ content:
+ application/json:
+ examples:
+ notFoundErrorExample:
+ $ref: "#/components/examples/notFoundErrorExample"
+ schema:
+ $ref: "#/components/schemas/errorResponse"
+ description: Not Found
+ methodNotAllowedErrorResponse:
+ content:
+ application/json:
+ examples:
+ methodNotAllowedErrorExample:
+ $ref: "#/components/examples/methodNotAllowedErrorExample"
+ schema:
+ $ref: "#/components/schemas/errorResponse"
description: Method Not Allowed
- tfvTooManyRequestsResponse:
+ unsupportedMediaTypeErrorResponse:
content:
application/json:
- example:
- description: Throttling error. Too many requests.
- type: Too Many Requests
+ examples:
+ unsuppotedMediaTypeErrorExample:
+ $ref: "#/components/examples/unsupportedMediaTypeErrorExample"
schema:
- $ref: "#/components/schemas/tfvError"
- description: Too Many Requests
- tfvServerErrorResponse:
+ $ref: "#/components/schemas/errorResponse"
+ description: Unsupported Media Type
+ tooManyRequestsErrorResponse:
content:
application/json:
- example:
- description: Internal Server Error.
- type: Internal Server Error
+ examples:
+ tooManyRequestsErrorExample:
+ $ref: "#/components/examples/tooManyRequestsErrorExample"
schema:
- $ref: "#/components/schemas/tfvError"
- description: Internal Server Error
- tfvServiceUnavailableResponse:
+ $ref: "#/components/schemas/errorResponse"
+ description: Too Many Requests
+ serviceUnavailableErrorResponse:
content:
application/json:
- example:
- description: Service Unavailable Error.
- type: Service Unavailable
+ examples:
+ serviceUnavailableErrorExample:
+ $ref: "#/components/examples/serviceUnavailableErrorExample"
schema:
- $ref: "#/components/schemas/tfvError"
+ $ref: "#/components/schemas/errorResponse"
description: Service Unavailable
- verifyPutResponse:
- description: Accepted
schemas:
applicationId:
description: The ID of the Application your from number or senderId is associated
@@ -8394,9 +9361,10 @@ components:
format: date-time
type: string
carrierName:
- description: "The name of the Authorized Message Provider (AMP) that handled\
- \ this message. \nIn the US, this is the carrier that the message was sent\
- \ to.\nThis field is present only when this account feature has been enabled."
+ description: |-
+ The name of the Authorized Message Provider (AMP) that handled this message.
+ In the US, this is the carrier that the message was sent to.
+ This field is present only when this account feature has been enabled.
example: AT&T
type: string
message:
@@ -8503,13 +9471,9 @@ components:
type: array
uniqueItems: true
from:
- description: "Either an alphanumeric sender ID or the sender's Bandwidth\
- \ phone number in E.164 format, which must be hosted within Bandwidth\
- \ and linked to the account that is generating the message. \nAlphanumeric\
- \ Sender IDs can contain up to 11 characters, upper-case 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."
+ description: |-
+ Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message.
+ Alphanumeric Sender IDs can contain up to 11 characters, upper-case 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"
type: string
text:
@@ -8739,6 +9703,9 @@ components:
type: array
type: object
link:
+ example:
+ rel: rel
+ href: href
properties:
rel:
type: string
@@ -9038,20 +10005,21 @@ components:
example: REPLY
type: string
rbmOpenUrlEnum:
- description: "Specifies how the URL should be opened on a mobile device.\n-\
- \ `BROWSER` Opens the URL in the device's default browser. If application\
- \ is not set or the device doesn’t support WebView, this option is used by\
- \ default. \n- `WEBVIEW` Opens the URL in an in-app WebView."
+ description: |-
+ Specifies how the URL should be opened on a mobile device.
+ - `BROWSER` Opens the URL in the device's default browser. If application is not set or the device doesn’t support WebView, this option is used by default.
+ - `WEBVIEW` Opens the URL in an in-app WebView.
enum:
- BROWSER
- WEBVIEW
example: WEBVIEW
type: string
rbmWebViewEnum:
- description: "Defines the layout of the WebView on a mobile device. It must\
- \ be defined when application is set to `WEBVIEW`\n- `FULL` WebView takes\
- \ the full screen. \n- `HALF` WebView takes half of the screen.\n- `TALL`\
- \ WebView takes three-quarters of the screen."
+ description: |-
+ Defines the layout of the WebView on a mobile device. It must be defined when application is set to `WEBVIEW`
+ - `FULL` WebView takes the full screen.
+ - `HALF` WebView takes half of the screen.
+ - `TALL` WebView takes three-quarters of the screen.
enum:
- FULL
- HALF
@@ -9614,10 +10582,10 @@ components:
example: 4405
type: integer
carrierName:
- description: "The name of the Authorized Message Provider (AMP) that handled\
- \ this message. \nIn the US, this is the carrier that the message was\
- \ sent to.\nThis field is present only when this account feature has been\
- \ enabled."
+ description: |-
+ The name of the Authorized Message Provider (AMP) that handled this message.
+ In the US, this is the carrier that the message was sent to.
+ This field is present only when this account feature has been enabled.
example: AT&T
type: string
required:
@@ -9637,9 +10605,9 @@ components:
type:
$ref: "#/components/schemas/inboundCallbackTypeEnum"
to:
- description: "The destination phone number the message was sent to. \nFor\
- \ inbound callbacks, this is the Bandwidth number or alphanumeric identifier\
- \ that received the message.\n"
+ description: |
+ The destination phone number the message was sent to.
+ For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message.
example: "+15552223333"
type: string
description:
@@ -9649,10 +10617,10 @@ components:
message:
$ref: "#/components/schemas/inboundCallbackMessage"
carrierName:
- description: "The name of the Authorized Message Provider (AMP) that handled\
- \ this message. \nIn the US, this is the carrier that the message was\
- \ sent to.\nThis field is present only when this account feature has been\
- \ enabled."
+ description: |-
+ The name of the Authorized Message Provider (AMP) that handled this message.
+ In the US, this is the carrier that the message was sent to.
+ This field is present only when this account feature has been enabled.
example: AT&T
type: string
required:
@@ -9677,13 +10645,11 @@ components:
example: message-delivered
type: string
inboundCallbackTypeEnum:
- description: "The possible inbound callback types originating from MO messages\
- \ or multichannel message client responses:\n- `message-received` indicates\
- \ an MO message from a Bandwidth user's client to a Bandwidth number.\n- `request-location-response`\
- \ indicates a response to a location request sent by the Bandwidth user's\
- \ client after receiving an RBM message. \n- `suggestion-response` indicates\
- \ a response to a suggestion sent by the Bandwidth user's client after receiving\
- \ an RBM message."
+ description: |-
+ The possible inbound callback types originating from MO messages or multichannel message client responses:
+ - `message-received` indicates an MO message from a Bandwidth user's client to a Bandwidth number.
+ - `request-location-response` indicates a response to a location request sent by the Bandwidth user's client after receiving an RBM message.
+ - `suggestion-response` indicates a response to a suggestion sent by the Bandwidth user's client after receiving an RBM message.
enum:
- message-received
- request-location-response
@@ -9901,10 +10867,10 @@ components:
nullable: true
type: boolean
displayName:
- description: "The caller display name to use when the call is created. \n\
- May not exceed 256 characters nor contain control characters such as new\
- \ lines.\nIf `privacy` is true, only the following values are valid: `Restricted`,\
- \ `Anonymous`, `Private`, or `Unavailable`."
+ description: |-
+ The caller display name to use when the call is created.
+ May not exceed 256 characters nor contain control characters such as new lines.
+ If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`.
example: John Doe
maxLength: 256
nullable: true
@@ -10869,9 +11835,9 @@ components:
nullable: true
type: number
machineSpeechEndThreshold:
- description: "When an answering machine is detected, the amount of silence\
- \ (in seconds) before assuming the message has finished playing. \nIf\
- \ not provided it will default to the speechEndThreshold value."
+ description: |-
+ When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing.
+ If not provided it will default to the speechEndThreshold value.
example: 5
format: double
nullable: true
@@ -13641,18 +14607,18 @@ components:
latestMessageDeliveryStatus:
$ref: "#/components/schemas/latestMessageDeliveryStatusEnum"
initialMessageDeliveryStatusDate:
- description: "[DNI-Only](#section/DNI-Only). The date the phone number entered\
- \ the status described in `latestMessageDeliveryStatus`. \nThink of this\
- \ as the \"start time\" for that status.\nValue resets every time the\
- \ `latestMessageDeliveryStatus` changes."
+ description: |-
+ [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`.
+ Think of this as the "start time" for that status.
+ Value resets every time the `latestMessageDeliveryStatus` changes.
example: 2025-06-20
format: date
type: string
latestMessageDeliveryStatusDate:
- description: "[DNI-Only](#section/DNI-Only). The date bandwidth last received\
- \ delivery status information for this phone number. \nUse this field\
- \ to understand how up-to-date the `latestMessageDeliveryStatus` is.\n\
- Value resets every time the `latestMessageDeliveryStatus` changes."
+ description: |-
+ [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.
+ Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is.
+ Value resets every time the `latestMessageDeliveryStatus` changes.
example: 2025-06-21
format: date
type: string
@@ -14911,6 +15877,474 @@ components:
minLength: 0
nullable: true
type: string
+ endpointId:
+ description: The unique ID of the endpoint.
+ example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: string
+ endpointStatusEnum:
+ enum:
+ - CONNECTED
+ - DISCONNECTED
+ type: string
+ deviceStatusEnum:
+ enum:
+ - CONNECTED
+ - DISCONNECTED
+ type: string
+ endpointTypeEnum:
+ enum:
+ - WEBRTC
+ type: string
+ endpointDirectionEnum:
+ enum:
+ - INBOUND
+ - OUTBOUND
+ - BIDIRECTIONAL
+ type: string
+ sipCredentials:
+ properties:
+ username:
+ description: The username for the SIP connection.
+ example: username
+ type: string
+ password:
+ description: The password for the SIP connection.
+ example: password
+ type: string
+ type: object
+ sipConnectionMetadata:
+ properties:
+ ipAddress:
+ description: The IP address of the SIP connection.
+ example: 192.168.0.0
+ format: ipv4
+ type: string
+ port:
+ description: The port of the SIP connection.
+ example: 5060
+ type: integer
+ credentials:
+ $ref: "#/components/schemas/sipCredentials"
+ uuiHeader:
+ description: The User-to-User Information header for the SIP connection.
+ example: my-uui-header
+ type: string
+ title: SIP Connection
+ type: object
+ webRtcConnectionMetadata:
+ title: WebRTC Connection
+ type: object
+ endpointToken:
+ description: The json web token specific to the endpoint. Used to authenticate
+ the client with the media gateway.
+ example: xxxxx.yyyyy.zzzzz
+ type: string
+ endpointTag:
+ description: A tag for the endpoint.
+ example: my-tag
+ maximum: 1024
+ type: string
+ device:
+ example:
+ creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ properties:
+ deviceId:
+ description: The unique ID of the device.
+ example: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: string
+ deviceName:
+ description: The name of the device.
+ example: David's iPhone
+ maximum: 1024
+ type: string
+ status:
+ $ref: "#/components/schemas/deviceStatusEnum"
+ creationTimestamp:
+ description: The time the device was created. In ISO-8601 format.
+ example: 2021-01-01T00:00:00Z
+ format: date-time
+ type: string
+ required:
+ - creationTimestamp
+ - deviceId
+ - status
+ type: object
+ endpoints:
+ example:
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ properties:
+ endpointId:
+ description: The unique ID of the endpoint.
+ example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: string
+ type:
+ $ref: "#/components/schemas/endpointTypeEnum"
+ status:
+ $ref: "#/components/schemas/endpointStatusEnum"
+ creationTimestamp:
+ description: The time the endpoint was created. In ISO-8601 format.
+ example: 2021-01-01T00:00:00Z
+ format: date-time
+ type: string
+ expirationTimestamp:
+ description: The time the endpoint token will expire. In ISO-8601 format.
+ Tokens last 24 hours.
+ example: 2021-01-02T00:00:00Z
+ format: date-time
+ type: string
+ tag:
+ description: A tag for the endpoint.
+ example: my-tag
+ maximum: 1024
+ type: string
+ required:
+ - creationTimestamp
+ - endpointId
+ - expirationTimestamp
+ - status
+ - type
+ type: object
+ endpoint:
+ allOf:
+ - $ref: "#/components/schemas/endpoints"
+ - properties:
+ devices:
+ items:
+ $ref: "#/components/schemas/device"
+ type: array
+ type: object
+ example:
+ devices:
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ type: object
+ createWebRtcConnectionRequest:
+ allOf:
+ - $ref: "#/components/schemas/createEndpointRequestBase"
+ - properties:
+ connectionMetadata:
+ $ref: "#/components/schemas/webRtcConnectionMetadata"
+ type: object
+ createEndpointRequestBase:
+ properties:
+ type:
+ $ref: "#/components/schemas/endpointTypeEnum"
+ direction:
+ $ref: "#/components/schemas/endpointDirectionEnum"
+ eventCallbackUrl:
+ description: The URL to send event callbacks to.
+ example: https://myapp.com/callback
+ format: uri
+ type: string
+ eventFallbackUrl:
+ description: The URL to send event fallbacks to.
+ example: https://fallback.myapp.com/callback
+ format: uri
+ type: string
+ tag:
+ description: A tag for the endpoint.
+ example: my-tag
+ maximum: 1024
+ type: string
+ required:
+ - direction
+ - type
+ type: object
+ createEndpointRequest:
+ $ref: "#/components/schemas/createWebRtcConnectionRequest"
+ createEndpointResponseData:
+ allOf:
+ - $ref: "#/components/schemas/endpoint"
+ - properties:
+ token:
+ $ref: "#/components/schemas/endpointToken"
+ required:
+ - token
+ type: object
+ example:
+ devices:
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ token: xxxxx.yyyyy.zzzzz
+ endpointEventTypeEnum:
+ enum:
+ - DEVICE_CONNECTED
+ - DEVICE_DISCONNECTED
+ type: string
+ endpointEvent:
+ allOf:
+ - $ref: "#/components/schemas/endpoints"
+ - properties:
+ eventTime:
+ description: The time the event occurred. In ISO-8601 format.
+ example: 2021-01-01T00:00:00Z
+ format: date-time
+ type: string
+ eventType:
+ $ref: "#/components/schemas/endpointEventTypeEnum"
+ device:
+ $ref: "#/components/schemas/device"
+ required:
+ - eventTime
+ - eventType
+ type: object
+ description: An event that occurred on an endpoint.
+ page:
+ example:
+ pageNumber: 0
+ totalPages: 10
+ pageSize: 10
+ totalElements: 100
+ properties:
+ pageSize:
+ description: The number of items per page.
+ example: 10
+ minimum: 0
+ type: integer
+ totalElements:
+ description: The total number of items.
+ example: 100
+ minimum: 0
+ type: integer
+ totalPages:
+ description: The total number of pages.
+ example: 10
+ minimum: 0
+ type: integer
+ pageNumber:
+ description: The current page number.
+ example: 0
+ minimum: 0
+ type: integer
+ required:
+ - pageSize
+ type: object
+ listEndpointsResponse:
+ example:
+ data:
+ - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ links:
+ - rel: rel
+ href: href
+ - rel: rel
+ href: href
+ page:
+ pageNumber: 0
+ totalPages: 10
+ pageSize: 10
+ totalElements: 100
+ errors:
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ properties:
+ links:
+ items:
+ $ref: "#/components/schemas/link"
+ type: array
+ page:
+ $ref: "#/components/schemas/page"
+ data:
+ items:
+ $ref: "#/components/schemas/endpoints"
+ type: array
+ errors:
+ items:
+ $ref: "#/components/schemas/error"
+ type: array
+ required:
+ - data
+ - errors
+ - links
+ type: object
+ endpointResponse:
+ example:
+ data:
+ devices:
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ links:
+ - rel: rel
+ href: href
+ - rel: rel
+ href: href
+ errors:
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ properties:
+ links:
+ items:
+ $ref: "#/components/schemas/link"
+ type: array
+ data:
+ $ref: "#/components/schemas/endpoint"
+ errors:
+ items:
+ $ref: "#/components/schemas/error"
+ type: array
+ required:
+ - data
+ - errors
+ - links
+ type: object
+ createEndpointResponse:
+ example:
+ data:
+ devices:
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ - creationTimestamp: 2021-01-01T00:00:00Z
+ deviceId: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName: David's iPhone
+ status: CONNECTED
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ creationTimestamp: 2021-01-01T00:00:00Z
+ expirationTimestamp: 2021-01-02T00:00:00Z
+ tag: my-tag
+ type: WEBRTC
+ status: CONNECTED
+ token: xxxxx.yyyyy.zzzzz
+ links:
+ - rel: rel
+ href: href
+ - rel: rel
+ href: href
+ errors:
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ properties:
+ links:
+ items:
+ $ref: "#/components/schemas/link"
+ type: array
+ data:
+ $ref: "#/components/schemas/createEndpointResponseData"
+ errors:
+ items:
+ $ref: "#/components/schemas/error"
+ type: array
+ required:
+ - data
+ - errors
+ - links
+ type: object
+ errorResponse:
+ example:
+ data: "{}"
+ links:
+ - rel: rel
+ href: href
+ - rel: rel
+ href: href
+ errors:
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ - code: 0
+ telephoneNumbers:
+ - telephoneNumber: telephoneNumber
+ - telephoneNumber: telephoneNumber
+ description: description
+ properties:
+ links:
+ items:
+ $ref: "#/components/schemas/link"
+ type: array
+ data:
+ additionalProperties: false
+ nullable: true
+ type: object
+ errors:
+ items:
+ $ref: "#/components/schemas/error"
+ type: array
+ required:
+ - data
+ - errors
+ - links
+ type: object
rbmCardContent_media:
allOf:
- $ref: "#/components/schemas/rbmMessageContentFile"
diff --git a/bandwidth.yml b/bandwidth.yml
index 4948dd1d..bff363f2 100644
--- a/bandwidth.yml
+++ b/bandwidth.yml
@@ -22,6 +22,7 @@ tags:
- name: MFA
- name: Phone Number Lookup
- name: Toll-Free Verification
+ - name: Endpoints
paths:
/users/{accountId}/media:
get:
@@ -1690,6 +1691,180 @@ paths:
'503':
$ref: '#/components/responses/tfvServiceUnavailableResponse'
servers: *ref_4
+ /accounts/{accountId}/endpoints:
+ get:
+ tags:
+ - Endpoints
+ summary: List Endpoints
+ description: Returns a list of endpoints associated with the specified account.
+ operationId: listEndpoints
+ parameters:
+ - $ref: '#/components/parameters/accountId'
+ - $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'
+ x-badges:
+ - name: Beta
+ color: '#076EA8'
+ post:
+ tags:
+ - Endpoints
+ summary: Create Endpoint
+ description: Creates a new Endpoint for the specified account.
+ operationId: createEndpoint
+ parameters:
+ - $ref: '#/components/parameters/accountId'
+ requestBody:
+ $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'
+ callbacks:
+ endpointEventCallback:
+ $ref: '#/components/callbacks/endpointEvent'
+ x-badges:
+ - name: Beta
+ color: '#076EA8'
+ servers: &ref_5
+ - url: https://api.bandwidth.com/v2
+ description: Production
+ /accounts/{accountId}/endpoints/{endpointId}:
+ get:
+ tags:
+ - Endpoints
+ summary: Get Endpoint
+ description: Returns information about the specified endpoint.
+ operationId: getEndpoint
+ parameters:
+ - $ref: '#/components/parameters/accountId'
+ - $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'
+ x-badges:
+ - name: Beta
+ color: '#076EA8'
+ delete:
+ tags:
+ - Endpoints
+ summary: Delete Endpoint
+ description: >-
+ Deletes the specified endpoint. If the endpoint is actively streaming
+ media, the media stream will be terminated.
+ operationId: deleteEndpoint
+ parameters:
+ - $ref: '#/components/parameters/accountId'
+ - $ref: '#/components/parameters/endpointId'
+ responses:
+ '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'
+ x-badges:
+ - name: Beta
+ color: '#076EA8'
+ servers: *ref_5
+ /accounts/{accountId}/endpoints/{endpointId}/bxml:
+ put:
+ tags:
+ - Endpoints
+ summary: Update Endpoint BXML
+ description: Updates the BXML for the specified endpoint.
+ operationId: updateEndpointBxml
+ parameters:
+ - $ref: '#/components/parameters/accountId'
+ - $ref: '#/components/parameters/endpointId'
+ requestBody:
+ $ref: '#/components/requestBodies/updateEndpointBxmlRequest'
+ responses:
+ '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'
+ x-badges:
+ - name: Beta
+ color: '#076EA8'
+ servers: *ref_5
components:
schemas:
applicationId:
@@ -1984,7 +2159,7 @@ components:
type: string
description: >-
The name of the Authorized Message Provider (AMP) that handled this
- message.
+ message.
In the US, this is the carrier that the message was sent to.
@@ -2071,7 +2246,7 @@ components:
description: >-
Either an alphanumeric sender ID or the sender's Bandwidth phone
number in E.164 format, which must be hosted within Bandwidth and
- linked to the account that is generating the message.
+ linked to the account that is generating the message.
Alphanumeric Sender IDs can contain up to 11 characters, upper-case
letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -,
@@ -2395,7 +2570,7 @@ components:
- `BROWSER` Opens the URL in the device's default browser. If
application is not set or the device doesn’t support WebView, this
- option is used by default.
+ option is used by default.
- `WEBVIEW` Opens the URL in an in-app WebView.
enum:
@@ -2408,7 +2583,7 @@ components:
Defines the layout of the WebView on a mobile device. It must be defined
when application is set to `WEBVIEW`
- - `FULL` WebView takes the full screen.
+ - `FULL` WebView takes the full screen.
- `HALF` WebView takes half of the screen.
@@ -2809,7 +2984,7 @@ components:
to:
type: string
description: >
- The destination phone number the message was sent to.
+ The destination phone number the message was sent to.
For inbound callbacks, this is the Bandwidth number or alphanumeric
identifier that received the message.
@@ -2860,7 +3035,7 @@ components:
client to a Bandwidth number.
- `request-location-response` indicates a response to a location request
- sent by the Bandwidth user's client after receiving an RBM message.
+ sent by the Bandwidth user's client after receiving an RBM message.
- `suggestion-response` indicates a response to a suggestion sent by the
Bandwidth user's client after receiving an RBM message.
@@ -3099,7 +3274,7 @@ components:
nullable: true
type: string
description: >-
- The caller display name to use when the call is created.
+ The caller display name to use when the call is created.
May not exceed 256 characters nor contain control characters such as
new lines.
@@ -4036,7 +4211,7 @@ components:
format: double
description: >-
When an answering machine is detected, the amount of silence (in
- seconds) before assuming the message has finished playing.
+ seconds) before assuming the message has finished playing.
If not provided it will default to the speechEndThreshold value.
example: 5
@@ -5739,7 +5914,7 @@ components:
format: date
description: >-
[DNI-Only](#section/DNI-Only). The date the phone number entered the
- status described in `latestMessageDeliveryStatus`.
+ status described in `latestMessageDeliveryStatus`.
Think of this as the "start time" for that status.
@@ -5750,7 +5925,7 @@ components:
format: date
description: >-
[DNI-Only](#section/DNI-Only). The date bandwidth last received
- delivery status information for this phone number.
+ delivery status information for this phone number.
Use this field to understand how up-to-date the
`latestMessageDeliveryStatus` is.
@@ -6611,6 +6786,303 @@ components:
nullable: true
example: >-
cv.user123|sess456|mno|tfree|read_write|X7yZ9aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789aBcDeFgHiJkLmNoPqRsTuVw
+ endpointId:
+ type: string
+ description: The unique ID of the endpoint.
+ example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ endpointStatusEnum:
+ type: string
+ enum:
+ - CONNECTED
+ - DISCONNECTED
+ deviceStatusEnum:
+ type: string
+ enum:
+ - CONNECTED
+ - DISCONNECTED
+ endpointTypeEnum:
+ type: string
+ enum:
+ - WEBRTC
+ endpointDirectionEnum:
+ type: string
+ enum:
+ - INBOUND
+ - OUTBOUND
+ - BIDIRECTIONAL
+ sipCredentials:
+ type: object
+ properties:
+ username:
+ type: string
+ description: The username for the SIP connection.
+ example: username
+ password:
+ type: string
+ description: The password for the SIP connection.
+ example: password
+ sipConnectionMetadata:
+ title: SIP Connection
+ type: object
+ properties:
+ ipAddress:
+ type: string
+ format: ipv4
+ description: The IP address of the SIP connection.
+ example: 192.168.0.0
+ port:
+ type: integer
+ description: The port of the SIP connection.
+ example: 5060
+ credentials:
+ $ref: '#/components/schemas/sipCredentials'
+ uuiHeader:
+ type: string
+ description: The User-to-User Information header for the SIP connection.
+ example: my-uui-header
+ webRtcConnectionMetadata:
+ title: WebRTC Connection
+ type: object
+ endpointToken:
+ type: string
+ description: >-
+ The json web token specific to the endpoint. Used to authenticate the
+ client with the media gateway.
+ example: xxxxx.yyyyy.zzzzz
+ endpointTag:
+ type: string
+ description: A tag for the endpoint.
+ example: my-tag
+ maximum: 1024
+ device:
+ type: object
+ properties:
+ deviceId:
+ type: string
+ description: The unique ID of the device.
+ example: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ deviceName:
+ type: string
+ description: The name of the device.
+ maximum: 1024
+ example: David's iPhone
+ status:
+ $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'
+ required:
+ - deviceId
+ - status
+ - creationTimestamp
+ endpoints:
+ type: object
+ properties:
+ endpointId:
+ $ref: '#/components/schemas/endpointId'
+ type:
+ $ref: '#/components/schemas/endpointTypeEnum'
+ status:
+ $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'
+ 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'
+ tag:
+ $ref: '#/components/schemas/endpointTag'
+ required:
+ - endpointId
+ - type
+ - status
+ - creationTimestamp
+ - expirationTimestamp
+ endpoint:
+ type: object
+ allOf:
+ - $ref: '#/components/schemas/endpoints'
+ - type: object
+ properties:
+ devices:
+ type: array
+ items:
+ $ref: '#/components/schemas/device'
+ createWebRtcConnectionRequest:
+ allOf:
+ - $ref: '#/components/schemas/createEndpointRequestBase'
+ - type: object
+ properties:
+ connectionMetadata:
+ $ref: '#/components/schemas/webRtcConnectionMetadata'
+ createEndpointRequestBase:
+ type: object
+ properties:
+ type:
+ $ref: '#/components/schemas/endpointTypeEnum'
+ direction:
+ $ref: '#/components/schemas/endpointDirectionEnum'
+ eventCallbackUrl:
+ type: string
+ format: uri
+ description: The URL to send event callbacks to.
+ example: https://myapp.com/callback
+ eventFallbackUrl:
+ type: string
+ format: uri
+ description: The URL to send event fallbacks to.
+ example: https://fallback.myapp.com/callback
+ tag:
+ $ref: '#/components/schemas/endpointTag'
+ required:
+ - type
+ - direction
+ createEndpointRequest:
+ oneOf:
+ - $ref: '#/components/schemas/createWebRtcConnectionRequest'
+ discriminator:
+ propertyName: type
+ mapping:
+ WEBRTC: '#/components/schemas/createWebRtcConnectionRequest'
+ createEndpointResponseData:
+ allOf:
+ - $ref: '#/components/schemas/endpoint'
+ - type: object
+ properties:
+ token:
+ $ref: '#/components/schemas/endpointToken'
+ required:
+ - token
+ endpointEventTypeEnum:
+ type: string
+ enum:
+ - DEVICE_CONNECTED
+ - DEVICE_DISCONNECTED
+ endpointEvent:
+ description: An event that occurred on an endpoint.
+ allOf:
+ - $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'
+ eventType:
+ $ref: '#/components/schemas/endpointEventTypeEnum'
+ device:
+ $ref: '#/components/schemas/device'
+ required:
+ - eventType
+ - eventTime
+ page:
+ type: object
+ properties:
+ pageSize:
+ type: integer
+ description: The number of items per page.
+ minimum: 0
+ example: 10
+ totalElements:
+ type: integer
+ description: The total number of items.
+ minimum: 0
+ example: 100
+ totalPages:
+ type: integer
+ description: The total number of pages.
+ minimum: 0
+ example: 10
+ pageNumber:
+ type: integer
+ description: The current page number.
+ minimum: 0
+ example: 0
+ required:
+ - pageSize
+ listEndpointsResponse:
+ type: object
+ properties:
+ links:
+ type: array
+ items:
+ $ref: '#/components/schemas/link'
+ page:
+ $ref: '#/components/schemas/page'
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/endpoints'
+ errors:
+ type: array
+ items:
+ $ref: '#/components/schemas/error'
+ required:
+ - links
+ - data
+ - errors
+ endpointResponse:
+ type: object
+ properties:
+ links:
+ type: array
+ items:
+ $ref: '#/components/schemas/link'
+ data:
+ $ref: '#/components/schemas/endpoint'
+ errors:
+ type: array
+ items:
+ $ref: '#/components/schemas/error'
+ required:
+ - links
+ - data
+ - errors
+ createEndpointResponse:
+ type: object
+ properties:
+ links:
+ type: array
+ items:
+ $ref: '#/components/schemas/link'
+ data:
+ $ref: '#/components/schemas/createEndpointResponseData'
+ errors:
+ type: array
+ items:
+ $ref: '#/components/schemas/error'
+ required:
+ - links
+ - data
+ - errors
+ errorResponse:
+ type: object
+ properties:
+ links:
+ type: array
+ items:
+ $ref: '#/components/schemas/link'
+ data:
+ type: object
+ nullable: true
+ additionalProperties: false
+ errors:
+ type: array
+ items:
+ $ref: '#/components/schemas/error'
+ required:
+ - links
+ - data
+ - errors
responses:
createMessageResponse:
description: Accepted
@@ -7281,6 +7753,105 @@ components:
type: Service Unavailable
verifyPutResponse:
description: Accepted
+ listEndpointsResponse:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/listEndpointsResponse'
+ examples:
+ listEndpointsResponseExample:
+ $ref: '#/components/examples/listEndpointsResponseExample'
+ createEndpointResponse:
+ description: Created
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/createEndpointResponse'
+ examples:
+ createEndpointResponseExample:
+ $ref: '#/components/examples/createEndpointResponseExample'
+ getEndpointResponse:
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/endpointResponse'
+ examples:
+ getEndpointResponseExample:
+ $ref: '#/components/examples/getEndpointResponseExample'
+ badRequestErrorResponse:
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ badRequestErrorExample:
+ $ref: '#/components/examples/badRequestErrorExample'
+ unauthorizedErrorResponse:
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ unauthorizedErrorExample:
+ $ref: '#/components/examples/unauthorizedErrorExample'
+ forbiddenErrorResponse:
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ forbiddenErrorExample:
+ $ref: '#/components/examples/forbiddenErrorExample'
+ notFoundErrorResponse:
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ notFoundErrorExample:
+ $ref: '#/components/examples/notFoundErrorExample'
+ methodNotAllowedErrorResponse:
+ description: Method Not Allowed
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ methodNotAllowedErrorExample:
+ $ref: '#/components/examples/methodNotAllowedErrorExample'
+ unsupportedMediaTypeErrorResponse:
+ description: Unsupported Media Type
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ unsuppotedMediaTypeErrorExample:
+ $ref: '#/components/examples/unsupportedMediaTypeErrorExample'
+ tooManyRequestsErrorResponse:
+ description: Too Many Requests
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ tooManyRequestsErrorExample:
+ $ref: '#/components/examples/tooManyRequestsErrorExample'
+ serviceUnavailableErrorResponse:
+ description: Service Unavailable
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/errorResponse'
+ examples:
+ serviceUnavailableErrorExample:
+ $ref: '#/components/examples/serviceUnavailableErrorExample'
parameters:
accountId:
in: path
@@ -7780,6 +8351,45 @@ components:
type: string
description: Webhook subscription ID
example: 7bt57JcsVYJrN9K1OcV1Nu
+ endpointId:
+ name: endpointId
+ in: path
+ required: true
+ schema:
+ type: string
+ example: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ description: BRTC Endpoint ID.
+ endpointType:
+ name: type
+ in: query
+ schema:
+ $ref: '#/components/schemas/endpointTypeEnum'
+ description: The type of endpoint.
+ endpointStatus:
+ name: status
+ in: query
+ schema:
+ $ref: '#/components/schemas/endpointStatusEnum'
+ description: The status of the endpoint.
+ afterCursor:
+ name: afterCursor
+ in: query
+ schema:
+ type: string
+ example: TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
+ description: >-
+ The cursor to use for pagination. This is the value of the `next` link
+ in the previous response.
+ limit1:
+ name: limit
+ in: query
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 1000
+ default: 100
+ example: 2
+ description: The maximum number of endpoints to return in the response.
examples:
smsMessageReceivedCallbackExample:
summary: An example of a sms message-received callback body.
@@ -8204,6 +8814,205 @@ components:
Unexpected error. Please contact Bandwidth Support if your
requests are receiving this status code for an extended period of
time.
+ listEndpointsResponseExample:
+ summary: List Endpoints Paginated Response
+ value:
+ links:
+ - href: >-
+ https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2
+ rel: self
+ method: GET
+ - href: >-
+ https://api.bandwidth.com/v2/accounts/5500123/endpoints?type=SIP&status=CONNECTED&limit=2&afterCursor=TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ==
+ rel: next
+ method: GET
+ page:
+ pageSize: 2
+ totalElements: 10
+ totalPages: 5
+ pageNumber: 0
+ data:
+ - endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: WEBRTC
+ status: CONNECTED
+ 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'
+ tag: my-tag
+ errors: []
+ createEndpointResponseExample:
+ summary: Create Endpoint Response
+ value:
+ links:
+ - href: >-
+ https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ rel: endpoint
+ method: GET
+ data:
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ token: xxxxx.yyyyy.zzzzz
+ type: WEBRTC
+ status: CONNECTED
+ creationTimestamp: '2021-01-01T00:00:00Z'
+ expirationTimestamp: '2021-01-02T00:00:00Z'
+ devices: []
+ tag: my-tag
+ errors: []
+ getEndpointResponseExample:
+ summary: Get Endpoint Response
+ value:
+ links:
+ - href: >-
+ https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ rel: self
+ method: GET
+ data:
+ endpointId: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ type: WEBRTC
+ status: CONNECTED
+ creationTimestamp: '2021-01-01T00:00:00Z'
+ expirationTimestamp: '2021-01-02T00:00:00Z'
+ devices: []
+ tag: my-tag
+ errors: []
+ createSipEndpointRequestExample:
+ summary: SIP Endpoint Example
+ value:
+ type: SIP
+ connectionMetadata:
+ ipAddress: 0.0.0.0
+ port: 3000
+ credentials:
+ username: username
+ password: '********'
+ uuiHeader: 123456;encoding=jwt
+ direction: INBOUND
+ eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
+ eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
+ tag: '{"myTag": "myTagValue"}'
+ createWeRtcEndpointExample:
+ summary: WebRTC Endpoint Example
+ value:
+ type: WEBRTC
+ direction: BIDIRECTIONAL
+ eventCallbackUrl: https://myEventCallbackUrl.com/callbacks/bandwidth
+ eventFallbackUrl: https://fallback.myEventCallbackUrl.com/callbacks/bandwidth
+ tag: '{"myTag": "myTagValue"}'
+ updateEndpointBxmlRequestExample:
+ summary: Update Endpoint BXML Request Example
+ value:
+ endpointDisconnectedEventExample:
+ summary: Endpoint Disconnected Event
+ value:
+ 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'
+ eventType: DEVICE_DISCONNECTED
+ tag: my-tag
+ badRequestErrorExample:
+ summary: Bad Request Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: invalid_parameter
+ description: accountId must not contain any characters other than numbers.
+ code: '400'
+ source:
+ parameter: accountId
+ unauthorizedErrorExample:
+ summary: Unauthorized Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: unauthorized
+ description: >-
+ The provided credentials are not authorized to access this
+ resource.
+ code: '401'
+ source:
+ header: Authorization
+ forbiddenErrorExample:
+ summary: Forbidden Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: forbidden
+ description: >-
+ The provided credentials are not authorized to access this
+ resource.
+ code: '403'
+ source:
+ header: Authorization
+ notFoundErrorExample:
+ summary: Not Found Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: resource_not_found
+ description: The requested resource was not found.
+ code: '404'
+ source:
+ reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+ methodNotAllowedErrorExample:
+ summary: Method Not Allowed Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: method_not_allowed
+ description: The requested method is not allowed on this resource.
+ code: '405'
+ source:
+ parameter: accountId
+ unsupportedMediaTypeErrorExample:
+ summary: Unsupported Media Type Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: unsupported_media_type
+ description: The provided media type is not supported.
+ code: '415'
+ source:
+ header: Content-Type
+ tooManyRequestsErrorExample:
+ summary: Too Many Requests Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: too_many_requests
+ description: The client has sent too many requests in a given amount of time.
+ code: '429'
+ serviceUnavailableErrorExample:
+ summary: Service Unavailable Error Example
+ value:
+ links: []
+ data: null
+ errors:
+ - id: 59512d87-7a92-4040-8e4a-78fb772019b9
+ type: service_unavailable
+ description: The service is currently unavailable.
+ code: '500'
requestBodies:
createMessageRequest:
content:
@@ -8559,6 +9368,30 @@ components:
application/json:
schema:
$ref: '#/components/schemas/webhookSubscriptionRequestSchema'
+ createEndpointRequest:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/createEndpointRequest'
+ examples:
+ createWebRtcEndpointRequestExample:
+ $ref: '#/components/examples/createWeRtcEndpointExample'
+ updateEndpointBxmlRequest:
+ required: true
+ content:
+ application/xml:
+ schema:
+ type: string
+ description: >-
+ The BXML document to update the endpoint with. This BXML document
+ will be executed against the endpoint when it is updated.
+
+ For more information, please refer to our [BXML
+ documentation](/docs/voice/bxml/).
+ examples:
+ updateEndpointBxmlRequestExample:
+ $ref: '#/components/examples/updateEndpointBxmlRequestExample'
securitySchemes:
Basic:
type: http
@@ -8585,12 +9418,12 @@ components:
required: true
description: >-
This Inbound Message Webhook is an envelope containing either a
- received (MO) message to your
+ received (MO) message to your
message-enabled Bandwidth telephone number or a multichannel
- client's response to a suggestion response
+ client's response to a suggestion response
- or location request.
+ or location request.
The payload type will be one of message-received,
suggestion-response, or
@@ -8692,3 +9525,17 @@ components:
$ref: '#/components/responses/tfvServerErrorResponse'
'503':
$ref: '#/components/responses/tfvServiceUnavailableResponse'
+ endpointEvent:
+ '{request.body#/eventCallbackUrl}':
+ post:
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/endpointEvent'
+ examples:
+ endpointDisconnectedEventExample:
+ $ref: '#/components/examples/endpointDisconnectedEventExample'
+ responses:
+ '204':
+ description: Event was successfully received.
diff --git a/docs/Callback.md b/docs/Callback.md
index 56428470..9d38bdd5 100644
--- a/docs/Callback.md
+++ b/docs/Callback.md
@@ -11,11 +11,11 @@ Callbacks are divided into two types based on direction of the related message:
|**time** | **OffsetDateTime** | | |
|**eventTime** | **OffsetDateTime** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] |
|**type** | **InboundCallbackTypeEnum** | | |
-|**to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
+|**to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
|**description** | **String** | A detailed description of the event described by the callback. | |
|**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | |
|**errorCode** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
-|**carrierName** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
+|**carrierName** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
diff --git a/docs/CreateCall.md b/docs/CreateCall.md
index 109c9170..7937060a 100644
--- a/docs/CreateCall.md
+++ b/docs/CreateCall.md
@@ -10,7 +10,7 @@
|**to** | **String** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). | |
|**from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. | |
|**privacy** | **Boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] |
-|**displayName** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] |
+|**displayName** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] |
|**uui** | **String** | A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433'>RFC 7433</a>. Only 'jwt', 'base64' and 'hex' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] |
|**applicationId** | **String** | The id of the application associated with the `from` number. | |
|**answerUrl** | **URI** | The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`. | |
diff --git a/docs/CreateEndpointRequestBase.md b/docs/CreateEndpointRequestBase.md
new file mode 100644
index 00000000..63c36223
--- /dev/null
+++ b/docs/CreateEndpointRequestBase.md
@@ -0,0 +1,17 @@
+
+
+# CreateEndpointRequestBase
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **EndpointTypeEnum** | | |
+|**direction** | **EndpointDirectionEnum** | | |
+|**eventCallbackUrl** | **URI** | The URL to send event callbacks to. | [optional] |
+|**eventFallbackUrl** | **URI** | The URL to send event fallbacks to. | [optional] |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+
+
+
diff --git a/docs/CreateEndpointResponse.md b/docs/CreateEndpointResponse.md
new file mode 100644
index 00000000..3c481b31
--- /dev/null
+++ b/docs/CreateEndpointResponse.md
@@ -0,0 +1,15 @@
+
+
+# CreateEndpointResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**links** | [**List<Link>**](Link.md) | | |
+|**data** | [**CreateEndpointResponseData**](CreateEndpointResponseData.md) | | |
+|**errors** | [**List<Error>**](Error.md) | | |
+
+
+
diff --git a/docs/CreateEndpointResponseData.md b/docs/CreateEndpointResponseData.md
new file mode 100644
index 00000000..2e1911fc
--- /dev/null
+++ b/docs/CreateEndpointResponseData.md
@@ -0,0 +1,20 @@
+
+
+# CreateEndpointResponseData
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**endpointId** | **String** | The unique ID of the endpoint. | |
+|**type** | **EndpointTypeEnum** | | |
+|**status** | **EndpointStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the endpoint was created. In ISO-8601 format. | |
+|**expirationTimestamp** | **OffsetDateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+|**devices** | [**List<Device>**](Device.md) | | [optional] |
+|**token** | **String** | The json web token specific to the endpoint. Used to authenticate the client with the media gateway. | |
+
+
+
diff --git a/docs/CreateEndpointResponseObject.md b/docs/CreateEndpointResponseObject.md
new file mode 100644
index 00000000..4506e590
--- /dev/null
+++ b/docs/CreateEndpointResponseObject.md
@@ -0,0 +1,20 @@
+
+
+# CreateEndpointResponseObject
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**endpointId** | **String** | The unique ID of the endpoint. | |
+|**type** | **EndpointTypeEnum** | | |
+|**status** | **EndpointStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the endpoint was created. In ISO-8601 format. | |
+|**expirationTimestamp** | **OffsetDateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+|**devices** | [**List<Device>**](Device.md) | | [optional] |
+|**token** | **String** | The json web token specific to the endpoint. Used to authenticate the client with the media gateway. | |
+
+
+
diff --git a/docs/CreateWebRtcConnectionRequest.md b/docs/CreateWebRtcConnectionRequest.md
new file mode 100644
index 00000000..70c3da9e
--- /dev/null
+++ b/docs/CreateWebRtcConnectionRequest.md
@@ -0,0 +1,18 @@
+
+
+# CreateWebRtcConnectionRequest
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**type** | **EndpointTypeEnum** | | |
+|**direction** | **EndpointDirectionEnum** | | |
+|**eventCallbackUrl** | **URI** | The URL to send event callbacks to. | [optional] |
+|**eventFallbackUrl** | **URI** | The URL to send event fallbacks to. | [optional] |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+|**connectionMetadata** | **Object** | | [optional] |
+
+
+
diff --git a/docs/Device.md b/docs/Device.md
new file mode 100644
index 00000000..f3480867
--- /dev/null
+++ b/docs/Device.md
@@ -0,0 +1,16 @@
+
+
+# Device
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**deviceId** | **String** | The unique ID of the device. | |
+|**deviceName** | **String** | The name of the device. | [optional] |
+|**status** | **DeviceStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the device was created. In ISO-8601 format. | |
+
+
+
diff --git a/docs/DeviceStatusEnum.md b/docs/DeviceStatusEnum.md
new file mode 100644
index 00000000..555f3745
--- /dev/null
+++ b/docs/DeviceStatusEnum.md
@@ -0,0 +1,13 @@
+
+
+# DeviceStatusEnum
+
+## Enum
+
+
+* `CONNECTED` (value: `"CONNECTED"`)
+
+* `DISCONNECTED` (value: `"DISCONNECTED"`)
+
+
+
diff --git a/docs/Endpoint.md b/docs/Endpoint.md
new file mode 100644
index 00000000..645088d7
--- /dev/null
+++ b/docs/Endpoint.md
@@ -0,0 +1,19 @@
+
+
+# Endpoint
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**endpointId** | **String** | The unique ID of the endpoint. | |
+|**type** | **EndpointTypeEnum** | | |
+|**status** | **EndpointStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the endpoint was created. In ISO-8601 format. | |
+|**expirationTimestamp** | **OffsetDateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+|**devices** | [**List<Device>**](Device.md) | | [optional] |
+
+
+
diff --git a/docs/EndpointDirectionEnum.md b/docs/EndpointDirectionEnum.md
new file mode 100644
index 00000000..1e74e06e
--- /dev/null
+++ b/docs/EndpointDirectionEnum.md
@@ -0,0 +1,15 @@
+
+
+# EndpointDirectionEnum
+
+## Enum
+
+
+* `INBOUND` (value: `"INBOUND"`)
+
+* `OUTBOUND` (value: `"OUTBOUND"`)
+
+* `BIDIRECTIONAL` (value: `"BIDIRECTIONAL"`)
+
+
+
diff --git a/docs/EndpointEvent.md b/docs/EndpointEvent.md
new file mode 100644
index 00000000..5c844cb0
--- /dev/null
+++ b/docs/EndpointEvent.md
@@ -0,0 +1,22 @@
+
+
+# EndpointEvent
+
+An event that occurred on an endpoint.
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**endpointId** | **String** | The unique ID of the endpoint. | |
+|**type** | **EndpointTypeEnum** | | |
+|**status** | **EndpointStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the endpoint was created. In ISO-8601 format. | |
+|**expirationTimestamp** | **OffsetDateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+|**eventTime** | **OffsetDateTime** | The time the event occurred. In ISO-8601 format. | |
+|**eventType** | **EndpointEventTypeEnum** | | |
+|**device** | [**Device**](Device.md) | | [optional] |
+
+
+
diff --git a/docs/EndpointEventTypeEnum.md b/docs/EndpointEventTypeEnum.md
new file mode 100644
index 00000000..c2aedec7
--- /dev/null
+++ b/docs/EndpointEventTypeEnum.md
@@ -0,0 +1,13 @@
+
+
+# EndpointEventTypeEnum
+
+## Enum
+
+
+* `DEVICE_CONNECTED` (value: `"DEVICE_CONNECTED"`)
+
+* `DEVICE_DISCONNECTED` (value: `"DEVICE_DISCONNECTED"`)
+
+
+
diff --git a/docs/EndpointResponse.md b/docs/EndpointResponse.md
new file mode 100644
index 00000000..2240efed
--- /dev/null
+++ b/docs/EndpointResponse.md
@@ -0,0 +1,15 @@
+
+
+# EndpointResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**links** | [**List<Link>**](Link.md) | | |
+|**data** | [**Endpoint**](Endpoint.md) | | |
+|**errors** | [**List<Error>**](Error.md) | | |
+
+
+
diff --git a/docs/EndpointStatusEnum.md b/docs/EndpointStatusEnum.md
new file mode 100644
index 00000000..49744c9a
--- /dev/null
+++ b/docs/EndpointStatusEnum.md
@@ -0,0 +1,13 @@
+
+
+# EndpointStatusEnum
+
+## Enum
+
+
+* `CONNECTED` (value: `"CONNECTED"`)
+
+* `DISCONNECTED` (value: `"DISCONNECTED"`)
+
+
+
diff --git a/docs/EndpointTypeEnum.md b/docs/EndpointTypeEnum.md
new file mode 100644
index 00000000..f4753aaa
--- /dev/null
+++ b/docs/EndpointTypeEnum.md
@@ -0,0 +1,11 @@
+
+
+# EndpointTypeEnum
+
+## Enum
+
+
+* `WEBRTC` (value: `"WEBRTC"`)
+
+
+
diff --git a/docs/Endpoints.md b/docs/Endpoints.md
new file mode 100644
index 00000000..9f50cf22
--- /dev/null
+++ b/docs/Endpoints.md
@@ -0,0 +1,18 @@
+
+
+# Endpoints
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**endpointId** | **String** | The unique ID of the endpoint. | |
+|**type** | **EndpointTypeEnum** | | |
+|**status** | **EndpointStatusEnum** | | |
+|**creationTimestamp** | **OffsetDateTime** | The time the endpoint was created. In ISO-8601 format. | |
+|**expirationTimestamp** | **OffsetDateTime** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. | |
+|**tag** | **String** | A tag for the endpoint. | [optional] |
+
+
+
diff --git a/docs/EndpointsApi.md b/docs/EndpointsApi.md
new file mode 100644
index 00000000..41586cc2
--- /dev/null
+++ b/docs/EndpointsApi.md
@@ -0,0 +1,429 @@
+# EndpointsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createEndpoint**](EndpointsApi.md#createEndpoint) | **POST** /accounts/{accountId}/endpoints | Create Endpoint |
+| [**deleteEndpoint**](EndpointsApi.md#deleteEndpoint) | **DELETE** /accounts/{accountId}/endpoints/{endpointId} | Delete Endpoint |
+| [**getEndpoint**](EndpointsApi.md#getEndpoint) | **GET** /accounts/{accountId}/endpoints/{endpointId} | Get Endpoint |
+| [**listEndpoints**](EndpointsApi.md#listEndpoints) | **GET** /accounts/{accountId}/endpoints | List Endpoints |
+| [**updateEndpointBxml**](EndpointsApi.md#updateEndpointBxml) | **PUT** /accounts/{accountId}/endpoints/{endpointId}/bxml | Update Endpoint BXML |
+
+
+
+# **createEndpoint**
+> CreateEndpointResponse createEndpoint(accountId, body)
+
+Create Endpoint
+
+Creates a new Endpoint for the specified account.
+
+### Example
+```java
+// Import classes:
+import com.bandwidth.sdk.ApiClient;
+import com.bandwidth.sdk.ApiException;
+import com.bandwidth.sdk.Configuration;
+import com.bandwidth.sdk.auth.*;
+import com.bandwidth.sdk.models.*;
+import com.bandwidth.sdk.api.EndpointsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("http://localhost");
+
+ // Configure HTTP basic authorization: Basic
+ HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
+ Basic.setUsername("YOUR USERNAME");
+ Basic.setPassword("YOUR PASSWORD");
+
+ // Configure OAuth2 access token for authorization: OAuth2
+ OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+ OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ EndpointsApi apiInstance = new EndpointsApi(defaultClient);
+ String accountId = "9900000"; // String | Your Bandwidth Account ID.
+ CreateWebRtcConnectionRequest body = new CreateWebRtcConnectionRequest(); // CreateWebRtcConnectionRequest |
+ try {
+ CreateEndpointResponse result = apiInstance.createEndpoint(accountId, body);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EndpointsApi#createEndpoint");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | **String**| Your Bandwidth Account ID. | |
+| **body** | **CreateWebRtcConnectionRequest**| | |
+
+### Return type
+
+[**CreateEndpointResponse**](CreateEndpointResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created | - |
+| **400** | Bad Request | - |
+| **401** | Unauthorized | - |
+| **403** | Forbidden | - |
+| **404** | Not Found | - |
+| **405** | Method Not Allowed | - |
+| **415** | Unsupported Media Type | - |
+| **429** | Too Many Requests | - |
+| **500** | Service Unavailable | - |
+
+
+# **deleteEndpoint**
+> deleteEndpoint(accountId, endpointId)
+
+Delete Endpoint
+
+Deletes the specified endpoint. If the endpoint is actively streaming media, the media stream will be terminated.
+
+### Example
+```java
+// Import classes:
+import com.bandwidth.sdk.ApiClient;
+import com.bandwidth.sdk.ApiException;
+import com.bandwidth.sdk.Configuration;
+import com.bandwidth.sdk.auth.*;
+import com.bandwidth.sdk.models.*;
+import com.bandwidth.sdk.api.EndpointsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("http://localhost");
+
+ // Configure HTTP basic authorization: Basic
+ HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
+ Basic.setUsername("YOUR USERNAME");
+ Basic.setPassword("YOUR PASSWORD");
+
+ // Configure OAuth2 access token for authorization: OAuth2
+ OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+ OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ EndpointsApi apiInstance = new EndpointsApi(defaultClient);
+ String accountId = "9900000"; // String | Your Bandwidth Account ID.
+ String endpointId = "e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"; // String | BRTC Endpoint ID.
+ try {
+ apiInstance.deleteEndpoint(accountId, endpointId);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EndpointsApi#deleteEndpoint");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | **String**| Your Bandwidth Account ID. | |
+| **endpointId** | **String**| BRTC Endpoint ID. | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content | - |
+| **400** | Bad Request | - |
+| **401** | Unauthorized | - |
+| **403** | Forbidden | - |
+| **404** | Not Found | - |
+| **405** | Method Not Allowed | - |
+| **415** | Unsupported Media Type | - |
+| **429** | Too Many Requests | - |
+| **500** | Service Unavailable | - |
+
+
+# **getEndpoint**
+> EndpointResponse getEndpoint(accountId, endpointId)
+
+Get Endpoint
+
+Returns information about the specified endpoint.
+
+### Example
+```java
+// Import classes:
+import com.bandwidth.sdk.ApiClient;
+import com.bandwidth.sdk.ApiException;
+import com.bandwidth.sdk.Configuration;
+import com.bandwidth.sdk.auth.*;
+import com.bandwidth.sdk.models.*;
+import com.bandwidth.sdk.api.EndpointsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("http://localhost");
+
+ // Configure HTTP basic authorization: Basic
+ HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
+ Basic.setUsername("YOUR USERNAME");
+ Basic.setPassword("YOUR PASSWORD");
+
+ // Configure OAuth2 access token for authorization: OAuth2
+ OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+ OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ EndpointsApi apiInstance = new EndpointsApi(defaultClient);
+ String accountId = "9900000"; // String | Your Bandwidth Account ID.
+ String endpointId = "e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"; // String | BRTC Endpoint ID.
+ try {
+ EndpointResponse result = apiInstance.getEndpoint(accountId, endpointId);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EndpointsApi#getEndpoint");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | **String**| Your Bandwidth Account ID. | |
+| **endpointId** | **String**| BRTC Endpoint ID. | |
+
+### Return type
+
+[**EndpointResponse**](EndpointResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK | - |
+| **400** | Bad Request | - |
+| **401** | Unauthorized | - |
+| **403** | Forbidden | - |
+| **404** | Not Found | - |
+| **405** | Method Not Allowed | - |
+| **415** | Unsupported Media Type | - |
+| **429** | Too Many Requests | - |
+| **500** | Service Unavailable | - |
+
+
+# **listEndpoints**
+> ListEndpointsResponse listEndpoints(accountId, type, status, afterCursor, limit)
+
+List Endpoints
+
+Returns a list of endpoints associated with the specified account.
+
+### Example
+```java
+// Import classes:
+import com.bandwidth.sdk.ApiClient;
+import com.bandwidth.sdk.ApiException;
+import com.bandwidth.sdk.Configuration;
+import com.bandwidth.sdk.auth.*;
+import com.bandwidth.sdk.models.*;
+import com.bandwidth.sdk.api.EndpointsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("http://localhost");
+
+ // Configure HTTP basic authorization: Basic
+ HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
+ Basic.setUsername("YOUR USERNAME");
+ Basic.setPassword("YOUR PASSWORD");
+
+ // Configure OAuth2 access token for authorization: OAuth2
+ OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+ OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ EndpointsApi apiInstance = new EndpointsApi(defaultClient);
+ String accountId = "9900000"; // String | Your Bandwidth Account ID.
+ EndpointTypeEnum type = EndpointTypeEnum.fromValue("WEBRTC"); // EndpointTypeEnum | The type of endpoint.
+ EndpointStatusEnum status = EndpointStatusEnum.fromValue("CONNECTED"); // EndpointStatusEnum | The status of the endpoint.
+ String afterCursor = "TWF5IHRoZSBmb3JjZSBiZSB3aXRoIHlvdQ=="; // String | The cursor to use for pagination. This is the value of the `next` link in the previous response.
+ Integer limit = 100; // Integer | The maximum number of endpoints to return in the response.
+ try {
+ ListEndpointsResponse result = apiInstance.listEndpoints(accountId, type, status, afterCursor, limit);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EndpointsApi#listEndpoints");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | **String**| Your Bandwidth Account ID. | |
+| **type** | [**EndpointTypeEnum**](.md)| The type of endpoint. | [optional] [enum: WEBRTC] |
+| **status** | [**EndpointStatusEnum**](.md)| The status of the endpoint. | [optional] [enum: CONNECTED, DISCONNECTED] |
+| **afterCursor** | **String**| The cursor to use for pagination. This is the value of the `next` link in the previous response. | [optional] |
+| **limit** | **Integer**| The maximum number of endpoints to return in the response. | [optional] [default to 100] |
+
+### Return type
+
+[**ListEndpointsResponse**](ListEndpointsResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK | - |
+| **400** | Bad Request | - |
+| **401** | Unauthorized | - |
+| **403** | Forbidden | - |
+| **404** | Not Found | - |
+| **405** | Method Not Allowed | - |
+| **415** | Unsupported Media Type | - |
+| **429** | Too Many Requests | - |
+| **500** | Service Unavailable | - |
+
+
+# **updateEndpointBxml**
+> updateEndpointBxml(accountId, endpointId, body)
+
+Update Endpoint BXML
+
+Updates the BXML for the specified endpoint.
+
+### Example
+```java
+// Import classes:
+import com.bandwidth.sdk.ApiClient;
+import com.bandwidth.sdk.ApiException;
+import com.bandwidth.sdk.Configuration;
+import com.bandwidth.sdk.auth.*;
+import com.bandwidth.sdk.models.*;
+import com.bandwidth.sdk.api.EndpointsApi;
+
+public class Example {
+ public static void main(String[] args) {
+ ApiClient defaultClient = Configuration.getDefaultApiClient();
+ defaultClient.setBasePath("http://localhost");
+
+ // Configure HTTP basic authorization: Basic
+ HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
+ Basic.setUsername("YOUR USERNAME");
+ Basic.setPassword("YOUR PASSWORD");
+
+ // Configure OAuth2 access token for authorization: OAuth2
+ OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
+ OAuth2.setAccessToken("YOUR ACCESS TOKEN");
+
+ EndpointsApi apiInstance = new EndpointsApi(defaultClient);
+ String accountId = "9900000"; // String | Your Bandwidth Account ID.
+ String endpointId = "e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"; // String | BRTC Endpoint ID.
+ String body = "body_example"; // String |
+ try {
+ apiInstance.updateEndpointBxml(accountId, endpointId, body);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling EndpointsApi#updateEndpointBxml");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getResponseBody());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | **String**| Your Bandwidth Account ID. | |
+| **endpointId** | **String**| BRTC Endpoint ID. | |
+| **body** | **String**| | |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic), [OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/xml
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content | - |
+| **400** | Bad Request | - |
+| **401** | Unauthorized | - |
+| **403** | Forbidden | - |
+| **404** | Not Found | - |
+| **405** | Method Not Allowed | - |
+| **415** | Unsupported Media Type | - |
+| **429** | Too Many Requests | - |
+| **500** | Service Unavailable | - |
+
diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md
new file mode 100644
index 00000000..a5409868
--- /dev/null
+++ b/docs/ErrorResponse.md
@@ -0,0 +1,15 @@
+
+
+# ErrorResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**links** | [**List<Link>**](Link.md) | | |
+|**data** | **Object** | | |
+|**errors** | [**List<Error>**](Error.md) | | |
+
+
+
diff --git a/docs/InboundCallback.md b/docs/InboundCallback.md
index 5a1993cb..520e3f24 100644
--- a/docs/InboundCallback.md
+++ b/docs/InboundCallback.md
@@ -10,10 +10,10 @@ Represents an inbound callback.
|------------ | ------------- | ------------- | -------------|
|**time** | **OffsetDateTime** | | |
|**type** | **InboundCallbackTypeEnum** | | |
-|**to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
+|**to** | **String** | The destination phone number the message was sent to. For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. | |
|**description** | **String** | A detailed description of the event described by the callback. | |
|**message** | [**InboundCallbackMessage**](InboundCallbackMessage.md) | | |
-|**carrierName** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
+|**carrierName** | **String** | The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
diff --git a/docs/ListEndpointsResponse.md b/docs/ListEndpointsResponse.md
new file mode 100644
index 00000000..2ab178bf
--- /dev/null
+++ b/docs/ListEndpointsResponse.md
@@ -0,0 +1,16 @@
+
+
+# ListEndpointsResponse
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**links** | [**List<Link>**](Link.md) | | |
+|**page** | [**Page**](Page.md) | | [optional] |
+|**data** | [**List<Endpoints>**](Endpoints.md) | | |
+|**errors** | [**List<Error>**](Error.md) | | |
+
+
+
diff --git a/docs/LookupResult.md b/docs/LookupResult.md
index 21e16602..d8353faa 100644
--- a/docs/LookupResult.md
+++ b/docs/LookupResult.md
@@ -17,8 +17,8 @@ Carrier information results for the specified telephone number.
|**deactivationDate** | **String** | [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event. | [optional] |
|**deactivationEvent** | **DeactivationEventEnum** | | [optional] |
|**latestMessageDeliveryStatus** | **LatestMessageDeliveryStatusEnum** | | [optional] |
-|**initialMessageDeliveryStatusDate** | **LocalDate** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
-|**latestMessageDeliveryStatusDate** | **LocalDate** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
+|**initialMessageDeliveryStatusDate** | **LocalDate** | [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`. Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
+|**latestMessageDeliveryStatusDate** | **LocalDate** | [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number. Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes. | [optional] |
diff --git a/docs/MachineDetectionConfiguration.md b/docs/MachineDetectionConfiguration.md
index a3f6de4c..f3aeba26 100644
--- a/docs/MachineDetectionConfiguration.md
+++ b/docs/MachineDetectionConfiguration.md
@@ -13,7 +13,7 @@ The machine detection request used to perform
+