API Endpoint migration guide
This outlines the changes to our API endpoints and provides guidance for migrating your applications to use the updated endpoints. We're introducing these changes to improve consistency, reliability, and functionality across our services.
These endpoint changes include updates to both SMS and Messaging Apps services. Please review all changes carefully to ensure a smooth endpoint transition.
Key Changes
- SMS endpoints: Several endpoints have been consolidated for improved efficiency.
- Response format standardization across Messaging Apps endpoints.
- Parameter handling changes in certain endpoints.
What To Do
- Migrate to the New Endpoint URL and corresponding payload/response updates.
- Contact support for any clarification.
SMS API Endpoints
📘
The SMS endpoint payload and response remain consistent with the previous version and remain unchanged.
Migrate and update your API calls to use the new endpoint URL, as listed in the New Endpoint column.
| Old Endpoint | New Endpoint |
|---|---|
POST/sms/v1/{subAccountId}/single |
Send SMS Single |
POST/sms/v1/{subAccountId}/many |
Send Many SMS |
POST/sms/v1/{subAccountId}/many/compact |
Send Many SMS |
DELETE/sms/v1/{subAccountId}/single/{umid} |
Cancel Scheduled Message |
DELETE/sms/v1/{subAccountId}/many/{batchId} |
Cancel Many SMS Messages |
Messaging Apps API Endpoints
📘
Migrate to the new endpoint (see New Endpoint column).
There are updates in the payload and response structures; refer to the New Endpoint column for documentation to update corresponding payload/response properties.
| Old Endpoint | New Endpoint | Payload/Response Changes |
|---|---|---|
POST/chatapps/v1/{subAccountId}/message/read |
Mark Message Read | Payload Changes: - Payload is removed. - umid is passed directly in the path of new endpoint. |
POST/ipm/v1/{subAccountId}/message/single |
Send Message | Response Changes: - Status propertyOld Success Response: "status": {"code": "QUEUED","description": "Message is accepted and queued for processing"}New Success Response: "status": {"state": "queued","timestamp": "2021-01-04T08:19:45.99Z"}
|
POST/chatapps/v1/{subAccountId}/message/single |
Send Message | same, as for POST/ipm/v1/{subAccountId}/message/single
|
POST/ipm/v1/{subAccountId}/message/many |
Send Message Many | same, as for POST/ipm/v1/{subAccountId}/message/single
|
POST/chatapps/v1/{subAccountId}/message/many |
Send Message Many | same, as for POST/ipm/v1/{subAccountId}/message/single
|
Source: https://developer.8x8.com/connect/docs/api-endpoint-migration-guide · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments