END OF LIFE : 31st October 2024
We have extended the timelines to 31st October 2024 in wake of certain issues reported by our legacy partners.
Why this change?
To ensure future scalability, we need partners to adopt these new technical changes that will seamlessly integrate with Cloud APIs and support upcoming WhatsApp features faster. This alignment will enhance our capabilities and streamline our operations as we evolve.
Steps to prepare -
- Always follow the latest documentation on docs.gupshup.io. Please consider any legacy documentation links as deprecated
- Identify the endpoints being used in your integrations starting with 'https://api.gupshup.io/sm' and refer below alternate endpoints for the same.
- Make sure you are using 'https' instead of 'http'. This will be applicable for Cloud API as well as On-premise apps
The endpoints will largely include -
a. Session Messaging endpoints -
Instead of https://api.gupshup.io/sm/api/v1/msg , please switch to https://api.gupshup.io/wa/api/v1/msg . Refer docs here
There will be NO other payload changes if you follow the mentioned documentation above.
[IMPORTANT] THINGS TO KEEP IN MIND:
1. While changing endpoints, you may need to update your /sm or /wa integrations confirming to the documentation on docs.gupshup.io. Start with a test app or test environment
2. Businesses/partners using the key 'message.payload' on /sm will need to change it to 'message' for /wa
3. /sm endpoint allows to send messages without PN validation in the app for Brazilian extra digits, but /wa endpoint does have this validation. Reach out to Support asking to update your required PN, following which you will be able to switch to /wa endpoint as well as migrate to Cloud API smoothly.
4. Use \n for linebreak correctly on /wa endpoints instead of shift+enter that worked in /sm endpoints.
5. You will not be able to use stringify JSON on /wa endpoints. Please use JSON objects only
b. Template Messaging endpoints -
Instead of https://api.gupshup.io/sm/api/v1/template/msg , please switch to https://api.gupshup.io/wa/api/v1/template/msg . Refer docs here
There will be NO other payload changes if you follow the mentioned documentation above.
* RECOMMENDED : We advise partners to use Sending Templates by Template ID APIs
c. Creation or editing of templates -
Instead of https://api.gupshup.io/sm/api/v1/template/add please switch to Create or edit templates APIs for partners
Payload changes might be needed
d. Get list of templates -
Instead of https://api.gupshup.io/sm/api/v1/template/list , please switch to Get list of templates API for partners
Payload changes might be needed
e. Block users -
Instead of https://api.gupshup.io/sm/api/v1/app/block , please switch to Block user API for partners
Payload changes might be needed
f. Optin optout APIs -
This feature is getting deprecated by 31st Aug for existing On-Premise and Cloud API apps : Refer article to get prepared
If you face issues or discrepancies in the change, please reach out to partner.support@gupshup.io immediately
- If you are using other endpoints starting with 'https://api.gupshup.io/sm' apart from sending messages, please notify your local CSM before 15th Sep 2024
-
ALERT : Continued use of /sm endpoints post 31st October might impact messaging, template management and relevant services
* RECOMMENDED ENDPOINTS FOR PARTNERS :
While we are not enforcing at the moment as they require payload changes, but we recommend Partners to use Partner APIs (instead of WhatsApp Self Serve APIs) by Dec 2024 generally for all other usecases as documented here. This will help them adapt to new changes and new features in a faster and a scalable manner.
Also read about - Things to keep in mind for Migration and New onboarding on Cloud API after July 1st, 2024
Comments
0 comments
Please sign in to leave a comment.