- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
- News and Announcements
- Product Introduction
- Purchase Guide
- Free Demos
- Download
- Get Started
- Integration Solution (UI Included) (Recommended)
- Integration Solution (No UI)
- SDK Integration
- Initialization
- Login and Logout
- Message
- Message Overview
- Sending Message
- Receiving Message
- Historical Message
- Forwarding Message
- Modifying Message
- Message Inserting
- Deleting Message
- Clearing Messages
- Recalling Message
- Online Message
- Read Receipt
- Querying Message
- Group @ Message
- Targeted Group Message
- Notification Muting
- Message Extension
- Message Translation
- Conversation
- Group
- User Profile and Relationship Chain
- Offline Push
- Local Search
- Signaling
- Client APIs
- SDK APIs (New)
- SDK APIs (Legacy)
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- User Management
- Global Mute Management
- Operations Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- Before a Group Is Created
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- Before Group Message Is Sent
- After a Group Message Is Sent
- After a Group Is Full
- After a Group Is Disbanded
- After Group Profile Is Modified
- Callback After Recalling Group Messages
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Webhook Mutual Authentication Configuration Guide
- Use Cases
- AI Chatbot
- End-to-end encrypted chat with Virgil
- Super Large Entertainment and Collaboration Community
- Live Room Setup Guide
- Web-Based Interactive Live Streaming
- Muting/Unmuting Group Members
- How to integrate Tencent IM with Salesforce
- How to integrate Tencent IM with Zendesk
- How to integrate chat widget to your Shopify online store
- Discord Implementation Guide
- How to Integrate Chat into Games
- Flutter Avchatroom
- Console Guide
- FAQs
- Security Compliance Certification
- IM Policy
- Smooth Migration Solutions
- Error Codes
- Contact Us
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.
Note：This API only supports obtaining the IP addresses or IP ranges of all Chat service integration methods in the Chinese mainland. (To obtain the IP addresses or IP ranges of specific integration methods outside the Chinese mainland, contact us to enable this feature. We will assess your needs based on your application and enable this feature for you if appropriate.)
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.console.tim.qq.comadminapisgp.im.qcloud.comadminapikr.im.qcloud.comadminapiger.im.qcloud.comadminapiind.im.qcloud.comadminapiusa.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: |
Note：For the webhook business, the business server needs to add the Chat service egress addresses to the allowlist. You can set
nettypeto 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.
Yes
No
Was this page helpful?