Managing your group chat's banned IP address using RumbleTalk API


Ban an IP address from your group chats

POST
https://api.rumbletalk.com/chats/{chatId}/banned-ips

Request format

  • Parameter
  • Type
  • Description
  • *ip
  • string
  • The IP address to ban; IP address should be IPv4 dot-decimal notation
    e.g: 1.1.1.1
  • lastIp
  • string
  • If supplied, the IP addresses from the ip parameter to this IP address will be banned; IP address should be IPv4 dot-decimal notation.
    e.g: 1.1.1.1

Response format

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

cURL example

curl \ -X POST \ "https://api.rumbletalk.com/chats/123/banned-ips" \ -H "Authorization: Bearer <token>" \ -d "{\"ip\":\"1.1.1.1\"}"

Response example

{ "status": true }

Looking up banned IP addresses of your group chats

GET
https://api.rumbletalk.com/chats/{chatId}/banned-ips

Response format

  • Parameter
  • Type
  • Description
  • status
  • boolean
  • true on success, false otherwise
  • count
  • integer
  • Total number of chats in the query
  • data
  • array
  • An array of objects, each representing a chat

Format of the data parameter

  • Parameter
  • Type
  • Description
  • firstIp
  • string
  • The beginning of the range of banned, IPv4 dot-decimal notation, IP address
  • lastIp
  • string
  • The end of the range of banned, IPv4 dot-decimal notation, IP address

cURL example

curl \ -X GET \ "https://api.rumbletalk.com/chats/123/banned-ips" \ -H "Authorization: Bearer <token>"

Response example

{ "status": true, "count": 2, "data": [ { "firstIp": "1.1.1.1", "lastIp": "1.1.1.1" }, ... ] }

Lifting a ban of IP addresses from your group chats

Single IP address
DELETE
https://api.rumbletalk.com/chats/{chatId}/banned-ips/{ipAddress}
Range of IP addresses
DELETE
https://api.rumbletalk.com/chats/{chatId}/banned-ips/{firstIp}:{lastIp}

Response format

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

cURL example

curl \ -X DELETE \ "https://api.rumbletalk.com/chats/123456/banned-ips/1.1.1.1" \ -H "Authorization: Bearer <token>"

Response example

{ "status": true }