CREATEMESSAGETEMPLATEVERSION()`¶

About CreateMessageTemplateVersion¶

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

Method Signature¶

METHODS /AWS1/IF_QQC~CREATEMESSAGETEMPLATEVERSION
  IMPORTING
    !IV_KNOWLEDGEBASEID TYPE /AWS1/QQCUUIDORARN OPTIONAL
    !IV_MESSAGETEMPLATEID TYPE /AWS1/QQCUUIDORARNOREITHERWQ00 OPTIONAL
    !IV_MESSAGETMPLCONTENTSHA256 TYPE /AWS1/QQCMESSAGETMPLCONTSHA256 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqccremsgtmplvrsrsp
  RAISING
    /AWS1/CX_QQCACCESSDENIEDEX
    /AWS1/CX_QQCCONFLICTEXCEPTION
    /AWS1/CX_QQCRESOURCENOTFOUNDEX
    /AWS1/CX_QQCSERVICEQUOTAEXCDEX
    /AWS1/CX_QQCTHROTTLINGEX
    /AWS1/CX_QQCVALIDATIONEX
    /AWS1/CX_QQCCLIENTEXC
    /AWS1/CX_QQCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_knowledgebaseid` `TYPE /AWS1/QQCUUIDORARN` `/AWS1/QQCUUIDORARN`¶

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

`iv_messagetemplateid` `TYPE /AWS1/QQCUUIDORARNOREITHERWQ00` `/AWS1/QQCUUIDORARNOREITHERWQ00`¶

The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

Optional arguments:¶

`iv_messagetmplcontentsha256` `TYPE /AWS1/QQCMESSAGETMPLCONTSHA256` `/AWS1/QQCMESSAGETMPLCONTSHA256`¶

The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the $LATEST qualifier by default.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqccremsgtmplvrsrsp` `/AWS1/CL_QQCCREMSGTMPLVRSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createmessagetemplateversion(
  iv_knowledgebaseid = |string|
  iv_messagetemplateid = |string|
  iv_messagetmplcontentsha256 = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_extendedmessagetemplate = lo_result->get_messagetemplate( ).
  IF lo_extendedmessagetemplate IS NOT INITIAL.
    lv_arnwithqualifier = lo_extendedmessagetemplate->get_messagetemplatearn( ).
    lv_uuid = lo_extendedmessagetemplate->get_messagetemplateid( ).
    lv_arn = lo_extendedmessagetemplate->get_knowledgebasearn( ).
    lv_uuid = lo_extendedmessagetemplate->get_knowledgebaseid( ).
    lv_name = lo_extendedmessagetemplate->get_name( ).
    lv_channelsubtype = lo_extendedmessagetemplate->get_channelsubtype( ).
    lv_timestamp = lo_extendedmessagetemplate->get_createdtime( ).
    lv_timestamp = lo_extendedmessagetemplate->get_lastmodifiedtime( ).
    lv_genericarn = lo_extendedmessagetemplate->get_lastmodifiedby( ).
    lo_messagetemplatecontentp = lo_extendedmessagetemplate->get_content( ).
    IF lo_messagetemplatecontentp IS NOT INITIAL.
      lo_emailmessagetemplatecon = lo_messagetemplatecontentp->get_email( ).
      IF lo_emailmessagetemplatecon IS NOT INITIAL.
        lv_nonemptyunlimitedstring = lo_emailmessagetemplatecon->get_subject( ).
        lo_emailmessagetemplatecon_1 = lo_emailmessagetemplatecon->get_body( ).
        IF lo_emailmessagetemplatecon_1 IS NOT INITIAL.
          lo_messagetemplatebodycont = lo_emailmessagetemplatecon_1->get_plaintext( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
          lo_messagetemplatebodycont = lo_emailmessagetemplatecon_1->get_html( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
        ENDIF.
        LOOP AT lo_emailmessagetemplatecon->get_headers( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_emailheaderkey = lo_row_1->get_name( ).
            lv_emailheadervalue = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lo_smsmessagetemplateconte = lo_messagetemplatecontentp->get_sms( ).
      IF lo_smsmessagetemplateconte IS NOT INITIAL.
        lo_smsmessagetemplateconte_1 = lo_smsmessagetemplateconte->get_body( ).
        IF lo_smsmessagetemplateconte_1 IS NOT INITIAL.
          lo_messagetemplatebodycont = lo_smsmessagetemplateconte_1->get_plaintext( ).
          IF lo_messagetemplatebodycont IS NOT INITIAL.
            lv_nonemptyunlimitedstring = lo_messagetemplatebodycont->get_content( ).
          ENDIF.
        ENDIF.
      ENDIF.
    ENDIF.
    lv_description = lo_extendedmessagetemplate->get_description( ).
    lv_languagecode = lo_extendedmessagetemplate->get_language( ).
    lo_groupingconfiguration = lo_extendedmessagetemplate->get_groupingconfiguration( ).
    IF lo_groupingconfiguration IS NOT INITIAL.
      lv_groupingcriteria = lo_groupingconfiguration->get_criteria( ).
      LOOP AT lo_groupingconfiguration->get_values( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_groupingvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_messagetemplateattribut = lo_extendedmessagetemplate->get_defaultattributes( ).
    IF lo_messagetemplateattribut IS NOT INITIAL.
      lo_systemattributes = lo_messagetemplateattribut->get_systemattributes( ).
      IF lo_systemattributes IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_systemattributes->get_name( ).
        lo_systemendpointattribute = lo_systemattributes->get_customerendpoint( ).
        IF lo_systemendpointattribute IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_systemendpointattribute->get_address( ).
        ENDIF.
        lo_systemendpointattribute = lo_systemattributes->get_systemendpoint( ).
        IF lo_systemendpointattribute IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_systemendpointattribute->get_address( ).
        ENDIF.
      ENDIF.
      lo_agentattributes = lo_messagetemplateattribut->get_agentattributes( ).
      IF lo_agentattributes IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_agentattributes->get_firstname( ).
        lv_messagetemplateattribut_1 = lo_agentattributes->get_lastname( ).
      ENDIF.
      lo_customerprofileattribut = lo_messagetemplateattribut->get_customerprofileattrs( ).
      IF lo_customerprofileattribut IS NOT INITIAL.
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_profileid( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_profilearn( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_firstname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_middlename( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_lastname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_accountnumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_emailaddress( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_phonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_additionalinformation( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_partytype( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessname( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_birthdate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_gender( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mobilephonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_homephonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessphonenumber( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_businessemailaddress( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_address4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_city( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_county( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_country( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_postalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_province( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_state( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_shippingstate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_mailingstate( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress1( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress2( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress3( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingaddress4( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcity( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcounty( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingcountry( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingpostalcode( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingprovince( ).
        lv_messagetemplateattribut_1 = lo_customerprofileattribut->get_billingstate( ).
        LOOP AT lo_customerprofileattribut->get_custom( ) into ls_row_4.
          lv_key = ls_row_4-key.
          lo_value = ls_row_4-value.
          IF lo_value IS NOT INITIAL.
            lv_messagetemplateattribut_1 = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      LOOP AT lo_messagetemplateattribut->get_customattributes( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_messagetemplateattribut_1 = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    LOOP AT lo_extendedmessagetemplate->get_attributetypes( ) into lo_row_5.
      lo_row_6 = lo_row_5.
      IF lo_row_6 IS NOT INITIAL.
        lv_messagetemplateattribut_2 = lo_row_6->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_extendedmessagetemplate->get_attachments( ) into lo_row_7.
      lo_row_8 = lo_row_7.
      IF lo_row_8 IS NOT INITIAL.
        lv_contentdisposition = lo_row_8->get_contentdisposition( ).
        lv_attachmentfilename = lo_row_8->get_name( ).
        lv_timestamp = lo_row_8->get_uploadedtime( ).
        lv_url = lo_row_8->get_url( ).
        lv_timestamp = lo_row_8->get_urlexpiry( ).
        lv_uuid = lo_row_8->get_attachmentid( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_extendedmessagetemplate->get_isactive( ).
    lv_version = lo_extendedmessagetemplate->get_versionnumber( ).
    lv_messagetemplatecontents = lo_extendedmessagetemplate->get_messagetmplcontentsha256( ).
    LOOP AT lo_extendedmessagetemplate->get_tags( ) into ls_row_9.
      lv_key_1 = ls_row_9-key.
      lo_value_1 = ls_row_9-value.
      IF lo_value_1 IS NOT INITIAL.
        lv_tagvalue = lo_value_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_QQC=>CREATEMESSAGETEMPLATEVERSION()¶