RumbleTalk

Managing your account information using RumbleTalk API

Reading your account information

GET
https://api.rumbletalk.com/account

Response format

  • Parameter
  • Type
  • Description
  • status
  • boolean
  • true on success, false otherwise
  • data
  • object
  • the account information

Format of the data parameter

  • Parameter
  • Type
  • Description
  • id
  • integer
  • Your account ID
  • email
  • string
  • The email address associated with your account
    Used to access your RumbleTalk administration panel
  • name
  • string
  • Your full name
  • testLevel
  • integer
  • The test level of the account (internal use)
  • type
  • integer
  • The account type (internal use)
  • tokenKey
  • string
  • The account's token key
  • passwordSet
  • boolean
  • Whether or not the account has a password set
  • company
  • string
  • Your company's name
  • paypalEmail
  • string
  • The PayPal email associated with the account for receiving payments
  • currency
  • string
  • The currency [code] the account is set to work with in payment features.
    This value is immutable once set
  • countryId
  • integer
  • Your [or your business'] country's id
    For country options,
  • address
  • string
  • The account's street address
  • city
  • string
  • The account's city name
  • state
  • string
  • The account's state address
  • unit
  • string
  • The account's building unit or floor
  • zipCode
  • string
  • The account's address zip/postal code
  • reservedName
  • string
  • Unique string used as your special URL
    to easily access your chat room pages
  • plan
  • object
  • the plan information

Format of the plan parameter

  • Parameter
  • Type
  • Description
  • admins
  • integer
  • Maximum number of admins that can be managed
  • rooms
  • integer
  • Maximum number of chat rooms that can be managed
  • users
  • integer
  • Maximum number of concurrent users
    Shared among all of your chat rooms
  • keywords
  • integer
  • Maximum number of keywords you can link in your chats
    The keywords are displayed in all of the chat rooms
  • usedAdmins
  • integer
  • Count of used admins
  • usedKeywords
  • integer
  • Count of used keywords
  • usedRooms
  • integer
  • Count of used rooms
  • exceed
  • boolean
  • true means that the plan exceeded it’s settings

cURL example

curl \ -X GET \ "https://api.rumbletalk.com/account" \ -H "Authorization: Bearer <token>"

Response example

{ "status": true, "data": { "id": 123, "type": 3, "tokenKey": "FA36BC...", "passwordSet": 1, "email": "user@example.com", "name": "John Smith", "testLevel": 0, "company": "Fictional Company", "countryId": 227, "address": "100 MAIN ST", "city": "Seattle", "state": "Washington", "unit": "100", "zipCode": "98104", "paypalEmail": "", "currency": "", "reservedName": "rumbletalk", "plan": { "admins": 5, "rooms": 3, "users": 150, "keywords": 10, "usedAdmins": 3, "usedKeywords": 5, "usedRooms": 2, "exceed": false } } }

Updating your account information

PUT
https://api.rumbletalk.com/account

Request format

  • Parameter
  • Type
  • Description
  • name
  • string
  • The account holder name
  • email
  • string
  • The account holder email
  • company
  • string
  • The account holder company
  • countryId
  • integer
  • Your [or your business'] country's id
    For country options,
  • address
  • string
  • The account's street address
  • city
  • string
  • The account's city name
  • state
  • string
  • The account's state address
  • unit
  • string
  • The account's building unit or floor
  • zipCode
  • string
  • The account's address zip/postal code
  • paypalEmail
  • string
  • The PayPal email associated with the account for receiving payments
  • reservedName
  • string
  • Unique string used as your special URL
    to easily access your chat room pages

Response format

  • Parameter
  • Type
  • Description
  • status
  • boolean
  • true on success, false otherwise

cURL example

curl \ -X PUT \ "https://api.rumbletalk.com/account" \ -H "Authorization: Bearer <token>" -d "{\"name\":\"Cindy White\"}"

Response example

{ "status": true }

Setting your account currency

PUT
https://api.rumbletalk.com/account/currency

It is only possible to set the currency once.
If you need to change your currency, please contact us at support@rumbletalk.com

Request format

  • Parameter
  • Type
  • Description
  • currency
  • string
  • The currency code (e.g. USD, EUR, etc.)

Response format

  • Parameter
  • Type
  • Description
  • status
  • boolean
  • true on success, false otherwise

cURL example

curl \ -X PUT \ "https://api.rumbletalk.com/account/currency" \ -H "Authorization: Bearer <token>" -d "{\"currency\":\"USD\"}"

Response example

{ "status": true }