diff --git a/conversations/v3/README.md b/conversations/v3/README.md index 7b486fcd..f5c9a02b 100644 --- a/conversations/v3/README.md +++ b/conversations/v3/README.md @@ -1,5 +1,15 @@ # Release notes +## 3.23 +### Changes +#### Add 'businessMessagingLimit' to whatsapp phone number model +Meta has changed the messaging limit model to be business based, see https://developers.facebook.com/docs/whatsapp/messaging-limits/upcoming-changes +The new schema is reflected in this field, 'messagingTier' is now deprecated for the same reason. + +#### Add 'userContext' to whatsapp template model +This field can be used to label/tag/correlate templates. The value can be set on template submission and will be returned as-is on all GET template endpoints + + ## 3.22 ### Changes diff --git a/conversations/v3/whatsapp.yaml b/conversations/v3/whatsapp.yaml index 198e13ac..c0f5887e 100644 --- a/conversations/v3/whatsapp.yaml +++ b/conversations/v3/whatsapp.yaml @@ -18,7 +18,7 @@ info: name: tyntec API Support url: http://www.tyntec.com/support email: support@tyntec.com - version: '3.22' + version: '3.23' x-repository: https://github.com/tyntec/api-collection/blob/master/conversations x-specification-file: whatsapp.yaml x-major-version: v3 @@ -466,7 +466,7 @@ paths: - "Template management" requestBody: description: | - The template patch request. Exactly one out of category and components must be present. + The template patch request. Exactly one out of category, components and userContext must be present. required: true content: application/json: @@ -3481,7 +3481,7 @@ components: - $ref: '#/components/schemas/CPaaSAccount' messagingTier: type: string - description: Which [messaging tier](https://developers.facebook.com/docs/whatsapp/api/rate-limits#messaging) the number is currently on + description: deprecated, see businessMessagingLimit enum: - TIER_NOT_SET - TIER_50 @@ -3490,6 +3490,15 @@ components: - TIER_10K - TIER_100K - UNLIMITED + businessMessagingLimit: + type: string + description: Current business level messaging limit of the number (https://developers.facebook.com/docs/whatsapp/messaging-limits) + enum: + - TIER_250 + - TIER_2K + - TIER_10K + - TIER_100K + - TIER_UNLIMITED qualityScore: $ref: '#/components/schemas/QualityScore' nameStatus: @@ -3566,6 +3575,9 @@ components: To override the default time-to-live when creating an authentication template set this field to value between 60 and 600 seconds. Additionally, set -1 to set time-to-live to message default value. This will set time-to-live to 24 hours (or 30 days for On-Premises API). example: 60 + userContext: + type: string + description: Text field to tag/label this template. If set, will be returned by API on template requests TemplatePatchRequest: type: object description: A request to edit an existing template @@ -3578,6 +3590,9 @@ components: - $ref: '#/components/schemas/NotificationTemplateRequest' - $ref: '#/components/schemas/RichMediaTemplateRequest' - $ref: '#/components/schemas/CarouselTemplateRequest' + userContext: + type: string + description: The desired changed of the userContext property. Empty string will delete userContext NotificationTemplateRequest: type: array description: A request for a standard template (notification) without rich media components @@ -4298,6 +4313,9 @@ components: not yet language: $ref: '#/components/schemas/LanguageCode' + userContext: + type: string + description: String originally set by user when template was submitted components: type: array description: A set of components defining a template