symphony.bdk.core.service.message.multi_attachments_messages_api.MultiAttachmentsMessagesApi#

class symphony.bdk.core.service.message.multi_attachments_messages_api.MultiAttachmentsMessagesApi(api_client=None)#

Bases: symphony.bdk.gen.agent_api.messages_api.MessagesApi

Message Api inherited the MessagesApi generated by OpenAPI Generator which allows to send or blast a message with multiple attachments and previews

__init__(api_client=None) → None#

Methods

`__init__`([api_client])
`v1_message_id_get`(session_token, id[, ...])	Get a message by ID
`v1_message_id_get_with_http_info`(...[, ...])	Get a message by ID
`v1_message_id_get_without_preload_content`(...)	Get a message by ID
`v1_message_import_post`(session_token, ...[, ...])	(Deprecated) Import messages from other systems into Symphony.
`v1_message_import_post_with_http_info`(...[, ...])	(Deprecated) Import messages from other systems into Symphony.
`v1_message_import_post_without_preload_content`(...)	(Deprecated) Import messages from other systems into Symphony.
`v1_message_search_get`(query, session_token)	Search messages
`v1_message_search_get_with_http_info`(query, ...)	Search messages
`v1_message_search_get_without_preload_content`(...)	Search messages
`v1_message_search_post`(session_token, query)	Search messages
`v1_message_search_post_with_http_info`(...[, ...])	Search messages
`v1_message_search_post_without_preload_content`(...)	Search messages
`v1_stream_sid_message_create_post`(sid, ...)	(Deprecated) Post a message to one existing stream.
`v1_stream_sid_message_create_post_with_http_info`(...)	(Deprecated) Post a message to one existing stream.
`v1_stream_sid_message_create_post_without_preload_content`(...)	(Deprecated) Post a message to one existing stream.
`v1_stream_sid_message_get`(sid, since, ...[, ...])	(Deprecated) Get messages from an existing stream.
`v1_stream_sid_message_get_with_http_info`(...)	(Deprecated) Get messages from an existing stream.
`v1_stream_sid_message_get_without_preload_content`(...)	(Deprecated) Get messages from an existing stream.
`v2_message_import_post`(session_token, ...[, ...])	(Deprecated) Import messages from other systems into Symphony.
`v2_message_import_post_with_http_info`(...[, ...])	(Deprecated) Import messages from other systems into Symphony.
`v2_message_import_post_without_preload_content`(...)	(Deprecated) Import messages from other systems into Symphony.
`v2_stream_sid_message_create_post`(sid, ...)	(Deprecated) Post a message to one existing stream.
`v2_stream_sid_message_create_post_with_http_info`(...)	(Deprecated) Post a message to one existing stream.
`v2_stream_sid_message_create_post_without_preload_content`(...)	(Deprecated) Post a message to one existing stream.
`v2_stream_sid_message_get`(sid, since, ...[, ...])	(Deprecated) Get messages from an existing stream.
`v2_stream_sid_message_get_with_http_info`(...)	(Deprecated) Get messages from an existing stream.
`v2_stream_sid_message_get_without_preload_content`(...)	(Deprecated) Get messages from an existing stream.
`v3_stream_sid_message_create_post`(sid, ...)	(Deprecated) PROVISIONAL - Post a message to one existing stream.
`v3_stream_sid_message_create_post_with_http_info`(...)	(Deprecated) PROVISIONAL - Post a message to one existing stream.
`v3_stream_sid_message_create_post_without_preload_content`(...)	(Deprecated) PROVISIONAL - Post a message to one existing stream.
`v4_message_blast_post`(session_token, sids[, ...])	Post a message to multiple existing streams.
`v4_message_blast_post_with_http_info`(...[, ...])	Post a message to multiple existing streams.
`v4_message_blast_post_without_preload_content`(...)	Post a message to multiple existing streams.
`v4_message_import_post`(session_token, ...[, ...])	Import messages from other systems into Symphony.
`v4_message_import_post_with_http_info`(...[, ...])	Import messages from other systems into Symphony.
`v4_message_import_post_without_preload_content`(...)	Import messages from other systems into Symphony.
`v4_message_search_semantic_post`(...[, skip, ...])	Semantic search for messages
`v4_message_search_semantic_post_with_http_info`(...)	Semantic search for messages
`v4_message_search_semantic_post_without_preload_content`(...)	Semantic search for messages
`v4_multi_attachment_message_blast_post`(...)	Post a message to multiple existing streams.
`v4_stream_sid_message_create_post`(sid, ...)	Post a message to one existing stream.
`v4_stream_sid_message_create_post_with_http_info`(...)	Post a message to one existing stream.
`v4_stream_sid_message_create_post_without_preload_content`(...)	Post a message to one existing stream.
`v4_stream_sid_message_get`(sid, since, ...[, ...])	Get messages from an existing stream.
`v4_stream_sid_message_get_with_http_info`(...)	Get messages from an existing stream.
`v4_stream_sid_message_get_without_preload_content`(...)	Get messages from an existing stream.
`v4_stream_sid_message_mid_update_post`(sid, ...)	Update an existing message.
`v4_stream_sid_message_mid_update_post_with_http_info`(...)	Update an existing message.
`v4_stream_sid_message_mid_update_post_without_preload_content`(...)	Update an existing message.
`v4_stream_sid_multi_attachment_message_create_post`(...)	Post a message to one existing stream.

async v1_message_id_get(session_token: str, id: str, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message.V4Message#

Get a message by ID

Parameters

session_token (str) – Session authentication token. (required)
id (str) – Message ID as a URL-safe string (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_id_get_with_http_info(session_token: str, id: str, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V4Message]#

Get a message by ID

Parameters

session_token (str) – Session authentication token. (required)
id (str) – Message ID as a URL-safe string (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_id_get_without_preload_content(session_token: str, id: str, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Get a message by ID

Parameters

session_token (str) – Session authentication token. (required)
id (str) – Message ID as a URL-safe string (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_import_post(session_token: str, message_list: List[symphony.bdk.gen.agent_model.imported_message.ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.import_response.ImportResponse]#

(Deprecated) Import messages from other systems into Symphony.

Sends a message to be imported into the system. Allows you to override the timestamp and author of the message with your desired values. The requesting user must have the Content Management role. The user that the message is intended to have come from must also be present in the conversation. The intended message timestamp must be a valid time from the past. It cannot be a future timestamp.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_import_post_with_http_info(session_token: str, message_list: List[symphony.bdk.gen.agent_model.imported_message.ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.import_response.ImportResponse]]#

(Deprecated) Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_import_post_without_preload_content(session_token: str, message_list: List[symphony.bdk.gen.agent_model.imported_message.ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_get(query: str, session_token: str, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v4_message.V4Message]#

Search messages

Search messages according to the specified criteria. The “query” parameter takes a search query defined as “field:value” pairs combined by the operator “AND” (e.g. “text:foo AND autor:bar”). Supported fields are (case-insensitive): “text”, “author”, “hashtag”, “cashtag”, “mention”, “signal”, “fromDate”, “toDate”, “streamId”, “streamType”. “text” search requires a “streamId” to be specified. “streamType” accepts one of the following values: “chat” (IMs and MIMs), “im”, “mim”, “chatroom”, “post”. “signal” queries can only be combined with “fromDate”, “toDate”, “skip” and “limit” parameters.

Parameters

query (str) – The search query. See above for the query syntax. (required)
session_token (str) – Session authentication token. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_get_with_http_info(query: str, session_token: str, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v4_message.V4Message]]#

Search messages

Parameters

query (str) – The search query. See above for the query syntax. (required)
session_token (str) – Session authentication token. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_get_without_preload_content(query: str, session_token: str, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Search messages

Parameters

query (str) – The search query. See above for the query syntax. (required)
session_token (str) – Session authentication token. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_post(session_token: str, query: symphony.bdk.gen.agent_model.message_search_query.MessageSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v4_message.V4Message]#

Search messages

Search messages according to the specified criteria.

Parameters

session_token (str) – Session authentication token. (required)
query (MessageSearchQuery) – The search query. See above for the query syntax. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_post_with_http_info(session_token: str, query: symphony.bdk.gen.agent_model.message_search_query.MessageSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v4_message.V4Message]]#

Search messages

Search messages according to the specified criteria.

Parameters

session_token (str) – Session authentication token. (required)
query (MessageSearchQuery) – The search query. See above for the query syntax. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_message_search_post_without_preload_content(session_token: str, query: symphony.bdk.gen.agent_model.message_search_query.MessageSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, scope: Optional[str] = None, sort_dir: Optional[str] = None, tier: Optional[str] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Search messages

Search messages according to the specified criteria.

Parameters

session_token (str) – Session authentication token. (required)
query (MessageSearchQuery) – The search query. See above for the query syntax. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 50 is the default.
scope (str) – Describes where content should be searched for that query. It can exclusively apply to Symphony content or to one Connector.
sort_dir (str) – Messages sort direction : ASC or DESC (default to DESC)
tier (str) – Target search tier : hot, warm or all (default to hot)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_create_post(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.message_submission.MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.message.Message#

(Deprecated) Post a message to one existing stream.

Post a new message to the given stream. The stream can be a chatroom, an IM or a multiparty IM. If the message parameter type is TEXT then the message contains plain text and cannot include formating, hash tags, mentions etc. If the message parameter type is MessageML then the message contains MessageML which allows for these entities. If the message is in MessageML and fails schema validation a client error results If the message is sent then 200 is returned.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_create_post_with_http_info(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.message_submission.MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[Message]#

(Deprecated) Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_create_post_without_preload_content(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.message_submission.MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_get(sid: str, since: int, session_token: str, offset: Optional[int] = None, max_messages: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.message.Message]#

(Deprecated) Get messages from an existing stream.

A caller can fetch all unseen messages by passing the timestamp of the last message seen as the since parameter and the number of messages with the same timestamp value already seen as the skip parameter. This means that every message will be seen exactly once even in the case that an additional message is processed with the same timestamp as the last message returned by the previous call, and the case where there are more than maxMessages with the same timestamp value. This method is intended for historic queries and is generally reliable but if guaranteed delivery of every message in real time is required then the equivilent firehose method should be called.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
max_messages (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_get_with_http_info(sid: str, since: int, session_token: str, offset: Optional[int] = None, max_messages: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.message.Message]]#

(Deprecated) Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
max_messages (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v1_stream_sid_message_get_without_preload_content(sid: str, since: int, session_token: str, offset: Optional[int] = None, max_messages: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
max_messages (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_message_import_post(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v2_imported_message.V2ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v2_import_response.V2ImportResponse]#

(Deprecated) Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V2ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_message_import_post_with_http_info(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v2_imported_message.V2ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v2_import_response.V2ImportResponse]]#

(Deprecated) Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V2ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_message_import_post_without_preload_content(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v2_imported_message.V2ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V2ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_create_post(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v2_message.V2Message#

(Deprecated) Post a message to one existing stream.

Post a new message to the given stream. The stream can be a chatroom, an IM or a multiparty IM. You may include an attachment on the message (see the V2MessageSubmission parameter). If the message parameter type is TEXT then the message contains plain text and cannot include formating, hash tags, mentions etc. If the message parameter type is MessageML then the message contains MessageML which allows for these entities. If the message is in MessageML and fails schema validation a client error results If the message is sent then 200 is returned.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_create_post_with_http_info(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V2Message]#

(Deprecated) Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_create_post_without_preload_content(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Session authentication token. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_get(sid: str, since: int, session_token: str, offset: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v2_base_message.V2BaseMessage]#

(Deprecated) Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_get_with_http_info(sid: str, since: int, session_token: str, offset: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v2_base_message.V2BaseMessage]]#

(Deprecated) Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v2_stream_sid_message_get_without_preload_content(sid: str, since: int, session_token: str, offset: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
offset (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v3_stream_sid_message_create_post(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v2_message.V2Message#

(Deprecated) PROVISIONAL - Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v3_stream_sid_message_create_post_with_http_info(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V2Message]#

(Deprecated) PROVISIONAL - Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v3_stream_sid_message_create_post_without_preload_content(sid: str, session_token: str, message: symphony.bdk.gen.agent_model.v2_message_submission.V2MessageSubmission, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

(Deprecated) PROVISIONAL - Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
message (V2MessageSubmission) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_blast_post(session_token: str, sids: List[str], key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message_blast_response.V4MessageBlastResponse#

Post a message to multiple existing streams.

Post a new message to the given list of streams. The stream can be a chatroom, an IM or a multiparty IM. You may include an attachment on the message. The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates. The optional parameter “data” can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in “data-entity-id” element attributes), this parameter is required. If the message is in MessageML and fails schema validation a client error results This endpoint is idempotent, it means that a 200 response will be returned even if the message has not been delivered to some streams. Check the errors map from the response in order to see on which stream(s) the message has not been delivered. The maximum number of streams where the message can be sent is limitted to 100. Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together.

Parameters

session_token (str) – Authorization token used to make delegated calls. (required)
sids (List[str]) – A comma-separated list of Stream IDs (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_blast_post_with_http_info(session_token: str, sids: List[str], key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V4MessageBlastResponse]#

Post a message to multiple existing streams.

Parameters

session_token (str) – Authorization token used to make delegated calls. (required)
sids (List[str]) – A comma-separated list of Stream IDs (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_blast_post_without_preload_content(session_token: str, sids: List[str], key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Post a message to multiple existing streams.

Parameters

session_token (str) – Authorization token used to make delegated calls. (required)
sids (List[str]) – A comma-separated list of Stream IDs (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_import_post(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v4_imported_message.V4ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v4_import_response.V4ImportResponse]#

Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V4ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_import_post_with_http_info(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v4_imported_message.V4ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v4_import_response.V4ImportResponse]]#

Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V4ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_import_post_without_preload_content(session_token: str, message_list: List[symphony.bdk.gen.agent_model.v4_imported_message.V4ImportedMessage], key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Import messages from other systems into Symphony.

Parameters

session_token (str) – Session authentication token. (required)
message_list (List[V4ImportedMessage]) – (required)
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_search_semantic_post(session_token: str, query: symphony.bdk.gen.agent_model.semantic_search_query.SemanticSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v4_message.V4Message]#

Semantic search for messages

Disclaimer : Internal use only. This is not officially supported yet. Search messages semantically according to the natural-language query provided in the request body. The “text” field holds the query and the optional “threadId” field restricts the search to a single stream.

Parameters

session_token (str) – Session authentication token. (required)
query (SemanticSearchQuery) – The semantic search query. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 25 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_search_semantic_post_with_http_info(session_token: str, query: symphony.bdk.gen.agent_model.semantic_search_query.SemanticSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v4_message.V4Message]]#

Semantic search for messages

Parameters

session_token (str) – Session authentication token. (required)
query (SemanticSearchQuery) – The semantic search query. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 25 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_message_search_semantic_post_without_preload_content(session_token: str, query: symphony.bdk.gen.agent_model.semantic_search_query.SemanticSearchQuery, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Semantic search for messages

Parameters

session_token (str) – Session authentication token. (required)
query (SemanticSearchQuery) – The semantic search query. (required)
skip (int) – No. of results to skip.
limit (int) – Max no. of results to return. If no value is provided, 25 is the default.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_multi_attachment_message_blast_post(session_token: str, sids: List[str], key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[List[io.IOBase]] = None, preview: Optional[List[io.IOBase]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message_blast_response.V4MessageBlastResponse#: Post a message to multiple existing streams.

async v4_stream_sid_message_create_post(sid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message.V4Message#

Post a message to one existing stream.

Post a new message to the given stream. The stream can be a chatroom,,an IM or a multiparty IM. You may include an attachment on the message. The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates. The optional parameter “data” can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in “data-entity-id” element attributes), this parameter is required. If the message is in MessageML and fails schema validation a client error will be returned. If the message is sent then 200 is returned. Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_create_post_with_http_info(sid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V4Message]#

Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_create_post_without_preload_content(sid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Post a message to one existing stream.

Parameters

sid (str) – Stream ID (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_get(sid: str, since: int, session_token: str, until: Optional[int] = None, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → List[symphony.bdk.gen.agent_model.v4_message.V4Message]#

Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
until (int) – Timestamp of last required message. This is a long integer value representing milliseconds since Jan 1 1970
skip (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_get_with_http_info(sid: str, since: int, session_token: str, until: Optional[int] = None, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[List[symphony.bdk.gen.agent_model.v4_message.V4Message]]#

Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
until (int) – Timestamp of last required message. This is a long integer value representing milliseconds since Jan 1 1970
skip (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_get_without_preload_content(sid: str, since: int, session_token: str, until: Optional[int] = None, skip: Optional[int] = None, limit: Optional[int] = None, key_manager_token: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Get messages from an existing stream.

Parameters

sid (str) – Stream ID (required)
since (int) – Timestamp of first required message. This is a long integer value representing milliseconds since Jan 1 1970 (required)
session_token (str) – Session authentication token. (required)
until (int) – Timestamp of last required message. This is a long integer value representing milliseconds since Jan 1 1970
skip (int) – No. of messages to skip.
limit (int) – Max No. of messages to return. If no value is provided, 50 is the default. The maximum supported value is 500.
key_manager_token (str) – Key Manager authentication token.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_mid_update_post(sid: str, mid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, silent: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message.V4Message#

Update an existing message.

Update an existing message. The existing message must be a valid social message, that has not been deleted. The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates. The optional parameter “data” can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in “data-entity-id” element attributes), this parameter is required. Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together. Starting with SBE v24.1, attachments are supported.

Parameters

sid (str) – Stream ID (required)
mid (str) – ID of the message to be updated (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
silent (str) – Optional boolean field that will determine if the user/s should receive the message as read or not (true by default)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_mid_update_post_with_http_info(sid: str, mid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, silent: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.api_response.ApiResponse[V4Message]#

Update an existing message.

Parameters

sid (str) – Stream ID (required)
mid (str) – ID of the message to be updated (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
silent (str) – Optional boolean field that will determine if the user/s should receive the message as read or not (true by default)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_message_mid_update_post_without_preload_content(sid: str, mid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, preview: Optional[Union[bytes, str, Tuple[str, bytes]]] = None, silent: Optional[str] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → aiohttp.client_reqrep.ClientResponse#

Update an existing message.

Parameters

sid (str) – Stream ID (required)
mid (str) – ID of the message to be updated (required)
session_token (str) – Authorization token used to make delegated calls. (required)
key_manager_token (str) – Key Manager authentication token.
message (str) – The message payload in MessageML.
data (str) – Optional message data in EntityJSON.
version (str) – Optional message version in the format "major.minor". If empty, defaults to the latest supported version.
attachment (bytearray) – Optional file attachment.
preview (bytearray) – Optional attachment preview.
silent (str) – Optional boolean field that will determine if the user/s should receive the message as read or not (true by default)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Returns

Returns the result object.

async v4_stream_sid_multi_attachment_message_create_post(sid: str, session_token: str, key_manager_token: Optional[str] = None, message: Optional[str] = None, data: Optional[str] = None, version: Optional[str] = None, attachment: Optional[List[io.IOBase]] = None, preview: Optional[List[io.IOBase]] = None, _request_timeout: Union[None, float, Tuple[float, float]] = None, _request_auth: Optional[Dict[str, Any]] = None, _content_type: Optional[str] = None, _headers: Optional[Dict[str, Any]] = None, _host_index: int = 0) → symphony.bdk.gen.agent_model.v4_message.V4Message#: Post a message to one existing stream.