Keywords

Add Keyword

Add New Keyword

post/add-keyword.json

Request

Base URL
https://api.transmitsms.com
Auth
HTTP basic

Request body application/x-www-form-urlencoded

keywordstring required

The first word of a text message

numberinteger required

The dedicated virtual number that the keyword belongs to

referencestring

Your own reference (up to 100 characters)

list_idinteger

ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL

welcome_messagestring

SMS message to send to new members

members_messagestring

SMS message to existing members

activateboolean

Whether to make the keyword active immediately.

forward_urlstring url

Forward messages to a URL

forward_emailstring email

Forward messages to a set of email addresses

forward_smsinteger

Forward messages to a set of MSISDNs

Example request

{
  "keyword": "example",
  "number": 1234567890,
  "reference": "reference123",
  "list_id": 987654321,
  "welcome_message": "Welcome to our service!",
  "members_message": "Welcome back!"
}

Response

Successful response

keywordstring

referencestring

numberinteger

list_idinteger

welcome_messagestring

member_messagestring

forward_urlstring

forward_smsstring

forward_emailstring

statusstring

billing_datestring date

Example response

{
  "keyword": "NEWS",
  "reference": "Gym news",
  "number": 61418279031,
  "list_id": 4214634,
  "welcome_message": "Welcome to Mike's gym news",
  "member_message": "Thanks for your continued support",
  "forward_url": "http://example.com/gym-promo",
  "forward_sms": "61491570157,61491570158",
  "forward_email": "news@example.com,mike@example.com",
  "status": "open",
  "billing_date": "2020-07-24",
  "error": {
    "code": "SUCCESS",
    "description": "OK"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.