Get Realtime URL
Gets the URL for real-time messages that points to your Get Retention Message endpoint, which you previously configured.
URL
GET https://api.storekit.apple.com/inApps/v1/messaging/realtime/urlSandbox URL
GET https://api.storekit-sandbox.apple.com/inApps/v1/messaging/realtime/urlResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RealtimeUrlRequest | Request succeeded. |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 404 | Not Found Content-Type: application/json | RealtimeUrlNotFoundError | The |
| 429 | Content-Type: application/json | RateLimitExceededError | The request exceeded the rate limit. For more information, see Identifying rate limits. |
| 500 | Internal Server Error Content-Type: application/json | GeneralInternalError | Server error. Try again later. |
Mentioned in
Discussion
This endpoint returns your Get Retention Message endpoint’s URL. The URL it provides is specific to the environment (sandbox or production) you use to call Get Realtime URL.
This endpoint returns an HTTP 404 error with RealtimeUrlNotFoundError if the URL isn’t configured.
For more information on configuring your Get Retention Message endpoint, see Setting up your Get Retention Message endpoint.