SDK オープン API
チャンネルユーザー情報インタフェースクエリ
このインタフェースは SDK channelUid を通じてチャンネルユーザー情報をクエリする
Host
- platform.hoolai.com
規約
- Http
- https
方法
- POST
パス
- /open/public/queryUser/{channel}
channel：パスのパラメータ、現在のチャンネル名、例:uc
リクエストヘッダ
- Content-Type: application/json
リクエストパラメータ
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| productId | Integer/int | ゲーム製品 ID |
| channelId | Integer/int | チャンネル ID |
| channelUid | String | チャンネルクエリ uid |
リクエストレスポンス
- 正しいレスポンス
{
"code": "SUCCESS",
"requestId": "96501_174_1688093800",
"value": {
"openId": 199347787,
"channelUid": "95715592e17eb7a21a64cc24e680b16e",
"channel": "uc"
},
"group": "SUCCESS",
"desc": "SUCCESS"
}注意
code が SUCCESS の場合はクエリ成功、他の場合は失敗
- 間違ったレスポンス
{
"code": "QUERY_INFO_NOT_EXIST",
"requestId": "3_1010167180_1697598882304",
"desc": "クエリ情報が存在しない",
"group": "open"
}注意：
上記はクエリ情報が存在しない例であり、間違ったレスポンスはそのうちの一つである
公式アカウントは携帯電話番号でユーザー情報インタフェースをクエリする
Host
- platform.hoolai.com
規約
- Http
- https
方法
- POST
パス
- /open/public/queryUser/officialAccount
リクエストヘッダ
- Content-Type: application/json
署名キー
- SDK に連絡して取得する
リクエストパラメータ
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| phone | String | 携帯電話番号 |
| timestamp | Long/long | タイムスタンプ ミリ秒 |
| sign | String | 署名 MD5(phone+productId+timestamp+キー)の32桁英字小文字 |
| productId | Int | 製品Id |
リクエストレスポンス
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| code | String | SUCCESS 为成功 |
| value | JSON |
- value プロパティ
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| realNameStatus | Boolean | true:実名 false:未実名 |
| userInfo | JSONArray |
- userInfo プロパティ
| パラメータ名 | タイプ | 備考 |
|---|---|---|
| productId | Integer | |
| openId | Long |
- 正しいレスポンス
{
"code": "SUCCESS",
"group": "SUCCESS",
"value": {
"realNameStatus": true,
"userInfo": [
{
"openId": 201000641,
"productId": 1
},
{
"openId": 199347706,
"productId": 73
}
]
},
"desc": "SUCCESS",
"requestId": "3_1010167180_1697598882304"
}注意
code が SUCCESS の場合はクエリ成功、他の場合は失敗
- 間違ったレスポンス
{
"code": "SIGN_NOT_MATCH",
"group": "open-api",
"desc": "署名が一致しない",
"requestId": ""
}注意
上記は間違った例の一つにすぎない
認証コードを送信する
Host
- platform.hoolai.com
規約
- Http
- https
方法
- POST
パス
- /open/public/sms/sendSms
リクエストヘッダ
- Content-Type: application/json
署名キー
- SDK に連絡して取得する
リクエストパラメータ
| パラメータ名 | タイプ | 説明 | | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- | | productId | Integer | 製品 Id | | mobile | String | 携帯電話番号,複数の番号は英語のコンマ(,)で隔てる | | templateId | Integer | テンプレートSMS ID、必要なSMSテンプレートの指定に使用する。 | | params | String | SMSパラメータ、テンプレートSMSの変数の充填に使用する。複数のパラメータは英語のコンマ(,)で隔てる。パーソナライズされたグループメッセージの場合、各番号に対応するパラメータは英語のコンマ(;)で隔てる。 | | accessToken | String | MD5 暗号化を使用し、productId+"."+requestTime+"."+productKey の16進数32桁の英字小文字の文字列を戻す | | requestTime | Long | リクエストを送った時の現在時間、単位はミリ秒。 | | separator(オプション) | String | カスタムセパレータ。このパラメータを入れないと、英語のコンマでパラメータ params を分割するようになる。これを入れると、これで分割する。現在許可されるカスタムセパレータは" |
リクエストレスポンス
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| code | String | SUCCESS は成功 |
| value | String | 値 |
| desc | String | 説明 |
| requestId | String | リクエスト ID |
| group | String | グループ |
- 正しいレスポンス
{
"code": "SUCCESS",
"requestId": "92982_124_1698634202",
"value": "SUCCESS",
"desc": "SUCCESS",
"group": "SUCCESS"
}注意
code が SUCCESS の場合はクエリ成功、他の場合は失敗
- 間違ったレスポンス
{
"code": "SIGN_NOT_MATCH",
"group": "open-api",
"desc": "署名が一致しない"
}注意
上記は間違った例の一つにすぎない
ブロック文字ライブラリ/画像
このインタフェースは SDK API サービスで敏感情報/画像を検出できる
Host
- platform.hoolai.com
規約
- Http
- https
方法
- POST
パス
- /open/public/sensitive/moderation
リクエストヘッダ
- Content-Type: application/json
リクエストパラメータ
| パラメータ名 | タイプ | 説明 | 選択必須 | オプションの値 |
|---|---|---|---|---|
| productId | Integer | 製品ID | はい | |
| type | String | データタイプ（画像/テキスト） | はい | image/text |
| scene | String | 使用シーン(チャット、名前入力など) | いいえ | シーンの名称とルールをカスタマイズできる Tencent Cloudのバックグラウンド設定を有効にした後に使用すべき |
| uid | Long | SDKユーザーID | はい | 30000xxxxx |
| roleId | String | キャラID | はい | ゲームキャラId |
| content | String | 内容 | はい | チャットテキスト/base64(画像)、10MBより小さいimageしかサポートしない |
| sign | String | 署名 | はい | md5(productId+type+uid+roleId+content+timestamp+key).timestamp |
- 注意：keyはSDKが提供する署名key、timestampはuninxのタイムスタンプ、有効時間は5分間
リクエストレスポンス
- レスポンス
{
"code": "SUCCESS",
"group": "open-api",
"requestId": "12244_323523_4322452",
"value": {
"suggestions": "pass",
"showLabel": "この****、逃げたな",
"reason": "具体的な原因、オプション"
}
}INFO
code が SUCCESS の場合はクエリ成功、他の場合は失敗 -suggestions:オプションの値pass/block（値がblockの場合、ゲーム内でユーザーに「敏感な文字がある」を直接通知することがおすすめ）
- showLabel: テキストの場合のみ、フィルタテキストの候補が表示される
- reason: 具体的な原因、オプション(存在しない可能性があり、このテキストをゲーム内で表示しない方がいい)