Developer Resources

Enterprise SOAP API > API by Reference > Notification Services > Notification SMS Keyword Addition > Developer Resources

Details

SoapAction	http://jackhenry.com/ws/NotSMSKeyWordAdd
Input Name	NotSMSKeyWordAdd
Output Name	NotSMSKeyWordAddResponse
Input Namespace	http://jackhenry.com/jxchange/TPG/2008
Group Name	ENS
Container	TPG_ENSMaster.xsd

XML Examples

ENS_API_NotificationSMSKeywordAdditionErrors

Error Code	Message
2505	Access was denied.
3103	This field is required and cannot be null.
3137	Must contain only alphanumeric characters and be at least 2 and no more than 100 characters in length.
3138	The keyword already exists.
3139	The keyword is a built in reserved keyword and cannot be used.
3140	SMSKeyWordExpTimeDt cannot be set to a date in the past.
3141	Alert does not exist.
3142	SMSKeyWordExpTimeDt is required and must be less than 72 hours when SMSKeyWordId is all numeric.
3144	Static keywords are not supported.
3145	The mobile number does not exist for a contact point associated with the publisher.

NotSMSKeyWordAddXML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SOAP-ENV:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
                <wsse:Username>{Insert}</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
                <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2019-12-11T20:26:24Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotSMSKeyWordAdd xmlns="http://jackhenry.com/jxchange/TPG/2008">
            <MsgRqHdr>
                <jXchangeHdr>
                    <JxVer/>
                    <AuditUsrId></AuditUsrId>
                    <AuditWsId></AuditWsId>
                    <AuthenUsrId/>
                    <ConsumerName></ConsumerName>
                    <ConsumerProd></ConsumerProd>
                    <Ver_1/>
                    <jXLogTrackingId>122222222</jXLogTrackingId>
                    <Ver_2/>
                    <InstRtId>003003003</InstRtId>
                    <InstEnv>PROD</InstEnv>
                    <Ver_3/>
                    <BusCorrelId/>
                    <Ver_4/>
                    <WorkflowCorrelId/>
                    <Ver_5/>
                    <ValidConsmName>{Insert}</ValidConsmName>
                    <ValidConsmProd>{Insert}</ValidConsmProd>
                    <Ver_6/>
                </jXchangeHdr>
            </MsgRqHdr>
            <ErrOvrRdInfoArray/>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <SMSKeyWordId SrchType="">CAT</SMSKeyWordId>
            <AlrtSMSKeyWordInfoRec>
                <CorrelAlrtName SrchType="">CWOOB</CorrelAlrtName>
            </AlrtSMSKeyWordInfoRec>
        </NotSMSKeyWordAdd>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Flow Chart

API_Processes_NotSMSKeyWordAdd_1_Flowchart

API_Processes_NotSMSKeyWordAdd_2_Flowchart

Have a Question?

Have a how-to question? Seeing a weird error? Get help on StackOverflow.

Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.

Last updated Thu Jun 30 2022