Rhino Rewards API Documentation

2021-10-07T22:55:31.000Z

sms ( 1.0.0 )

$help

Description

Get Help URL

Request

Response

Examples

Playground

$login

Description

Get Login PassCode

Request

Response

Examples

Playground

<passcode> $account create <label>

Description

CREATE = Create New Account

Request

URI Params

label string - Alpha-Numeric Account Name

Response

Examples

Playground

<passcode> $account remove <id>

Description

REMOVE = Disable Account

Request

URI Params

id string - Alpha-Numeric Account ID

Response

Examples

Playground

<passcode> $checkin (edit|delete) <code> <program> <mobile> <date> ; <key>=<value>

Description

EDIT = Modify a patron timestamp and/or data
DELETE = Delete a patron timestamp and data

Request

URI Params

code number - Phone Number or Short Code program string - Alpha-Numeric Program / Campaign mobile number - Mobile Phone Number key string - DataKey value string|number - DataKey

Response

Examples

Playground

<passcode> $checkin add <code> <program> <mobile> ; <key>=<value>

Description

ADD = Timestamp and add notes to patron in a program

Request

URI Params

code number - Phone Number or Short Code program string - Alpha-Numeric Program / Campaign mobile number - Mobile Phone Number key string - DataKey value string|number - DataKey

Response

Examples

Playground

<passcode> $code (add|new) <account> <type> <number>

Description

ADD = Request a phone number or short code
NEW = Request a unique phone number or short code

Request

URI Params

account string - Account ID type lookup - Type of code number number - Code Number

Response

Examples

Playground

<passcode> $code (lock|unlock|delete) <account> <code>

Description

LOCK = Lock to prevent new programs from being added
UNLOCK = Unlock to add new programs
DELETE = Disable Code and release to system. Will not be able to run programs.

Request

URI Params

account string - Account ID code number - Short Code | Long Code

Response

Examples

Playground

<passcode> $code list <account> <page>

Description

LIST = List Codes in groups of 10

Request

URI Params

account string - Account ID page number - Page Number

Response

Examples

Playground

<passcode> $manager (add|edit) <mobile> <account> <scope>

Description

ADD = Add New Manager to Account with permissions.
EDIT = Change Manager permissions on an Account

Request

URI Params

mobile number - Mobile Phone Number account string - Account ID scope string - Select A Scope Definition

Response

Examples

Playground

<passcode> $manager (lock|unlock|delete) <mobile> <account>

Description

DELETE = Archive Manager Account
LOCK = Disable Manager Account
UNLOCK = Enable Manager Account

Request

URI Params

mobile number - Mobile Phone Number account string - Account ID

Response

Examples

Playground

<passcode> $manager view <mobile> <account>

Description

VIEW = Get Manager Account Details

Request

URI Params

mobile number - Mobile Phone Number account string - Account ID

Response

Examples

Playground

<passcode> $patron (add|remove) <mobile> <code> <program>

Description

ADD = Add Patron to Subscription List
REMOVE = Remove Patron from Subscription List

Request

URI Params

mobile number - Mobile Phone Number code number - Phone Number or Short Code program string - Alpha-Numeric Program / Campaign

Response

Examples

Playground

<passcode> $patron list <code> <program> <page>

Description

LIST = List Patrons in groups of 10

Request

URI Params

code number - Short Code | Long Code program string - Alpha-Numeric Program / Campaign page number - Page Number

Response

Examples

Playground

<passcode> $program (add|lock|unlock|delete) <program> <code>

Description

ADD = Add a new program to a short/long code.
LOCK = Lock to prevent new patrons from being added
UNLOCK = Unlock to add new patrons
DELETE = Disable Program. Will not be able to run programs.

Request

URI Params

program string - The word that people will need to text to the code code number - Short Code | Long Code

Response

Examples

Playground

<passcode> $program list <code> <page>

Description

LIST = List Programs in groups of 10

Request

URI Params

code number - Short Code | Long Code page number - Page Number

Response

Examples

Playground

<passcode> $shout <code> <program> <msg>

Description

LIST = List Patrons in groups of 10

Request

URI Params

code number - Short Code | Long Code program string - Alpha-Numeric Program / Campaign msg string - Anything to broadcast to all subscribers

Response

Examples

Playground

<passcode> $user (add|edit) <mobile> ; <key> = <value>

Description

ADD = Create New User
EDIT = Edit User Data

Request

URI Params

mobile number - Mobile Phone Number key string - DataKey value string|number - DataKey

Response

Examples

Playground

<passcode> $user view <mobile>

Description

VIEW = Get User Account Details

Request

URI Params

mobile number - Mobile Phone Number

Response

Examples

Playground