Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Operations Management/
Getting Server IP Addresses/

Getting Server IP Addresses

Feature Overview

Sometimes, you may need to obtain the list of server IP addresses for security purposes. The app admin can use this API to obtain the list of server IP addresses or IP ranges used by the SDK and webhook.

API Calling Description

Sample request URL

https://xxxxxx/v4/ConfigSvc/GetIPList?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json&nettype=0

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/ConfigSvc/GetIPList
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format. The value is fixed to json.
nettype
Request a list of server IP addresses of a specified type:
nettype=0: List of all server IP addresses
nettype=1: List of the server IP addresses accessed by the native SDK inside China (including Hongkong, China)
nettype=2: List of the server IP addresses accessed by the native SDK outside China
nettype=3: List of the server IP addresses accessed by the web SDK inside China (including Hongkong, China)
nettype=4: List of the server IP addresses accessed by the web SDK outside China
nettype=5: List of egress addresses used by Chat for webhooks inside China (including Hongkong, China)
nettype=6: List of egress addresses used by Chat for webhooks outside China
Note
For the webhook business, the business server needs to add the Chat service egress addresses to the allowlist. You can set nettype to 5 (or 6) according to the business server address region to get the list of Chat service egress addresses.

Maximum call frequency

200 calls per second

Sample request

{}

Sample response

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "IPList": [ "127.0.0.2",   "183.192.202.0/25" ]
}

Response fields

Field
Type
Description
IPList
Array
List of server IP addresses
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.