Release Notes
Announcements
https://www.example.com:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json
Field | Description |
https | The request protocol is HTTPS, and the request method is POST. |
www.example.com | Webhook URL. |
SdkAppid | SDKAppID assigned in the Chat console when creating the application. |
CallbackCommand | Fixed value: ContentCallback.ResultNotify. |
contenttype | Request body type is always json. |
{"Scene":"C2C","SdkAppId":1400187352,"From_Account":"jared","ContactItem":{"ContactType":1,"To_Account":"Jonh"},"ContentType":"Text","TextContent":["aaabbbccc","1234567"],"MsgID":"1434460578_4137340972_1661154487","CtxcbResult":1,"CtxcbRequestId":"241ed925-4c56-4357-95dd-1e6e7798f214","CtxcbKeywords":["aaabbbccc","1234567"],"CtxcbSuggestion":"Review","CtxcbLabel":"Sexy","CtxcbSubLabel":"InsinuationPorn","CtxcbSubLabelDesc":"XXXX","CtxcbLibName":"test","CloudCustomData":"aaabbbccc"}
Field | Type | Description |
Scene | String | Moderation scenario: C2C Chat = C2CC2C Custom Message = C2CCustomGroup Chat = GroupGroup Custom Message = GroupCustomGroup Profile = GroupInfoGroup Member Profile = GroupMemberInfoRelationship Chain = RelationChainUser Profile = UserInfo |
From_Account | String | UserID of the sender of the content submitted for moderation. |
ContactItem | Object | Indicates the recipient of the message during moderation. |
ContactType | Integer | Distinguishes whether the recipient is a group or C2C Chat: ContactType = 1 indicates C2C Chat. ContactType = 2 indicates Group Chat. |
To_Account | String | When ContactType = 1, recipient UserID. |
ToGroupId | String | When ContactType = 2, recipient GroupID. |
ContentType | String | Type of content submitted for moderation: Text = Text Image = Image Audio = Audio Video = Video |
TextContent | Array | When ContentType is Text, contains the text content submitted for moderation. Custom text messages may return multiple array elements; other message types return only one array element. |
FileURL | String | When ContentType is Image/Audio/Video, the file URL submitted for moderation. |
MsgID | String | For C2C moderation, MsgID is the C2C message MsgKey. For Group moderation, MsgID is the group message MsgSeq. If a group message has no MsgID, it indicates the message was blocked due to violation or not delivered for other reasons. |
CtxcbResult | Integer | Chat handling strategy: 1: Blocked. 0: Allowed. |
CtxcbRequestId | String | Identifier for third-party content moderation service. |
CtxcbKeywords | Array | Sensitive keywords detected in the text. |
CtxcbSuggestion | String | Moderation suggestion from third-party content moderation service: Block/Review/Normal. |
CtxcbLabel | String | Primary violation category detected during moderation: Normal/Illegal/Abuse/Polity/Ad/Porn/Sexy/Terror/Composite. |
CtxcbSubLabel | String | Secondary violation category detected during moderation. This field is present only when triggered by the model. |
CtxcbSubLabelDesc | String | Chinese description corresponding to the secondary violation category detected during moderation. |
CtxcbLibName | String | Name of the custom keyword library triggered by keyword detection. This field is present only when keywords are matched. |
CloudCustomData | String | For C2C or group message moderation, the CloudCustomData custom field in the message body is returned as-is. For other moderation scenarios, this field is empty. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
Field | Type | Description |
ActionStatus | String | Processing result: OK indicates success. FAIL indicates failure. |
ErrorCode | Integer | Error code: 0: App backend processed successfully. 1: App backend processing failed. |
ErrorInfo | String | Error message. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback