API Migration Information

Summary of changes upgrading or migrating from v1 to v1Beta of the Digital Chat API

Session APIs

• The path has changed (base path and API path).
• The "accountId" has been made mandatory in API path.
• "channelProviderId" which had to be passed while creating engagements has been shifted to "Create Session" API.
• Timestamps have changed from Epoch timestamp (int64) to 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z' format.
• New structure has been implemented to pass customer identifiers such as email address, phone numbers, and so on.
• A few new fields have been added, and a few existing fields have either been renamed or removed in request and response payload to make the data more consistent.
• A detailed comparison of API versions is available here: Session API Version Differences

Engagement APIs

• The path has changed (base path and API path).
• The "accountId" has been made mandatory in API path.
• "channelProviderId", "customerIdentifiers", "participantId" are not required to be provided in Engagement APIs as the values will be derived from session object referenced by "sessionId".
• Timestamps have changed from Epoch timestamp (int64) to 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z' format.
• A few new fields have been added, and a few existing fields have either been renamed or removed in request and response payload to make the data more consistent.
• A detailed comparison of API versions is available here: Engagement API Version Differences

Notification APIs

• The path has changed (base path and API path).
• The "accountId" has been made mandatory in API path.
• "channelProviderId" which had to be passed as path parameter is now a part of request payload.
• Timestamps have changed from Epoch timestamp (int64) to 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z' format.
• Earlier each webhookId could have multiple subscriptions. Now each subscription can be directly accessed by using subscriptionId.
• A few new fields have been added, and a few existing fields have either been renamed or removed in request and response payload to make the data more consistent.
• A detailed comparison of API versions is available here: Webhook API Comparison