Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GET /keywords.{format}

Gets all keywords on for the user. 

Code Block
languagejs
titleGET /keywords.json
{
  "keywords": [
    {
      "id": "6515641",
      "keyword": “PILEFLET”,
      "function": "http",
      "number": "1272",
      "category": "13",
      "mainkeyword": "0",
      "serviceid": "28205",
      "frameworkaccept": "1",
      "statusurl": null,
      "state": "reserved"
    },
    {
      "id": "10281329",
      "keyword": “VANDFLASKE”,
      "function": "smsinbox",
      "number": "1272",
      "category": "9",
      "mainkeyword": "0",
      "service": null,
      "serviceid": "65797",
      "frameworkaccept": "1",
      "statusurl": null,
      "state": "reserved"
    },
  ],
  "status": 200
}

...

Reserves a new keyword on a given number. 

Fields:

NameDescriptionRequired
numberWhich shortcode the keyword must be created on. The user must have access to this shortcode.Yes
keywordWhich keyword that should be reservedYes
mainkeywordIf the keyword is a subkeyword of another keyword, this should contain the id of the main keyword.No


Code Block
languagejs
titlePOST /keywords
{
	"number":"1272",
	"keyword":"papirhat"
}

...

If the keyword is deleted successfully, then a 200 OK will be returned along with the deleted keyword. The keyword will still exist, but the field "deletemark" has been set to 1remain assigned to the number/user for the remainder of the running month, but it will be internally flagged for deletion.

Code Block
languagejs
titleDelete OK
{
  "keyword": {
    "id": "10305133",
    "keyword": "PAPIRHAT",
    "function": "",
    "number": "1272",
    "category": "0",
    "mainkeyword": "0",
    "service": null,
    "serviceid": "0",
    "frameworkaccept": "0",
    "statusurl": null,
    "state": "reserved"
  },
  "status": 201
}

...