Skip to content

DX-4173 Update SDK Based on Recent Spec Changes #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ckoegel merged 3 commits into from
Nov 3, 2026
Merged

DX-4173 Update SDK Based on Recent Spec Changes #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd34c15
Generate SDK with OpenAPI Generator Version 7.17.0
DX-Bandwidth Nov 3, 2026
699102a
update unit tests
ckoegel Nov 3, 2026
aa864cf
update smoke test
ckoegel Nov 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ bandwidth/models/rbm_message_content_rich_card.py
bandwidth/models/rbm_message_content_text.py
bandwidth/models/rbm_message_media.py
bandwidth/models/rbm_open_url_enum.py
bandwidth/models/rbm_session.py
bandwidth/models/rbm_standalone_card.py
bandwidth/models/rbm_suggestion_response.py
bandwidth/models/rbm_web_view_enum.py
Expand Down Expand Up @@ -377,6 +378,7 @@ docs/RbmMessageContentRichCard.md
docs/RbmMessageContentText.md
docs/RbmMessageMedia.md
docs/RbmOpenUrlEnum.md
docs/RbmSession.md
docs/RbmStandaloneCard.md
docs/RbmSuggestionResponse.md
docs/RbmWebViewEnum.md
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,7 @@ Class | Method | HTTP request | Description
- [RbmMessageContentText](docs/RbmMessageContentText.md)
- [RbmMessageMedia](docs/RbmMessageMedia.md)
- [RbmOpenUrlEnum](docs/RbmOpenUrlEnum.md)
- [RbmSession](docs/RbmSession.md)
- [RbmStandaloneCard](docs/RbmStandaloneCard.md)
- [RbmSuggestionResponse](docs/RbmSuggestionResponse.md)
- [RbmWebViewEnum](docs/RbmWebViewEnum.md)
Expand Down
249 changes: 231 additions & 18 deletions bandwidth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2031,6 +2031,7 @@ components:
messageLength:
type: integer
description: The length of the message content.
nullable: true
example: 18
attachmentCount:
type: integer
Expand Down Expand Up @@ -2620,14 +2621,13 @@ components:
type: string
description: Displayed text for user to click
maxLength: 25
example: Hello world
example: Track my order
rbmActionPostbackData:
title: Post Back Data
type: string
format: byte
description: Base64 payload the customer receives when the reply is clicked.
description: Payload the customer receives when the reply is clicked.
maxLength: 2048
example: SGVsbG8gd29ybGQ=
example: track-order-43654
rbmActionBase:
type: object
properties:
Expand Down Expand Up @@ -2916,8 +2916,8 @@ components:
properties:
text:
type: string
description: The text associated with the suggestion response.
example: Yes, I would like to proceed
description: The text of the suggestion the user tapped.
example: Track my order
postbackData:
$ref: '#/components/schemas/rbmActionPostbackData'
pairedMessageId:
Expand All @@ -2938,6 +2938,70 @@ components:
format: double
description: The longitude of the client's location.
example: '-122.4194'
rbmSession:
type: object
description: >-
RCS interactive session information for the message.

An interactive session is a 24-hour window covering all Rich and Rich
Media messages exchanged between an

RCS agent and a specific end user mobile number. It is triggered when at
least 4 messages are exchanged within

24 hours, at least 2 of them mobile-originated and at least 1
mobile-terminated.

Only present on `message-delivered`, `message-received` and
`session-started` callbacks for RBM messages of

US agents with the Conversational billing category. Omitted for all
other messages.
properties:
canInitiate:
type: boolean
description: >-
Whether the message can start an interactive session.

`false` if the message is already part of an active session, or if
the agent is not eligible for

interactive session billing.
example: false
id:
type: string
nullable: true
description: >-
The unique identifier of the interactive session the message is part
of. This is not a message ID.

Omitted if the message is not part of a session.
example: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
type:
type: string
nullable: true
description: |-
The type of the interactive session.
Only present on `session-started` callbacks.
example: INTERACTIVE_SESSION
startTime:
type: string
nullable: true
format: date-time
description: >-
The time the 24-hour session window opened. Only present on
`session-started` callbacks.
example: '2026-08-06T09:59:55Z'
endTime:
type: string
nullable: true
format: date-time
description: >-
The time the 24-hour session window closes. Only present on
`session-started` callbacks.
example: '2026-08-07T09:59:55Z'
required:
- canInitiate
callback:
description: >-
Callbacks are divided into two types based on direction of the related
Expand All @@ -2960,6 +3024,7 @@ components:
message-delivered: '#/components/schemas/statusCallback'
message-failed: '#/components/schemas/statusCallback'
message-read: '#/components/schemas/statusCallback'
session-started: '#/components/schemas/statusCallback'
message-received: '#/components/schemas/inboundCallback'
requested-location-response: '#/components/schemas/inboundCallback'
suggestion-response: '#/components/schemas/inboundCallback'
Expand Down Expand Up @@ -3060,12 +3125,17 @@ components:

- `message-read` indicates that the RBM message was read by the
recipient.

- `session-started` indicates that a previously exchanged RBM message is
now part of an RCS interactive session and is no longer billed
individually.
enum:
- message-sending
- message-sent
- message-delivered
- message-failed
- message-read
- session-started
example: message-delivered
inboundCallbackTypeEnum:
type: string
Expand Down Expand Up @@ -3143,6 +3213,8 @@ components:
$ref: '#/components/schemas/priorityEnum'
channel:
$ref: '#/components/schemas/multiChannelMessageChannelEnum'
session:
$ref: '#/components/schemas/rbmSession'
required:
- id
- owner
Expand Down Expand Up @@ -4876,6 +4948,10 @@ components:
$ref: '#/components/schemas/sipCallId'
sipResponseCode:
$ref: '#/components/schemas/sipResponseCode'
sipStatusLine:
$ref: '#/components/schemas/sipStatusLine'
sipHeaders:
$ref: '#/components/schemas/sipHeaders'
dtmfCallback:
type: object
description: >-
Expand Down Expand Up @@ -5395,6 +5471,12 @@ components:
$ref: '#/components/schemas/errorMessage'
errorId:
$ref: '#/components/schemas/errorId'
sipResponseCode:
$ref: '#/components/schemas/sipResponseCode'
sipStatusLine:
$ref: '#/components/schemas/sipStatusLine'
sipHeaders:
$ref: '#/components/schemas/sipHeaders'
eventType:
type: string
description: >-
Expand Down Expand Up @@ -5710,23 +5792,44 @@ components:
additionalProperties:
type: string
description: >-
(optional) Map of customer-supplied X-* headers from the original
INVITE. Keys are lowercase (SIP headers are case-insensitive). Present
only for inbound SIP URI calls with custom headers. Note - keys preserve
the original SIP header name in lowercase rather than Bandwidth's usual
camelCase JSON convention, since these are passthrough values from the
caller's SIP INVITE, not Bandwidth-defined fields. If the same header
name is sent more than once in the INVITE, only the last value is kept.
(optional) Map of SIP headers, with lowercase keys (SIP headers are
case-insensitive). On the Initiate callback, contains the
customer-supplied X-* headers from the original INVITE; present only for
inbound SIP URI calls with custom headers. On the Disconnect and
Transfer Disconnect callbacks, contains a single `reason` key holding
the raw, unmodified `Reason` header value from the final SIP response
that rejected an outbound call (or transferred leg); present only when
that response included a `Reason` header (for example, `v=analytics1`
call-analytics block information from a terminating carrier). If the
response carries more than one `Reason` header, all values are returned
in the order received, separated by `, `. Note - on the Initiate
callback, keys preserve the original SIP header name in lowercase rather
than Bandwidth's usual camelCase JSON convention, since these are
passthrough values from the caller's SIP INVITE, not Bandwidth-defined
fields. If the same header name is sent more than once in the INVITE,
only the last value is kept. The example shown is for the Initiate
callback; on the Disconnect and Transfer Disconnect callbacks the only
key is `reason`.
example:
x-custom-header: customer-value
x-session-id: sess-12345
sipResponseCode:
type: integer
description: >-
(optional) The SIP status code returned by Bandwidth's SBC when it
rejected an outbound call's INVITE (e.g. 486 for busy, 603 for decline).
Present only when an outbound call was rejected by the SBC.
(optional) The SIP status code of the final response that rejected an
outbound call's (or transferred leg's) INVITE (e.g. 486 for busy, 603
for decline). Present only when the call was rejected with a SIP
response.
example: 486
sipStatusLine:
type: string
description: >-
(optional) The full SIP status line, exactly as received, of the final
response that rejected an outbound call's INVITE. The reason phrase can
help distinguish outcomes that share a status code, such as `603 Network
Blocked` and `603 Decline`. Present only when an outbound call was
rejected with a SIP response.
example: SIP/2.0 603 Network Blocked
codeRequest:
type: object
properties:
Expand Down Expand Up @@ -8878,6 +8981,31 @@ components:
media:
- >-
https://messaging.bandwidth.com/api/v2/users/9900902/media/14762070468292kw2fuqty55yp2b2/0/bw.png
rbmMessageReceivedSessionCallbackExample:
summary: >-
An example of a rbm message-received callback body for a message that is
part of an RCS interactive session.
value:
time: '2026-08-06T10:00:05.502180Z'
type: message-received
to: BandwidthRBM
description: Incoming message received
message:
id: 1786010405502l2ntaoajuqjhqnxu
owner: BandwidthRBM
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
time: '2026-08-06T10:00:05.302180Z'
segmentCount: 1
direction: in
to:
- BandwidthRBM
from: '+12345678902'
channel: RBM
content:
text: Yes, please book it for tomorrow.
session:
canInitiate: false
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
messageSendingCallbackExample:
summary: An example of a message-sending callback body.
value:
Expand Down Expand Up @@ -8977,6 +9105,79 @@ components:
owner: '+12345678902'
direction: out
segmentCount: 1
rbmMessageDeliveredSessionCallbackExample:
summary: >-
An example of a rbm message-delivered callback body for a message that
is part of an RCS interactive session.
value:
type: message-delivered
time: '2026-08-06T10:01:11.160744Z'
description: Message delivered to handset.
to: '+12345678902'
message:
id: 1786010470868ty55yp2b2kw2fuq
time: '2026-08-06T10:01:10.868292Z'
to:
- '+12345678902'
from: BandwidthRBM
text: ''
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
owner: BandwidthRBM
direction: out
segmentCount: 1
channel: RBM
session:
canInitiate: false
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
rbmMessageDeliveredCanInitiateSessionCallbackExample:
summary: >-
An example of a rbm message-delivered callback body for a message that
is not yet part of an RCS interactive session.
value:
type: message-delivered
time: '2026-08-06T09:59:56.160744Z'
description: Message delivered to handset.
to: '+12345678902'
message:
id: 1786010395000kw2fuqty55yp2b2
time: '2026-08-06T09:59:55.000000Z'
to:
- '+12345678902'
from: BandwidthRBM
text: ''
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
owner: BandwidthRBM
direction: out
segmentCount: 1
channel: RBM
session:
canInitiate: true
sessionStartedCallbackExample:
summary: An example of a session-started callback body.
value:
type: session-started
time: '2026-08-06T10:00:00.123000Z'
description: Message is now part of an RCS interactive session.
to: '+12345678902'
message:
id: 1786010395000kw2fuqty55yp2b2
owner: BandwidthRBM
applicationId: 93de2206-9669-4e07-948d-329f4b722ee2
time: '2026-08-06T10:00:00.120000Z'
segmentCount: 1
direction: out
to:
- '+12345678902'
from: BandwidthRBM
text: ''
tag: ''
channel: RBM
session:
canInitiate: false
id: 0f5a3b9c-2d4e-4f6a-8b1c-7e9d0a2b3c4d
type: INTERACTIVE_SESSION
startTime: '2026-08-06T09:59:55Z'
endTime: '2026-08-07T09:59:55Z'
messageFailedCallbackExample:
summary: An example of a message-failed callback body.
value:
Expand Down Expand Up @@ -9980,6 +10181,9 @@ components:
$ref: '#/components/examples/smsMessageReceivedCallbackExample'
mmsMessageReceivedCallback:
$ref: '#/components/examples/mmsMessageReceivedCallbackExample'
rbmMessageReceivedSessionCallback:
$ref: >-
#/components/examples/rbmMessageReceivedSessionCallbackExample
responses:
'200':
description: OK
Expand All @@ -9995,8 +10199,9 @@ components:
information regarding a message sent (MT)

from your message-enabled Bandwidth telephone number.
<p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code> or <code>message-read</code>.
<p>Note that <code>message-read</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
<p>The payload type will be one of <code>message-sending</code>, <code>message-sent</code>, <code>message-delivered</code>, <code>message-failed</code>, <code>message-read</code> or <code>session-started</code>.
<p>Note that <code>message-read</code> and <code>session-started</code> callbacks are pertinent only for RBM messages sent from the <code>/messages/multiChannel</code> endpoint.
<p>Note that <code>session-started</code> callbacks are pertinent only for RBM messages of agents with the Conversational billing category.
</p><p>Please visit <a
href='/docs/messaging/webhooks/'>Webhooks</a></p>
content:
Expand All @@ -10015,8 +10220,16 @@ components:
groupMmsMessageDeliveredCallback:
$ref: >-
#/components/examples/groupMmsMessageDeliveredCallbackExample
rbmMessageDeliveredSessionCallback:
$ref: >-
#/components/examples/rbmMessageDeliveredSessionCallbackExample
rbmMessageDeliveredCanInitiateSessionCallback:
$ref: >-
#/components/examples/rbmMessageDeliveredCanInitiateSessionCallbackExample
messageFailedCallback:
$ref: '#/components/examples/messageFailedCallbackExample'
sessionStartedCallback:
$ref: '#/components/examples/sessionStartedCallbackExample'
responses:
'200':
description: OK
Expand Down
Loading
Loading