Skip to content

PutKeyword

Source: src/AWS/PinpointSMSVoiceV2/PutKeyword.ts

Runtime binding for sms-voice:PutKeyword.

Creates or updates a keyword on the bound origination phone number — when an end user texts the keyword to the number, End User Messaging SMS automatically replies with KeywordMessage (or opts them out / back in when KeywordAction is set). The deploy-time half grants sms-voice:PutKeyword on the number. Provide the implementation with Effect.provide(AWS.PinpointSMSVoiceV2.PutKeywordHttp).

// init
const putKeyword = yield* AWS.PinpointSMSVoiceV2.PutKeyword(number);
// runtime
yield* putKeyword({
Keyword: "INFO",
KeywordMessage: "Visit https://example.com for details.",
});