Compliance Keywords Messages

SMS Compliance keywords messages endpoints allow you to manage answers that are sent to compliance keywords (as STOP for unsubscription )

Compliance Keyword messages are only available for SMS

Types of KeyWords (KW field)

In order to set customized compliance keyword messages you will need to associate them with a type of keyword ( kw ) . Several types exist

type: string
enum:
  - "optin"
  - "optout"
  - "help"

OPT IN

Categories all keywords that indicate a subscriber's intention to subscribe or resubscribe to a service (ex START)

OPT-OUT

Categories all keywords that indicate a subscriber's intention to unsubscribe from a service (ex STOP)

HELP

Categories all keywords intended to provide simplified instructions to subscribers (ex HELP) .

Good practices require structuring HELP messages as follows

brand_name , support_contact (both URL or TFN or email ) followed by common_keywords . For example:

Bird CRM: you can contact us at [e-mail], send START to subscribe, STOP to unsbscribe. Msg & data charges may applies

Languages

Compliance Keywords Messages are always associated with the language; so for example. optin:en Identify all keywords in English ( en ) that are used to identify a contact opting in to receive communications from a brand

When the filed lang Is required, please specify a language using ISO639-1 language codes

Default Keywords

Bird CRM system always listens for predetermined keywords categorized by type and language as below. Via the Compliance Keywords Messages endpoint you can customize the acknowledgment message each category will trigger.

English

HELP

• help

• info

OPT OUT

• stop

• stopall

• end

• quit

• cancel

• unsubscribe

OPT IN

• start

• begin

• resume

• revert

• unstop

Other languages

HELP

• aide (french)

• hulp (dutch)

• hilfe (german)

• ayuda (spanish)

• ajuda (portuguese)

• Aiuto (italian)

• ПОМОЩЬ (russian)

• POMOCY (polish)

OPT OUT

• arret (french)

• halt (german)

• detener (spanish)

• parar (pourtugese)

• ferma (italian)

• ОСТАНОВИТЬ (russian)

• ZATRZYMAJ (polish)

OPT IN

• nonarret (french)

Endpoints

List all messages

List all keyword messages

List all keyword messages for this workspace

GET/workspaces/{workspaceId}/keyword-messages

Authorization

useraccessKey

Response

200404

OK

Body

application/json

resultsarray of KeywordMessage

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/keyword-messages', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "results": [
    {
      "Key": "text",
      "KW": "optin",
      "Lang": "text",
      "Value": "text"
    }
  ]
}

This endpoint will return all the costume messages you have set in the target workspace

{
	"results": [
		{
			"key": "optout:en",
			"kw": "optout",
			"lang": "en",
			"value": "We are sorry to see you go, please send OOPS if that was a mistake"
		}
}

Define a message for a given keyword

Set keyword message

Set a keyword message

POST/workspaces/{workspaceId}/keyword-messages

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Body

application/json

kw*KW (enum)

optinoptouthelpsubscriptionRequest

lang*string

value*string

Response

200400422

Keyword message was created

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/keyword-messages', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "kw": "optin",
      "lang": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

400422

{
  "code": "text",
  "message": "text"
}

{
    "kw":    "optout",
    "lang":  "en",
    "value": "We are sorry to see you go, please send OOPS if that was a mistake",
}

You can only define a message for a type of keyword and language (keywordMessageKey ). You cannot have multiple messages for the same combination of type and language

If you want to revert to the default message, use the below methods with an empty value "value": ""

Check a Singel Compliance Keyword Message

Get keyword message

Get keyword messages for this workspace and key (keyword:lang)

GET/workspaces/{workspaceId}/keyword-messages/{keywordMessageKey}

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

keywordMessageKey*string

Response

200404

OK

Body

application/json

Keystring

KWKW (enum)

optinoptouthelpsubscriptionRequest

Langstring

Valuestring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/keyword-messages/{keywordMessageKey}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "Key": "text",
  "KW": "optin",
  "Lang": "text",
  "Value": "text"
}

keywordMessageKey indicates the keyword type and languages, for example for the example above it would be optout:en