openapi_client.MessageApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
delete_message	POST /message/{message_id}/delete	Delete Message
react_message	POST /message/{message_id}/reaction	Send reaction to message
read_message	POST /message/{message_id}/read	Mark as read message
revoke_message	POST /message/{message_id}/revoke	Revoke Message
update_message	POST /message/{message_id}/update	Edit message by message ID before 15 minutes

delete_message

SendResponse delete_message(message_id, revoke_message_request=revoke_message_request)

Delete Message

Example

import openapi_client
from openapi_client.models.revoke_message_request import RevokeMessageRequest
from openapi_client.models.send_response import SendResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:3000"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MessageApi(api_client)
    message_id = 'message_id_example' # str | Message ID
    revoke_message_request = openapi_client.RevokeMessageRequest() # RevokeMessageRequest |  (optional)

    try:
        # Delete Message
        api_response = api_instance.delete_message(message_id, revoke_message_request=revoke_message_request)
        print("The response of MessageApi->delete_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessageApi->delete_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Message ID
revoke_message_request	RevokeMessageRequest		[optional]

Return type

SendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

react_message

SendResponse react_message(message_id, react_message_request=react_message_request)

Send reaction to message

Example

import openapi_client
from openapi_client.models.react_message_request import ReactMessageRequest
from openapi_client.models.send_response import SendResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:3000"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MessageApi(api_client)
    message_id = 'message_id_example' # str | Message ID
    react_message_request = openapi_client.ReactMessageRequest() # ReactMessageRequest |  (optional)

    try:
        # Send reaction to message
        api_response = api_instance.react_message(message_id, react_message_request=react_message_request)
        print("The response of MessageApi->react_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessageApi->react_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Message ID
react_message_request	ReactMessageRequest		[optional]

Return type

SendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_message

SendResponse read_message(message_id, read_message_request=read_message_request)

Mark as read message

Example

import openapi_client
from openapi_client.models.read_message_request import ReadMessageRequest
from openapi_client.models.send_response import SendResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:3000"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MessageApi(api_client)
    message_id = 'message_id_example' # str | Message ID
    read_message_request = openapi_client.ReadMessageRequest() # ReadMessageRequest |  (optional)

    try:
        # Mark as read message
        api_response = api_instance.read_message(message_id, read_message_request=read_message_request)
        print("The response of MessageApi->read_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessageApi->read_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Message ID
read_message_request	ReadMessageRequest		[optional]

Return type

SendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revoke_message

SendResponse revoke_message(message_id, revoke_message_request=revoke_message_request)

Revoke Message

Example

import openapi_client
from openapi_client.models.revoke_message_request import RevokeMessageRequest
from openapi_client.models.send_response import SendResponse
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:3000"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MessageApi(api_client)
    message_id = 'message_id_example' # str | Message ID
    revoke_message_request = openapi_client.RevokeMessageRequest() # RevokeMessageRequest |  (optional)

    try:
        # Revoke Message
        api_response = api_instance.revoke_message(message_id, revoke_message_request=revoke_message_request)
        print("The response of MessageApi->revoke_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessageApi->revoke_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Message ID
revoke_message_request	RevokeMessageRequest		[optional]

Return type

SendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_message

SendResponse update_message(message_id, update_message_request=update_message_request)

Edit message by message ID before 15 minutes

Example

import openapi_client
from openapi_client.models.send_response import SendResponse
from openapi_client.models.update_message_request import UpdateMessageRequest
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:3000"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.MessageApi(api_client)
    message_id = 'message_id_example' # str | Message ID
    update_message_request = openapi_client.UpdateMessageRequest() # UpdateMessageRequest |  (optional)

    try:
        # Edit message by message ID before 15 minutes
        api_response = api_instance.update_message(message_id, update_message_request=update_message_request)
        print("The response of MessageApi->update_message:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MessageApi->update_message: %s\n" % e)

Parameters

Name	Type	Description	Notes
message_id	str	Message ID
update_message_request	UpdateMessageRequest		[optional]

Return type

SendResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MessageApi.md

Latest commit

History

MessageApi.md

File metadata and controls

openapi_client.MessageApi

delete_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

react_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

revoke_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_message

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details