tencent cloud

Risk Control Engine

DocumentaçãoRisk Control EngineAPI DocumentationTencentCloud APIsReportEvent

ReportEvent

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-11 11:52:04

1. API Description

Domain name for API request: rce.intl.tencentcloudapi.com.

Used to report events that do not require real-time decision-making in your business. Our engine will perform computations and apply machine learning to mine risk features from these events, which are then used to support real-time event risk assessment.

A maximum of 1000 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ReportEvent.
Version Yes String Common Params. The value used for this API: 2026-01-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
EventCode Yes String

Event code. Used to specify the scenario node for business access.

Standard events under the account protection product include:

  • login: Log in

  • register: Register
  • sms: SMS
  • logout: Log out
  • modify_account: Modify account
  • modify_password: Modify password
  • security_verification: Security verification

Standard events under the payment protection product include:

  • create_order: Create an order
  • transaction: Transaction
  • charge_back: Chargeback

Standard events under the promotion protection product include:

  • add_promotion: Participate in promotions
  • redeem: Redeem a prize
  • withdraw: Withdraw
  • cust_event: Custom event, cust_xxx
  • scan_code: Scan a code
  • lucky_draw: Lucky draw
  • task: Complete a task
  • invitation: Invitation
  • claim_red_packet: Receive a red packet
  • browse: Browse

Custom events can be evaluated for risk based on an agreement with RCE
EventTime Yes String

The time when the event occurred

Parameter format: Millisecond-level time with UTC time zone compliant with the ISO 8601 standard
SessionId Yes String

The user's current session ID used to associate with the actions before and after logging in. If UserId is not passed, SessionId is required. If missing, an empty string can be filled.
DeviceToken Yes String

The token provided by the SDK integrated in your web site or application
UserIp Yes String

User client IP address (IPv4 or IPv6)
EventDetail Yes EventDetail

Event details, import corresponding event information based on the event code you input
UserId No String

The user's account ID in your system
UserEmail No String

Email of the user
UserPhone No String

Phone number of the user

Parameter format: Complies with the E.164 standard format, which includes "+", region code, and number
Browser No Browser

The details of the browser. If you've already integrated our device SDK, this field is not required
App No App

The details of the app, os and device.If you've already integrated our device SDK, this field is not required

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example of Login event information reporting

Input Example

POST / HTTP/1.1
Host: rce.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReportEvent
<Common request parameters>

{
    "EventCode": "login",
    "EventTime": "2026-07-07T15:16:31.000+08:00",
    "SessionId": "se****************56",
    "DeviceToken": "v3:**********************************************************************************************bzxeC9FTtHon0Vq+zEB0iKhM5OGvG",
    "UserIp": "192.***.*.100",
    "EventDetail": {
        "Login": {
            "UserInfo": {
                "UserLevel": "golden",
                "UserPoint": {
                    "Point": 10,
                    "PointType": "credit_point"
                },
                "UserType": "person"
            },
            "UserLoginName": "u_cuidq",
            "LoginResult": {
                "Status": "success"
            }
        }
    },
    "UserId": "u*******56",
    "UserEmail": "u***********.com",
    "UserPhone": "+86138********",
    "Browser": {
        "UserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
        "AcceptLanguage": "zh-CN,zh;q=0.9,en;q=0.8",
        "ContentLanguage": "zh-CN"
    },
    "App": {
        "OS": "iOS",
        "OSVersion": "16.0",
        "DeviceManufacturer": "Apple",
        "DeviceModel": "iPhone 14 Pro",
        "DeviceId": "de*************23",
        "AppName": "MyShoppingApp",
        "AppVersion": "3.2.1",
        "ClientLanguage": "zh-CN"
    }
}

Output Example

{
    "Response": {
        "RequestId": "374aefc2-99e7-40a1-b92c-9e08a3f3b742"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.SystemException System exception.
InvalidParameter Invalid parameter.
InvalidParameter.FieldMissed Field missed.
InvalidParameter.InvalidFormat Invalid field format.
InvalidParameter.InvalidValue Invalid field value.
InvalidParameter.LengthExceed Field length exceeds the maximum limit.
InvalidParameterValue.DataUnauthorized Data is unauthorized. Check the data authorization letter.
InvalidParameterValue.DuplicatedKey Custom parameter keys cannot be duplicated.
InvalidParameterValue.EventNotExist Event not exist.
InvalidParameterValue.InvalidEventTime EventTime differs too much from the current system time
InvalidParameterValue.TenantNotExist Tenant not exist.
MissingParameter Missing parameter.
MissingParameter.FieldMissed Missing required field.
UnauthorizedOperation Unauthorized operation.
Anterior: AssessDeviceRiskPremiumProPróximo: Data Types

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation