ChimeSDKMessaging / Client / channel_flow_callback

channel_flow_callback#

ChimeSDKMessaging.Client.channel_flow_callback(**kwargs)#

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

  • Update message content or metadata

  • Deny a message

  • Make no changes to the message

See also: AWS API Documentation

Request Syntax

response = client.channel_flow_callback(
    CallbackId='string',
    ChannelArn='string',
    DeleteResource=True|False,
    ChannelMessage={
        'MessageId': 'string',
        'Content': 'string',
        'Metadata': 'string',
        'PushNotification': {
            'Title': 'string',
            'Body': 'string',
            'Type': 'DEFAULT'|'VOIP'
        },
        'MessageAttributes': {
            'string': {
                'StringValues': [
                    'string',
                ]
            }
        },
        'SubChannelId': 'string',
        'ContentType': 'string'
    }
)
Parameters:

  • CallbackId (string) –

    [REQUIRED]

    The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

    This field is autopopulated if not provided.

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • DeleteResource (boolean) – When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.

  • ChannelMessage (dict) –

    [REQUIRED]

    Stores information about the processed message.

    • MessageId (string) – [REQUIRED]

      The message ID.

    • Content (string) –

      The message content.

    • Metadata (string) –

      The message metadata.

    • PushNotification (dict) –

      The push notification configuration of the message.

      • Title (string) –

        The title of the push notification.

      • Body (string) –

        The body of the push notification.

      • Type (string) –

        Enum value that indicates the type of the push notification for a message. DEFAULT: Normal mobile push notification. VOIP: VOIP mobile push notification.

    • MessageAttributes (dict) –

      The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

      • (string) –

        • (dict) –

          A list of message attribute values.

          • StringValues (list) –

            The strings in a message attribute value.

            • (string) –

    • SubChannelId (string) –

      The ID of the SubChannel.

    • ContentType (string) –

      The content type of the call-back message.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'CallbackId': 'string'
}

Response Structure

  • (dict) –

    • ChannelArn (string) –

      The ARN of the channel.

    • CallbackId (string) –

      The call back ID passed in the request.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ConflictException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException