Creating Official Accounts
Feature Overview
This API is used by the app administrator to create an official account.
API Calling Description
Sample Request URL
https://xxxxxx/v4/official_account_open_http_svc/create_official_account?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The table below only lists the parameters modified when this API is called and their descriptions. For details on the parameters, refer to RESTful API Overview.
Parameter | Description |
xxxxxx | The dedicated domain name corresponding to the country/region of the SDKAppID: China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/official_account_open_http_svc/create_official_account | Request API. |
sdkappid | The SDKAppID assigned by the Chat console when an application is created. |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | The value is always json . |
Maximum Call Frequency
200 times/second
Sample Request Packets
{"OfficialAccountUserID": "@TOA#_test_id", // The prefix of the custom official account ID must be @TOA#_."Owner_Account": "107867","CustomString": "test_custom_string","FaceUrl": "http://this.is.face.url","Introduction": "This is test Introduction","MaxSubscriberNum": 1000,"Name": "test_official_account","Organization": "test_organization"}
Request Fields
Field | Type | Required | Description |
Owner_Account | String | Yes | The account ID that owns the official account (must be an imported account), representing the owner of the official account. |
OfficialAccountUserID | String | No | ID of the official account. In order to make the official account ID simpler and easier to remember and spread, Tencent Cloud supports customizing the official account ID when the app creates an official account through the RESTful API. If not specified, the system will generate an official account ID by default and return it. |
Name | String | Yes | Name of the official account, up to 150 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes. |
Introduction | String | No | Introduction to the official account, up to 400 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes. |
FaceUrl | String | No | Avatar of the official account, up to 500 bytes in length. |
MaxSubscriberNum | Integer | No | The maximum number of subscribers to an official account, with a default value of 100,000 when not specified. |
Organization | String | No | Group organization the official account belongs to, up to 500 bytes in length, using UTF-8 encoding, with 1 Chinese character occupying 3 bytes. |
CustomString | String | No | The custom field of the official account, up to 3,000 bytes. It can be used by the business layer to meet the requirements of special scenarios. |
Sample Response Packets
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"OfficialAccountUserID": "@TOA#_test_id"}
Response Fields
Field | Type | Description |
ActionStatus | String | Processing result: OK: succeeded. FAIL: failed. |
ErrorCode | Integer | Error code: 0: succeeded. Other values: failed. |
ErrorInfo | String | Error information. |
OfficialAccountUserID | String | The official account ID after successful creation. The ID defined by the user or assigned by the Chat backend is returned. |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packets represent the actual error code and error information.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:
Error Code | Description |
6017 | Invalid request parameter. Please modify and retry. |
10004 | Internal server error. Please try again. |
20001 | Invalid request packet. Please modify and retry. |
20005 | Internal server error. Please try again. |
130007 | Incorrect official account user ID. Please modify and retry. |
130008 | The official account user ID is already in use. Please modify and retry. |
131000 | This AppId has not been enabled with official account service. Please enable it and retry. |
130010 | The number of created official accounts exceeds the limit. Please dissolve some official accounts or upgrade the service. |
References
Possibly Triggered Callbacks