Help Center/ OneAccess/ API Reference/ OneAccess APIs/ User APIs/ Social Media Accounts/ Obtaining the List of Social Accounts Bound to a User

Updated on 2024-12-30 GMT+08:00

View PDF

Obtaining the List of Social Accounts Bound to a User

Function

This API is used to obtain the list of social accounts bound to a user.

URI

GET /api/v2/sdk/social

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-operating-sys-version	Yes	String	Caller OS version, for example, Android 10.
X-device-fingerprint	Yes	String	Caller device fingerprint, for example, 156aysdna213sc50.
X-device-ip	No	String	Caller IP address, for example, 10.10.10.1
X-agent	Yes	String	User agent information, for example, Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L	No	String	Language type, for example, en.
X-client-id	Yes	String	Application ID, which is a ClientId allocated to an application after registration.
X-signature	Yes	String	In the encrypted data session_token=xxx&timestamp=xxx&nonce=xxx, session_token indicates the session token, timestamp indicates the current timestamp, nonce indicates the timestamp's hexadecimal value, and the encryption mode is RSA. The current timestamp can be obtained by calling the API for obtaining the server time, and the public key for encryption can be obtained by calling the API for obtaining the public key.
X-tenant-id	No	String	Tenant ID. This parameter is mandatory when calling an ISV application. Replace "{domain_name}" with the ISV common domain name "{common_domain}". In the request header, specify tenant_id of the corresponding tenant and replace X-client-id with client_id of the ISV application template.

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
social	Array of SocialResult objects	Social account information set.

**Table 3** SocialResult
Parameter	Type	Description
id	String	ID automatically generated by the system.
userId	String	User ID.
socialType	String	Social type.
social_uid	String	Social account ID.
socialNickname	String	Alias.
socialHeadImage	String	Avatar.
socialAccountDetails	String	Description.
createdAt	String	Creation time.
updatedAt	String	Modification time.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Obtain the list of social accounts bound to a user.

GET https://{domain_name}/api/v2/sdk/social

X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-signature:D0JeOUuVqU8Ixvl0xrmewQRk4AuGZrtk1RfBxueNKUrNPpgSbXrYnzw...
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

Example Responses

Status code: 200

Request successful.

{
  "social" : [ {
    "id" : "20210516130247432-C84E-E5EA8CFE7",
    "userId" : "20210515202200788-094F-074FB1341",
    "socialType" : "weixin",
    "social_uid" : "001GKgGa15HGZA0aOxIa1bFktp1GKgG4_social_uid",
    "socialNickname" : "zhangsan",
    "socialHeadImage" : "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIQ8QOTSn3y4cYHLlMC3sv6RCBmeMkxtOog47Zr3v2Afbqc2bmP0WibUIUskX39eJlJAEbAibXs",
    "socialAccountDetails" : "zhangsan",
    "createdAt" : "2021-05-16 13:02:48.513",
    "updatedAt" : "2021-05-16 13:02:48.513"
  } ]
}