We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
unsubscribeGroupMessages
This document describes the JSON RPC WebSocket API for unsubscribing from a conversation.
wss://protocol.xmtp.com/v1/conversation
This API follows the JSON RPC 2.0 specification. All messages sent and received are expected to be in valid JSON format.
To establish a secure WebSocket connection. This api may be public and does not require authentication.
subscribeGroupMessages
Unsubscribes the client from receiving updates for a specific conversation.
Parameters:
conversationId
Response:
{"jsonrpc": "2.0", "result": "Unsubscribed from conversation [conversationId]", "id": [requestId]}
None
The API uses standard JSON RPC error responses. Common error codes include:
-32601
-32602
-32603
{ "jsonrpc": "2.0", "method": "unsubscribeGroupMessages", "params": { "conversationId": "0x1234abcd..." }, "id": 1 }
This document describes version 1.0 of the API. Future updates and changes will be communicated as necessary.
The text was updated successfully, but these errors were encountered:
unsubscribeConversation
Reference Implementation: https://github.com/xmtp/xps-conversation-producer
Sorry, something went wrong.
No branches or pull requests
JSON RPC WebSocket API Documentation:
unsubscribeGroupMessages
Overview
This document describes the JSON RPC WebSocket API for unsubscribing from a conversation.
WebSocket Endpoint
wss://protocol.xmtp.com/v1/conversation
JSON RPC Protocol
This API follows the JSON RPC 2.0 specification. All messages sent and received are expected to be in valid JSON format.
Authentication
To establish a secure WebSocket connection. This api may be public and does not require authentication.
Method
1. see
subscribeGroupMessages
2.
unsubscribeGroupMessages
Unsubscribes the client from receiving updates for a specific conversation.
Parameters:
conversationId
(string): Unique identifier for the conversation.Response:
{"jsonrpc": "2.0", "result": "Unsubscribed from conversation [conversationId]", "id": [requestId]}
Notifications
None
Error Handling
The API uses standard JSON RPC error responses. Common error codes include:
-32601
: Method not found.-32602
: Invalid params.-32603
: Internal error.Examples
Request:
Versioning and Updates
This document describes version 1.0 of the API. Future updates and changes will be communicated as necessary.
The text was updated successfully, but these errors were encountered: