Provisioning API Release Notes
See how the Provisioning API is evolving and find out about new features and bug fixes.
1.0.74
2024-09-05
Common
- Improvement of services
1.0.73
2024-09-04
Common
- Improvement of services
RCS
-
Provisioning API for
RCS
service is Closed Beta.
1.0.72
2024-09-02
Common
- Improvement of services
1.0.71
2024-08-28
Common
- Improvement of services
1.0.70
2024-08-26
Common
- Improvement of services
1.0.69
2024-08-19
Common
- Improvement of services
1.0.68
2024-08-12
Common
- Improvement of services
1.0.67
2024-08-05
Added
-
[
PROAPI-951
] - Added new optional fieldmessageSendTtlSeconds
for authentication template. (| #1461 )
Bundles
-
Provisioning API for
Bundles
service is GA.
KakaoTalk
-
Provisioning API for
KakaoTalk
service is GA.
Changed
-
[
PROAPI-1641
] - RemovedUpdates a sender in project
endpoint. (| #1438 )
1.0.66
2024-07-24
Added
-
[
PROAPI-1479
] - Added optionalmetaLocalStorage
properties. If not provided metaLocalStorage will be automatically selected based on region. If not provided region will be automatically selected based on the country for billing address. (| #1402 )
1.0.65
2024-07-19
Common
- Improvement of services
1.0.64
2024-07-18
Common
- Improvement of services
1.0.63
2024-07-15
Breaking Changes
-
Removed the
Get a temporary URL for Facebook login
endpoint. Recent changes regarding the Embedded Signup flow for Meta has made the endpoint redundant. Please refer to the Getting started guide for Embedded Signup for an updated flow.
New features
- Verify if Meta Template Analytics is enabled for the WhatsApp Business Account.
Deprecated
-
Deprecated field
tpsPlan
for get sender endpoint.
Added
-
[
PROAPI-1573
] - AddedmaxTps
field to maximum tps, on get sender endpoint. (| #1401 ) -
[
PROAPI-1456
] - AddedwabaEnabledForInsights
field to show status for Meta Template Analytics, on get account endpoint. (| #1389 )
Changed
-
Deprecated field
tpsPlan
for get sender endpoint. -
Removed
Get a temporary URL for Facebook login
endpoint.
1.0.62
2024-07-08
Common
- Improvement of services
1.0.61
2024-06-28
Added
-
Added
WHATSAPP_TEMPLATE_CATEGORY_UPDATED
webhook trigger. -
Added available value
REINSTATED
for optionalnewState
field for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATED
type.
1.0.60
2024-06-24
Added
-
Added readonly field
compatibleRegions
to endpointsGet account for project
andGet sender for project
. This field can be used to determine which Conversation API regions the sender is compatible with.
Changed
- Fixed bug sometimes showing wrong order of template components.
-
Changed to optional
region
properties in request body for endpoint:Create sender for project
. If not provided region will be automatically selected based on the country for billing address.
1.0.59
2024-06-17
Common
- Improvement of services
1.0.58
2024-06-10
Common
- Improvement of services
1.0.57
2024-06-03
Bundles
Added
-
Added trigger for conversation app:
MESSAGE_INBOUND_SMART_CONVERSATION_REDACTION
. -
Added statuses for sms app:
PROVISIONING_ADD
,PROVISIONING_UPDATE
,PROVISIONING_ADD_FAILED
andPROVISIONING_UPDATE_FAILED
.
KakaoTalk
Added
- Added list sender categories endpoint.
Deprecated
-
Deprecated
Get a temporary URL for Facebook login
endpoint. New Meta registration flow with solution id makes this endpoint redundant.
Added
-
Added optional
businessManager
properties in request body for WhatsApp endpoints:List WhatsApp Business Accounts details
,Create a long lived access token
,Create account for project
,Create sender for project
and query parameter forGet a temporary URL for Facebook login
. If not provided businessManager will be automatically selected based on the country for billing address. -
Added new value for
errorCode
for senderSENDER_HAS_BEEN_DELETED
.
Changed
- Allow 2 URL Call To Action template buttons instead of 1.
- Add a constraint on template buttons to ensure that Quick Reply and Call To Action buttons are listed as 2 separate groups
- Increase number of supported template buttons from 3 to 10 in marketing template.
-
Deprecated
Get a temporary URL for Facebook login
endpoint.
1.0.56
2024-05-30
Breaking Changes
- Reducing the size of the header example for image from 16MB to 5MB.
Deprecated
-
Deprecated fields
wabaBanState
andwabaBanDate
for get sender endpoint. Get account endpoint should be used to get this information.
Added
-
Added
WHATSAPP_TEMPLATE_QUALITY_SCORE_UPDATED
webhook trigger.
Changed
-
Removed available value
REINSTATED
for optionalnewState
field for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATED
type. -
Align media header example file mime types and max sizes in accordance with the META documentation:
DOCUMENT
- 100MB andtext/plain, application/pdf, application/vnd.ms-powerpoint, application/msword, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
mime types,IMAGE
5MB andimage/jpeg, image/png, image/webp
mime types,VIDEO
- 16MB andvideo/mp4, video/3gp
mime types. -
Deprecated fields
wabaBanState
andwabaBanDate
for get sender endpoint. Get account endpoint should be used to get this information.
1.0.55
2024-05-20
Common
Changed
- Updated detecting mime type for file url.
Added
- Added Template Analytics to the list templates and list templates by name endpoints.
- Added query parameter for template analytics date range to get template endpoint.
- Added Template Analytics to the update template endpoint.
1.0.54
2024-05-13
Common
- Improvement of services
1.0.53
2024-05-06
KakaoTalk
Added
-
Added
KAKAOTALK_SENDER_COMMENT_ADDED
webhook trigger. -
Added
KAKAOTALK_SENDER_REJECTED
webhook trigger.
1.0.52
2024-04-30
KakaoTalk
Added
-
Added
KAKAOTALK_SENDER_INACTIVE
webhook trigger.
Added
- Added endpoint to enable Template Analytics.
1.0.51
2024-04-22
New features
- Get number of times templates have been sent, delivered, read and clicked when using get template endpoint, based on Meta template analytics.
Added
-
Added field
previousPageToken
to all list endpoints. -
Added
qualityScore
property for templateQUALITY_SCORE_GREEN
,QUALITY_SCORE_YELLOW
,QUALITY_SCORE_RED
,QUALITY_SCORE_UNKNOWN
andUNRECOGNIZED
. -
Added
analytics
to get template endpoint.
Changed
-
[
PROAPI-1274
] - Removed optionalcloudApi
flag from theCreate sender for project
request body when sender is of Embedded Signup type. A sender is now created as hosted in WhatsApp Cloud API by default. -
Changed page max size to 1000 for endpoint
list all templates in project
.
KakaoTalk
Added
-
Added field
previousPageToken
to endpointlist all senders in project
. -
Added field
previousPageToken
to endpointlist all categories in project
. -
Added field
previousPageToken
to endpointslists activities on project template
andlists activities on sender
. -
Added field
previousPageToken
to endpointlist all templates in project
.
Changed
-
Removed
KAKAOTALK_TEMPLATE_DELETED
webhook trigger because it's redundant. -
Changed page max size to 1000 for endpoint
list all templates in project
.
RCS
Added
-
Added field
previousPageToken
to endpointslist all senders in project
andlists activities on sender
.
Webhooks
Added
-
Added field
previousPageToken
to endpointlist all webhooks in project
.
1.0.50
2024-04-15
Changed
-
Fix validation for template
name
to 512 characters.
1.0.49
2024-04-08
Common
- Improvement of services
1.0.48
2024-04-02
Common
Removed
-
Removed
v1alpha1
andv1alpha2
endpoints.
Changed
-
Removed
businessManager
properties from request body for WhatsApp endpoints:List WhatsApp Business Accounts details
,Create a long lived access token
,Create account for project
,Create sender for project
and query parameter forGet a temporary URL for Facebook login
. Currently, businessManager will be automatically selected based on the country for billing address. -
Removed
region
from query parameter forGet a temporary URL for Facebook login
.
KakaoTalk
Added
-
Added
KAKAOTALK_TEMPLATE_COMMENT_ADDED
webhook trigger.
1.0.47
2024-03-25
Common
- Improvement of services
1.0.46
2024-03-18
KakaoTalk
Added
-
Added
KAKAOTALK_TEMPLATE_DELETED
webhook trigger. -
Added
KAKAOTALK_TEMPLATE_REJECTED
webhook trigger. -
Added
KAKAOTALK_TEMPLATE_APPROVED
webhook trigger.
1.0.45
2024-03-11
New Features
-
Added optional properties if waba is banned;
wabaBanState
andwabaBanDate
.
Added
-
Added optional properties if waba is banned -
wabaBanState
-DISABLE / REINSTATE / SCHEDULE_FOR_DISABLE / UNRECOGNIZED
andwabaBanDate
.
Changed
-
Fixed
WHATSAPP_TEMPLATE_DELETED
webhook trigger.
1.0.44
2024-03-04
Bundles
Added
-
Added Brazil (
BR
) region.
1.0.43
2024-02-26
Common
- Improvement of services
1.0.42
2024-02-19
Common
- Improvement of services
1.0.41
2024-02-12
Common
- Improvement of services
1.0.40
2024-02-09
New features
-
Allowing
SINCH_UK
business manager to be used for cloud api senders in EU region.
Added
-
Allowing
SINCH_UK
business manager to be used for both cloud api senders in EU region.
1.0.39
2024-02-06
Common
- Improvement of services
1.0.38
2024-02-01
Common
-
Provisioning API for
WhatsApp
andWebhook
services is GA.
1.0.37
2024-01-31
KakaoTalk
Changed
- Fixed broken endpoint to update sender.
1.0.36
2024-01-22
KakaoTalk
New Features
- Added new endpoint to delete pending or rejected changes to a sender.
- Added endpoint to create sender comments.
- Added new endpoint to edit existing senders.
Added
- Added endpoint to delete sender changes.
- Added endpoint to create sender comments.
- Added endpoint to update sender.
New Features
-
Added
facebookCode
for create sender and create long lived access token. -
Added new query parameter
type
to get login url endpoint. -
Added optional
newState
field for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATED
type.
Added
-
Added
facebookCode
parameter to createSender endpoint. -
Added
facebookCode
parameter to longLivedAccessToken endpoint. -
Added parameter
type
(ACCESS_TOKEN / CODE
) to get login endpoint. Default value:ACCESS_TOKEN
. This parametertype
will be removed 1st of February and response will be as for ype equalsCODE
. -
Added optional
newState
field for webhook payload forWHATSAPP_TEMPLATE_STATUS_UPDATED
type. Available values:DISABLED
,PAUSED
,REINSTATED
andUNPAUSED
.
Changed
-
Fixed "List all stickerpacks for sender" endpoint,
pageToken
andpageSize
shouldn't be required parameters.
1.0.35
2023-12-21
Common
- Improvement of services
1.0.34
2023-12-19
RCS
New Features
-
Including
status
in body when creating a sender is optional. Logically it will default to submit if not provided.
Changed
-
Creating senders without providing
status
will default to submit.
New Features
- Added new endpoints to create, update, delete stickerpack.
- Added new endpoints to create, update, delete sticker.
-
Including
status
in body when creating a template is optional. Logically it will default to submit if not provided. -
Including
status
in body when creating a sender is optional. Logically it will default to submit if not provided. - Allowing Brazil business manager to be used for cloud api senders in BR region.
- Allowing Mexico business manager to be used for on premise and cloud api senders in BR region.
Added
- Added stickerpack create endpoint.
- Added stickerpack update endpoint
- Added stickerpack delete endpoint.
- Added sticker create endpoint.
- Added sticker update endpoint
- Added sticker delete endpoint
- Added sticker index validation.
- Allowing Brazil and Mexico business manager to be used for both on premise and cloud api senders in BR region.
Changed
-
Fixed validation for missing
example
forHEADER
andexamples
forBODY
components. -
Creating templates without providing
status
will default to submit. -
Creating senders without providing
status
will default to submit. - Improved parser for submit template errors from Meta.
- Fixed stickerpacks endpoints.
- Changed list stickers to return empty array instead of throw error.
KakaoTalk
New Features
-
Including
status
in body when updating a template is optional. Logically it will default to draft if not provided. -
Including
status
in body when creating a sender is optional. Logically it will default to submit if not provided. -
Including
status
in body when creating a template is optional. Logically it will default to submit if not provided. - Added English names for template categories.
Added
-
Added field
nameEnglish
to categoryDto and subcategoryDto for endpoint list of categories.
Changed
-
Improved validation for methods create and update template with status
draft
. - Improve validation of category code when creating new sender.
-
Updating templates without providing
status
will default to draft. -
Creating senders without providing
status
will default to submit. - Improved validation for create and update template endpoints.
-
Creating templates without providing
status
will default to submit. - Improved validation of name length when creating a new sender.
0.1.33
2023-11-20
Changed
- Changed create and update template endpoints which can return auto approved or auto rejected template after submit. If webhook is registered, it will be send.
0.1.32
2023-11-08
Changed
-
Fixed
WHATSAPP_TEMPLATE_REJECTED
webhook trigger.
0.1.31
2023-11-07
Common
New Features
-
With this release we have added the
v1
endpoints. These are based on thev1alpha2
endpoints and should therefore be an easy migration in that case.
Deprecated
-
The
v1alpha1
endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date. To migrate fromv1alpha1
tov1alpha2
orv1
, please follow the migration guide . -
The
v1alpha2
endpoints are now considered deprecated and will be removed when we see no use of them anymore or at a future communicated date. To migrate fromv1alpha2
tov1
, please follow the migration guide .
Added
- Added v1 endpoints.
Breaking Changes
-
The output for authentication templates is updated to not contain fields that are not valid for this category. Fields that have been removed are
text
andexamples
in body and footer components. The change is only applied tov1alpha2
andv1
. -
The previously deprecated field
v1payload
in WhatsApp webhooks have now been removed.
Changed
-
Fixed
WHATSAPP_TEMPLATE_APPROVED
webhook trigger. - Removed fields from output that are not valid for authentication templates.
-
Default value for field
status
equalsSUBMIT
for update sender endpoint. - Removed deprecated v1payload from webhooks.
- Improved errors for create template, when message footer format is incorrect.
- Improved errors for create template, when WhatsApp business account is restricted from creating new templates.
KakaoTalk
New Features
- Added new endpoint for update existing template.
- Added new endpoint to create sender.
Added
- Added endpoint to update template.
- Added new endpoint to create sender.
Changed
- Fixed showing the change request status even if there are no changes requested.
0.1.30
2023-10-12
New Features
- Endpoints for retrieving WhatsApp sticker packs for a sender. Can be requested for different namespaces, WhatsApp (first-party) or user (third-party) maintained.
Breaking Changes
- When attempting to update a template in a non-updatable state, the error will correctly reflect this. Previously the same error was shown for non-updatable template state and non-updatable template draft status, providing an incorrect resolution.
- When attempting to update a template draft with a non-updatable status, the error will correctly reflect this. Previously the same error was shown for non-updatable template state and non-updatable template draft status, providing an incorrect resolution.
Added
-
Added optional query
namespace
to stickerpack endpoints.
Changed
- Split error for not updatable template into different errors depending on if it was caused by template in a non-updatable state, or template draft with a non-updatable status. ( 820 )
0.1.29
2023-10-09
Added
- Added new list endpoint for stickerpacks.
- Improved errors for create template for message body format incorrect.
0.1.28
2023-10-03
Changed
- Restore old template languages for v1alpha1.
-
Fixed
WHATSAPP_TEMPLATE_DELETED
webhook trigger.
0.1.27
2023-10-03
Changed
- Fixed issue where a template with a draft change with no changes was not showing up in changes field.
0.1.26
2023-10-02
KakaoTalk
New Features
-
Added query parameters:
filterStates
andfilterStatuses
for senders and templates.
Breaking Changes
- When attempting to delete a change to a template, if no template draft can be found then the 404 error now explains that no pending changes for the template was found. Previously the error would claim that the template itself wasn't found.
-
Removed query parameters:
sortColumn
,sortDirection
,templateStatus
andsenderState
. -
Replaced values for
status
-draft / submit
byDRAFT / SUBMIT
. - Replaced values for enums to upper case.
Added
-
Added optional
saveDraftOnFailure
flag to save obo sender if submission fails. Defaults to false. -
Added query parameters:
filterStates
andfilterStatuses
for senders and templates. Can be given multiple enum values separated using comma. -
Added optional
saveDraftOnFailure
flag to save template if submission fails. Defaults to false. - Added endpoint to remove template from project.
Changed
-
Remove query parameters:
sortColumn
,sortDirection
,templateStatus
andsenderState
. -
Change values for
status
field sender and template request toDRAFT / SUBMIT
. - Change values for enums to upper case.
- Updated error message when no template draft was found when trying to remove.
New Features
-
Added query parameters:
filterStates
andfilterStatuses
for senders and templates.
Breaking Changes
- When attempting to delete a change to a template, if no template draft can be found then the 404 error now explains that no pending changes for the template was found. Previously the error would claim that the template itself wasn't found.
-
Changed default value for flag
saveDraftOnFailure
tofalse
in create template endpoint. -
Removed query parameters:
sortColumn
,sortDirection
,templateState
andsenderState
. -
Replaced values for
status
-draft / submit
byDRAFT / SUBMIT
. - Replaced values for enums to upper case.
Added
-
Add
WHATSAPP_TEMPLATE_DELETED
webhook trigger. - Added new compare templates endpoint.
-
Added query parameters:
filterStates
andfilterStatuses
for senders and templates. Can be given multiple enum values separated using comma. - Added new get endpoint to retrieve list of stickers from a stickerpack for a sender.
- Added new get endpoint to retrieve sticker from a stickerpack for a sender.
Changed
- Fixed issue where a template with a draft change with no changes was not showing up in changes field.
- Updates WhatsApp sender description in details to 512 characters.
-
Removed query parameters:
sortColumn
,sortDirection
,templateState
andsenderState
. -
Change values for
status
field sender and template request toDRAFT / SUBMIT
. - Change values for enums to upper case.
- Improved errors when creating templates.
- Updated error message when no template draft was found when trying to remove.
-
Changed default value for optional flag
saveDraftOnFailure
tofalse
in create template endpoint.
RCS
New Features
-
Added query parameters:
filterStates
andfilterStatuses
for senders and templates.
Breaking Changes
-
Removed query parameters:
sortColumn
,sortDirection
andsenderState
. -
Replaced values for
status
-draft / submit
byDRAFT / SUBMIT
. - Replaced values for enums to upper case.
Added
-
Added query parameters:
filterStates
andfilterStatuses
for sender. Can be given multiple enum values using comma.
Changed
-
Removed query parameters:
sortColumn
,sortDirection
andsenderState
. -
Change values for
status
field sender request toDRAFT / SUBMIT
. - Change values for enums to upper case.
0.1.25
2023-09-14
KakaoTalk
Added
- Added endpoint to remove template drafts.
New Features
- Added Mexico business manager for US region.
- Allowing Brazil business manager to be used for on premise senders in BR region.
Changed
-
Changed validation:
components
are optional for template draft.
Added
-
Added
SINCH_MX
business manager for US region. - Allowing Brazil business manager to be used for on premise senders in BR region.
0.1.24
2023-09-11
KakaoTalk
Added
- Added endpoint to get list of template activities.
- Added endpoint to create template comment.
New Features
-
Fields
about
andphotoUrl
are made optional. -
Added new values for sender tpsPlan -
XXLARGE
andXXXLARGE
.
Changed
-
Changed
about
andphotoUrl
for sender properties to optional.
Added
- Added new get endpoint to retrieve stickerpack for a sender.
-
Added new values for sender tpsPlan -
XXLARGE
andXXXLARGE
.
0.1.23
2023-08-28
Added
-
Added new status
DISABLED
for templates. Allow editingDISABLED
status.
KakaoTalk
Added
- Added endpoint to get list of categories for template.
0.1.22
2023-08-07
Common
- Improvement of services
0.1.21
2023-07-10
Changed
- Return an error if the combination of deployment region, sender type and business manager is not valid. See sender creation endpoint for current valid combinations.
- Added Brazil deployment region.
- Remove unsupported SA, AS and AU regions.
-
Removed deprecated field
value
for buttons components in templates. - Fixed deletion of edited templates in APPROVED or PAUSED statuses.
KakaoTalk
Added
- Added endpoint to create KakaoTalk templates.
RCS
Changed
-
Changed inverted dimensions for rcs sender banner - height
448 px
and width1440 px
.
0.1.20
2023-06-28
Changed
- Fixed file uploading for update template.
0.1.19
2023-06-21
Changed
- Corrected the response for the edited sender.
0.1.18
2023-06-19
Added
- Added version 2 for templates.
-
Added Message Template header type
LOCATION
.
Telegram
Changed
-
A telegram channel with no followers unexpectedly threw an error. It now correctly returns
0
followers.
0.1.17
2023-06-01
Changed
-
Fixed deleting templates for
IN_PROGRESS
state.
0.1.16
2023-05-26
Breaking changes
-
Rename
errorMessage
torejectionCode
in template.
Changed
-
Renamed
errorMessage
torejectionCode
in template.
0.1.15
2023-05-26
New Features
- Add new fields for authentication template.
-
Add
errorMessage
field if template is rejected. -
Allow editing
APPROVED
andPAUSED
template.
Added
- Added otp button.
-
Added new field
codeExpirationMinutes
in footer component dto. -
Added
errorMessage
field to template. Possible values:ABUSIVE_CONTENT
,INCORRECT_CATEGORY
,INVALID_FORMAT
,NONE
,SCAM
,UNRECOGNIZED
. The field is only populated ifstatus
isREJECTED
and contains the rejection reason from Meta. -
Added new field
addSecurityRecommendation
in body component dto. -
Allow editing
APPROVED
andPAUSED
templates.
Changed
-
text
property for body and footer component are optional because ofAUTHENTICATION
category.
0.1.14
2023-05-25
Common
Breaking changes
-
For error bad request error (400,
invalid_input
) texts invalidationErrors
are changed. These should not be used for validation errors to the end user and are primarily intended to be used for debugging.
Changed
- Updated validation errors message to fix some grammatical errors. All enum fields will now specify which enums are valid.
New features
-
Add new field to template
allowCategoryChange
which is allowing Meta to change the template category
Added
-
Added optional
allowCategoryChange
field to template creation. -
Added optional
wabaId
for account endpoints responses.
Bundles
Changed
-
Removed
ML_INTENT_SENTIMENT_ANALYSIS
from conversation webhooks triggers. -
Removed
UNSPECIFIED_TRIGGER
andUNRECOGNIZED
from input bundles conversation webhooks triggers.
0.1.13
2023-05-16
Added
-
Added new field
errorCode
for sender. Possible values:-
NOVA_ACCOUNT_ID_CONFLICT
-
NO_NOVA_ACCOUNT_ID
-
PROJECT_ID_CONFLICT
-
NO_PROJECT_ID
-
CANNOT_ASSIGN_CREDIT_LINE
-
CANNOT_SUBSCRIBE_TO_WEBHOOK
-
NO_PRICING_PLAN
-
CANNOT_ASSIGN_SYSTEM_USER
-
NO_VERIFIED_PHONE_NUMBER
-
CANNOT_GET_WABA_DETAILS
-
MULTIPLE_WABA_FOR_PROJECT_ID
-
NOT_VERIFY_BUSINESS_VIA_WHATSAPP
-
CANNOT_CREATE_NEW_WHATSAPP_BOT
-
CANNOT_REGISTER_NEW_WHATSAPP_BOT
-
FAILED_TO_FETCH_APPROVED_MESSAGE_TEMPLATES
-
NOT_VERIFIED_REQUESTED_PHONE_NUMBER
-
DUPLICATES_ON_SENDER_PHONE_NUMBER
-
CANNOT_CREATE_WABA_FOR_BUSINESS
-
CANNOT_SUBSCRIBE_TO_CLOUD_API
-
CANNOT_GET_DETAILS_FOR_CLOUD_API
-
CANNOT_REGISTER_TO_CLOUD_API
-
UNKNOWN_ERROR
-
NO_CERTIFICATE_AVAILABLE
-
UNRECOGNIZED
-
errorReason
returns a string with error details
-
0.1.12
2023-04-26
Deprecated fields
-
Add
text
property for buttons components which replacesvalue
property.text
should be used.value
will be removed June 1, 2023.
Breaking Changes
-
The
state
field for account is returned only if the account is created. -
Available
state
values for account -ONBOARDED
,PENDING_FACEBOOK_VERIFICATION
,REJECTED
.
Added
-
Remove
NOT_REGISTERED
andREQUEST
forstate
in account response. Available only:ONBOARDED
,PENDING_FACEBOOK_VERIFICATION
,REJECTED
. -
state
for get account is optional. -
Add
text
property for buttons components which replacesvalue
property.value
is deprecated and will be removed in a future update
0.1.11
2023-04-05
Added
-
Add
WHATSAPP_SENDER_DAILY_LIMIT_CHANGED
,WHATSAPP_SENDER_QUALITY_RATING_CHANGED
andWHATSAPP_TEMPLATE_STATUS_UPDATED
webhook trigger.
KakaoTalk
Changed
-
Fixed missing
created
andmodified
date for template.
0.1.10
2023-03-27
Breaking Changes
-
Only new template categories allowed:
AUTHENTICATION
,MARKETING
andUTILITY
from April 3, 2023
Added
-
Added new template categories
AUTHENTICATION
,UTILITY
. -
Added new template status
PAUSED
.
Changed
- Improve errors for create long lived access token endpoint.
0.1.9
2023-03-13
KakaoTalk
Added
- Added list endpoint for sender.
- Added get endpoint for sender.
- Added endpoint to get and list templates.
Breaking Changes
-
Renamed
facebookManagerId
toclientBusinessManagerId
-
Only new template categories allowed:
TRANSACTIONAL
,MARKETING
andOTP
-
Removed endpoint to list account, sender and template activity (
*/activity
)
Added
-
Added endpoint to list account, sender and template activities (
*/activities
).
Changed
- Improve errors for list WABA and create long lived access token endpoint.
-
Rename
facebookManagerId
toclientBusinessManagerId
. -
Allow new template categories when creating templates:
TRANSACTIONAL
,MARKETING
andOTP
. -
Removed endpoint to list account, sender and template activity (
*/activity
). -
*/activity
endpoints are deprecated.
0.1.8
2023-02-28
Bundles
Added
-
Added current
state
field for bundle response.
Changed
- Fixed triggering webhook if conversation app had set sms credentials.
0.1.7
2023-02-08
Changed
- Additional validation of the phoneNumberId used to create the ES.
- Improve errors for list WABA and create long lived access token endpoint.
0.1.6
2023-02-07
New features
- Added capability to specify which Facebook Business Manager to use when getting temporary login url.
Added
- Improved returned errors for endpoints: create a long lived access token and list WhatsApp Business Accounts details.
-
Added optional
businessManager
to get temporary URL for Facebook login.
0.1.5
2023-01-31
New features
- Added capability to specify which Facebook Business Manager to use when creating an account or sender.
Added
-
Added optional
businessManager
to Account and Embedded Signup Sender creation.
Changed
-
Fixed webhook for
WHATSAPP_TEMPLATE_COMMENT_ADDED
. -
Fixed webhook for
WHATSAPP_ACCOUNT_COMMENT_ADDED
. - Fixed fetching template / senders.
RCS
Breaking changes
-
Change the following trigger values:
-
RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED
->RCS_SENDER_COMMENT_ADDED
-
RCS_SENDER_CHANGE_REQUEST_REJECTED
->RCS_SENDER_REJECTED
-
RCS_SENDER_CHANGE_REQUEST_DONE
->RCS_SENDER_CREATED
-
Added
- Added validation for sender.
Changed
-
Change values for webhook trigger:
RCS_SENDER_CHANGE_REQUEST_COMMENT_ADDED
->RCS_SENDER_COMMENT_ADDED
,RCS_SENDER_CHANGE_REQUEST_REJECTED
->RCS_SENDER_REJECTED
andRCS_SENDER_CHANGE_REQUEST_DONE
->RCS_SENDER_CREATED
.
Webhook
New features
-
Added optional
comment
field for webhook payload.
Added
-
Add values for
comment
field for webhook payload.
Conversation
Breaking Changes
The channel information will now contain a field status
which will be the underlying Conversation API channel status. If the call to the relevant API fails for some reason, the status will be displayed as ERROR
. For both ERROR
and FAILED
there will be a value in the statusDescription
field explaining the reason. Unlike previously, the channel information will only be populated if the status is ACTIVE
.
Changed
- Update all channel endpoints to contain Conversation API channel status. Unless the status is ACTIVE, the channel information will not be displayed.
0.1.4
2023-01-16
New features
- Added filtering and sorting for list senders.
-
Added returned values for
qualityRating
anddailyLimit
.
Breaking changes
-
Changed response http code to
201
for:- create login
- create template
-
If no list activity for sender / template /account it will be return empty array. Previous it was returned
404
error.
Added
-
Add values for
qualityRating
:GREEN
,RED
,YELLOW
and fordailyLimit
:NOT_SET
,TIER_50
,TIER_250
,TIER_1K
,TIER_10K
,TIER_100K
,TIER_UNLIMITED
. -
Add query options for listSenders - filter by
senderState
, sort byname
,state
,created
,modified
and sort directionasc
anddesc
.
Changed
-
Fixed returning
changes
after sender update. -
Fixed returning
created
andmodified
dates for sender. -
Change http status code to
201
for WhatsApp create login endpoint and create template endpoint. -
Fixed filtering by
templateStatus
. -
Changed fit if
photoUrl
for sender image is too big tocover
. -
Changed restricted domains for url button:
facebook.com
,fbcdn.net
,tfbnw.net
,instagram.com
,wa.me
,whatsapp.com
. - Improve validation for example button - is only allowed for dynamic url.
- Return empty array of notifications for list activity if no exist.
Conversation
Breaking Changes
Instagram channel information has changed to show new values. Previous implementation erroneously showed the same information as Facebook Messenger senders.
Changed
- Updated Instagram channel information endpoint to show real Instagram values.
RCS
New features
- Added filtering and sorting for list senders.
- Added list of supported countries for suppliers.
-
Added endpoints:
- create sender comment.
- list sender activity.
Added
-
Add query options for listSenders - filter by
senderState
, sort byname
state
,created
,modified
and sort directionasc
anddesc
. -
Add supported supplier countries:
BR
,CA
,DE
,ES
,FR
,GB
,IE
,IN
,KW
,MX
,NG
,NL
,NO
,PL
,US
. - Added descriptions for RCS sender API.
- Added endpoint to create sender comment.
- Added endpoint to list sender activity.
Changed
-
Fixed returning
created
andmodified
dates for sender. - Return empty array of notifications for list activity if no exist.
-
Fixed get sender and list senders - filter by
projectId
.
Bundles
Breaking Changes
-
Changed response http code to
201
for create bundles.
Changed
-
Change http status code to
201
for bundles create endpoint.
Webhooks
Breaking Changes
-
Changed response http code to
201
for create webhooks.
Changed
-
Change http status code to
201
for webhooks create endpoint.
0.1.3
2022-12-20
Added
-
Added
isEmbeddedSignup
for Account response. Based on this value, it can be determined whether the account was created using Embedded Signup or On Behalf of.
Changed
-
Increased the allowed length for sender
about
field from 128 to 139 characters.
0.1.2
2022-12-13
Common
New features
-
Added
x-b3-traceid
in response headers. All responses, if request contains valid authorization headers, will return the header. This can be used when reporting errors or problems in the functioning of the API. -
All errors, if request contains valid authorization headers, has
content-type: application/json
and body witherrorCode
,message
,resolution
.
Added
-
Added
x-b3-traceid
in headers if request is proxying to microservices.
Changed
- Changed all error responses to JSON Error format.
New features
- This release adds the possibility to create an Embedded Signup sender which will be hosted on the WhatsApp Cloud API from creation.
Breaking Changes
-
Dropped support for WA Standalone API. All senders are now created to be used with Conversation API. The sender endpoints will have the two following changes:
-
Removed
conversationApiEnabled
as it now will always betrue
. -
Removed
callbackUrl
as the callback will be set internally though Conversaiton API.
-
Removed
-
Create comment endpoint for all resources have the fields
id
,modified
,user
removed. The response will now be the same format as the list activities endpoints.
Added
- Added an optional flag to set up the sender for cloud api if it's embedded signup.
Changed
-
Removed
id
,modified
,user
from create comment response. -
Removed flag
conversationApiEnabled
when creating sender. - Fixing listSenders endpoint - adding missing internal pagination.
-
Removed sender
callbackUrl
for OBO sender. Changed sender details. - Limited sender state for update sender has to be update.
-
Until Sender is not
ACTIVE
showing data inchanges
. - Fixed a bug where direct enterprise customers could not see resources if having multiple projects.
- Fixed a bug on creation message template if examples is empty array.
RCS
RCS is currently in active development. This release contains pre-release functionality and can be requested to trial it.
Added
- Added endpoint to list senders.
- Added endpoint to creating sender.
- Added endpoint to fetching sender.
0.1.1
2022-11-14
Breaking Changes
-
Template have one breaking changes:
-
whatsappId
field would previously return an empty string if not set. Field will now not be set.
-
Changed
-
Hide
whatsappId
if there is no value. - Update documentation to clarify which regions are supported for senders.
- Fixed remove sender photo url.
-
Fixed sender
callbackUrl
for OBO sender ifconversationApiEnabled
equalsfalse
.
Conversation
New features
Added new endpoints to query Instagram and Facebook Messenger information for a Conversation Api App which has those channels configured. Channel information is now supported for Instagram, Messenger, Telegram and Viber Bots.
Added
- Added endpoint to query Instagram channel information for a Conversation Api App.
- Added endpoint to query Facebook Messenger channel information for a Conversation Api App.
0.1.0
2022-11-09
New features
WhatsApp On Behalf of Senders
This release adds the possibility to create On Behalf Of (OBO) senders. Previously senders had to be created through the Embedded Signup (ES) process.
Creating a OBO sender requires more steps than a ES sender. The process should follow the following steps:
- Create a new account. Unlike ES an account will need to be created first. This will allow Sinch to create a WABA under the Facebook Manager Id specified.
- Authorize Sinch to manage the WABA on behalf of the end user and wait for the account to be onboarded.
- Create a new OBO sender. Once the account is onboarded a sender can be created for the project.
- If using a customer provided phone number: Trigger registration and verification of the phone number.
Both types of sender are the same once onboarded. Template creation is the same process for both types.
Once a project has created either a ES or OBO sender, it is not possible to create the other type for the same project. If attempting to create an OBO sender in a ES project, an error code will be returned and vice versa.
Breaking Changes
-
Activity lists for all resource types have the following changes:
-
Updated
type
field enum to reflect the status of the resource type. -
Removed
createdBy
andmodifiedBy
fields. These fields referenced internal users not usable by an API user. -
Removed
description
andtitle
fields from activity list. These fields contained parsed english strings. Users should use thetype
fields.
-
Updated
-
Sender details have the following breaking changes:
-
Region enum values has changes. Previous enum listed values as
EUROPE
,AMERICA
,ASIA
,AUSTRALIA
andSOUTH_AMERICA
. New values are respectivelyEU
,US
,AS
,AU
andSA
. OnlyEU
andUS
are currently supported for creating senders. -
Number provider type has moved from
details.numberProvider
tonumberProvider
in the sender object. -
The sender detail fields would previously return an empty string if not set. The following fields will now not be set instead:
description
,email
,address
,websiteOne
,websiteTwo
,callbackUrl
.
-
Region enum values has changes. Previous enum listed values as
-
Webhook triggers:
-
Previously a trigger
WHATSAPP_TEMPLATE_IN_PROGRESS
existed in the allowed webhook triggers. This trigger has been removed as the In Progress state is a user initiated transition. -
Webhook trigger
WHATSAPP_TEMPLATE_DELETED
did not work as intended. It has been removed temporarily and will be added in a future version when fully working.
-
Previously a trigger
Added
-
Added sender
callbackUrl
for OBO sender. Changed sender details. -
Add flag
conversationApiEnabled
when creating a OBO sender. -
Add optional
saveDraftOnFailure
flag to delete template if submission fails. Defaults to false. - Add endpoint to delete pending or rejected changes to a sender.
- Add errors for invalid media file size and internal media upload error for template submission.
-
Add
error
field containing reason for error if sender is in stateERROR
. -
Add
comment
field to activity lists. - Add update sender endpoint.
- Add endpoint to start verification register for OBO sender.
-
Add
WHATSAPP_TEMPLATE_COMMENT_ADDED
webhook trigger. - Add creating and listing comments for account.
Changed
- Fixed remove unexpected "\n" from error resolution.
- Fixed text header max length (allowed max 60 characters).
- Fixed error message for sender photo url.
- Add custom error resolution for message template submit errors.
- Fix validation to not allow an empty list of buttons in a button component.
- Fixed checking file dimension for sender photo url. Updated file requirements for sender photo url.
- Fixed error if url leads to a page that does not exist.
- Add generic mime type for download files from url. Applies to both template component media header example and photoUrl for senders.
- Fixed internal server error when sending empty button components.
- Remove mime type for template media header component example.
- Fixed adding mp4 files as header example.
- Fixed adding pdf files as header example
-
Temporarily remove
WHATSAPP_TEMPLATE_DELETED
webhook trigger. -
Fixed validation for components
BUTTONS
- require at least one character forvalue
. - Cache images for template header example and sender photo url on Sinch servers.
- Trigger sender webhooks by relying on bot id instead of expecting project id.
- Update documentation for sender OTP code verification.
- Increase max template button text length to 25 characters and header text to 256 characters.
-
Update
type
field enum to reflect the statuses which are present in the corresponding resource type. - Allow all template categories ( both legacy and new ) when creating templates.
- Fix method to delete draft and rejected templates.
-
Transition a change request to
DRAFT
before updating if the change request isREJECTED
. - Fix template Kafka processor when payload is without template id.
- Change error for sender verification when registration has not occured yet.
- Fix validation issue when template contains more than ten variables.
-
Remove
createdBy
andmodifiedBy
fields from activity lists. - Fix validation for OBO sender verification erroneously allowing empty verification code.
-
Remove
WHATSAPP_TEMPLATE_IN_PROGRESS
webhook trigger.
Webhooks
Breaking Changes
-
Previous version allowed to register a webhook trigger with both
ALL
and a specific triggers such asWHATSAPP_TEMPLATE_APPROVED
. Now onlyALL
is allowed if specified and if any more are provided an error is thrown.
Changes
-
Renaming
Update Webhook
toReplace Webhook
(PUT
method) and addingUpdate Webhook
(PATCH
method). -
Do not allow other triggers along with
ALL
.
Bundles
Changes
- Retry if Conversation API returns an error when setting App credentials.