- 製品の説明
- 購入ガイド
- ダウンロードセンター
- シナリオプラン
- クライアントAPIs
- サービス側 APIs
- UserSigの生成
- RESTful APIs
- RESTful API Overview
- REST APIAPIインターフェースリスト
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- グループ作成前のコールバック
- グループ作成後のコールバック
- グループへの参加の申請前のコールバック
- グループへのメンバー招待前のコールバック
- 新しいメンバーによるグループ参加後のコールバック
- グループメンバーが離れた後にコールバックする
- グループ内発言前のコールバック
- グループ内発言後のコールバック
- グループ満員後のコールバック
- グループ解散後のコールバック
- グループ情報変更後のコールバック
- グループメッセージ撤回後のコールバック
- Webhook for Online and Offline Status of Audio-Video Group Members
- グループメッセージを送信した場合の異常系コールバック
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- コンソールガイド
- よくあるご質問
- 一般的なリファレンス
- IM ポリシー
- エラーコード
- お問い合わせ
- 製品の説明
- 購入ガイド
- ダウンロードセンター
- シナリオプラン
- クライアントAPIs
- サービス側 APIs
- UserSigの生成
- RESTful APIs
- RESTful API Overview
- REST APIAPIインターフェースリスト
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- グループ作成前のコールバック
- グループ作成後のコールバック
- グループへの参加の申請前のコールバック
- グループへのメンバー招待前のコールバック
- 新しいメンバーによるグループ参加後のコールバック
- グループメンバーが離れた後にコールバックする
- グループ内発言前のコールバック
- グループ内発言後のコールバック
- グループ満員後のコールバック
- グループ解散後のコールバック
- グループ情報変更後のコールバック
- グループメッセージ撤回後のコールバック
- Webhook for Online and Offline Status of Audio-Video Group Members
- グループメッセージを送信した場合の異常系コールバック
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- コンソールガイド
- よくあるご質問
- 一般的なリファレンス
- IM ポリシー
- エラーコード
- お問い合わせ
Feature Overview
API Calling Description
Sample request URL
https://xxxxxx/v4/profile/portrait_set?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/profile/portrait_set | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json. |
Maximum call frequency
200 calls per second
Sample request
{"From_Account":"id","ProfileItem":[{"Tag":"Tag_Profile_IM_Nick","Value":"MyNickName"}]}
Request fields
Field | Type | Required | Description |
From_Account | String | Yes | UserID of the user whose profile needs to be set |
ProfileItem | Array | Yes | Profile object array of the target user. Each object in the array contains a tag and a value. |
Tag | String | Yes | Profile field to be set. Profile fields that can be set include:<br>1. Standard Profile Fields<br>2. Custom Profile Fields |
Value | uint64_t/string/bytes | Yes |
Sample response
{"ActionStatus":"FAIL","ErrorCode":40001,"ErrorInfo":"Err_Profile_Comm_Decode_Fail","ErrorDisplay":""}
Response fields
Field | Type | Description |
ActionStatus | String | The result of the request. OK means the request was successful. FAIL means the request failed. |
ErrorCode | Integer | Error code. 0: Successful; other values: Failed |
ErrorInfo | String | Detailed error information. |
ErrorDisplay | String | Detailed information displayed on the client. |
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.
The following table describes the error codes specific to this API:Error Code | Description |
40001 | Incorrect request parameter. Check your request according to the error description. |
40003 | The requested account does not exist. |
40004 | The request requires app admin permission. |
40006 | Internal server error. Try again later. |
40008 | No permission to write profile fields. |
40009 | The tag of a profile field does not exist. |
40601 | The value of the profile field exceeds the length limit of 500 bytes. |
40605 | |
40610 | Incorrect value type of the standard profile field. For more information, see Standard Profile Fields. |
はい
いいえ
この記事はお役に立ちましたか？